ASP.NET Web APIを使用したJSONP

ASP.MVC MVC 4でWeb APIを使用して新しいサービスのセットを作成しています。これまでのところ、素晴らしいです。サービスを作成して動作させましたが、現在はJQueryを使用してサービスを利用しようとしています。Fiddlerを使用してJSON文字列を取得できますが、問題はないようですが、サービスが別のサイトに存在するため、「許可されていません」というJQueryエラーで呼び出しを試みます。したがって、これは明らかにJSONPを使用する必要がある場合です。

私はWeb APIが新しいことを知っていますが、誰かが私を助けてくれることを願っています。

JSONPを使用してWeb APIメソッドを呼び出すにはどうすればよいですか？

この質問をした後、ようやく必要なものを見つけたので答えます。

私はこのJsonpMediaTypeFormatterに遭遇しました。次のようにして、Application_Startglobal.asaxに追加します。

var config = GlobalConfiguration.Configuration;
config.Formatters.Insert(0, new JsonpMediaTypeFormatter());

そして、次のようなJQuery AJAX呼び出しを使用することをお勧めします。

$.ajax({
    url: 'http://myurl.com',
    type: 'GET',
    dataType: 'jsonp',
    success: function (data) {
        alert(data.MyProperty);
    }
})

それは非常にうまく機能するようです。

以下は、WebAPI RCで使用するためのJsonpMediaTypeFormatterの更新バージョンです。

public class JsonpMediaTypeFormatter : JsonMediaTypeFormatter
{
    private string callbackQueryParameter;

    public JsonpMediaTypeFormatter()
    {
        SupportedMediaTypes.Add(DefaultMediaType);
        SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/javascript"));

        MediaTypeMappings.Add(new UriPathExtensionMapping("jsonp", DefaultMediaType));
    }

    public string CallbackQueryParameter
    {
        get { return callbackQueryParameter ?? "callback"; }
        set { callbackQueryParameter = value; }
    }

    public override Task WriteToStreamAsync(Type type, object value, Stream stream, HttpContent content, TransportContext transportContext)
    {
        string callback;

        if (IsJsonpRequest(out callback))
        {
            return Task.Factory.StartNew(() =>
            {
                var writer = new StreamWriter(stream);
                writer.Write(callback + "(");
                writer.Flush();

                base.WriteToStreamAsync(type, value, stream, content, transportContext).Wait();

                writer.Write(")");
                writer.Flush();
            });
        }
        else
        {
            return base.WriteToStreamAsync(type, value, stream, content, transportContext);
        }
    }


    private bool IsJsonpRequest(out string callback)
    {
        callback = null;

        if (HttpContext.Current.Request.HttpMethod != "GET")
            return false;

        callback = HttpContext.Current.Request.QueryString[CallbackQueryParameter];

        return !string.IsNullOrEmpty(callback);
    }
}

次のようにActionFilterAttributeを使用できます。

public class JsonCallbackAttribute : ActionFilterAttribute
{
    private const string CallbackQueryParameter = "callback";

    public override void OnActionExecuted(HttpActionExecutedContext context)
    {
        var callback = string.Empty;

        if (IsJsonp(out callback))
        {
            var jsonBuilder = new StringBuilder(callback);

            jsonBuilder.AppendFormat("({0})", context.Response.Content.ReadAsStringAsync().Result);

            context.Response.Content = new StringContent(jsonBuilder.ToString());
        }

        base.OnActionExecuted(context);
    }

    private bool IsJsonp(out string callback)
    {
        callback = HttpContext.Current.Request.QueryString[CallbackQueryParameter];

        return !string.IsNullOrEmpty(callback);
    }
}

次に、それをアクションに配置します。

[JsonCallback]
public IEnumerable<User> User()
{
    return _user;
}

確かにブライアンの答えは正しいものですが、すでにjson.Netフォーマッターを使用している場合は、jsonの日付がかなり速く、シリアル化が高速になるため、jsonpに2つ目のフォーマッターを追加するだけではなく、2つを組み合わせる必要があります。Scott HanselmanがASP.NET Web APIのリリースではデフォルトでJson.Netシリアライザーを使用する予定であると述べているので、とにかくそれを使用することは良い考えです。

public class JsonNetFormatter : MediaTypeFormatter
    {
        private JsonSerializerSettings _jsonSerializerSettings;
        private string callbackQueryParameter;

        public JsonNetFormatter(JsonSerializerSettings jsonSerializerSettings)
        {
            _jsonSerializerSettings = jsonSerializerSettings ?? new JsonSerializerSettings();

            // Fill out the mediatype and encoding we support
            SupportedMediaTypes.Add(new MediaTypeHeaderValue("application/json"));
            Encoding = new UTF8Encoding(false, true);

            //we also support jsonp.
            SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/javascript"));
            MediaTypeMappings.Add(new UriPathExtensionMapping("jsonp", "application/json"));
        }

        public string CallbackQueryParameter
        {
            get { return callbackQueryParameter ?? "jsoncallback"; }
            set { callbackQueryParameter = value; }
        }

        protected override bool CanReadType(Type type)
        {
            if (type == typeof(IKeyValueModel))
                return false;

            return true;
        }

        protected override bool CanWriteType(Type type)
        {
            return true;
        }

        protected override Task<object> OnReadFromStreamAsync(Type type, Stream stream, HttpContentHeaders contentHeaders,
            FormatterContext formatterContext)
        {
            // Create a serializer
            JsonSerializer serializer = JsonSerializer.Create(_jsonSerializerSettings);

            // Create task reading the content
            return Task.Factory.StartNew(() =>
            {
                using (StreamReader streamReader = new StreamReader(stream, Encoding))
                {
                    using (JsonTextReader jsonTextReader = new JsonTextReader(streamReader))
                    {
                        return serializer.Deserialize(jsonTextReader, type);
                    }
                }
            });
        }

        protected override Task OnWriteToStreamAsync(Type type, object value, Stream stream, HttpContentHeaders contentHeaders,
            FormatterContext formatterContext, TransportContext transportContext)
        {
            string callback;
            var isJsonp = IsJsonpRequest(formatterContext.Response.RequestMessage, out callback);

            // Create a serializer
            JsonSerializer serializer = JsonSerializer.Create(_jsonSerializerSettings);

            // Create task writing the serialized content
            return Task.Factory.StartNew(() =>
            {
                using (JsonTextWriter jsonTextWriter = new JsonTextWriter(new StreamWriter(stream, Encoding)) { CloseOutput = false })
                {
                    if (isJsonp)
                    {
                        jsonTextWriter.WriteRaw(callback + "(");
                        jsonTextWriter.Flush();
                    }

                    serializer.Serialize(jsonTextWriter, value);
                    jsonTextWriter.Flush();

                    if (isJsonp)
                    {
                        jsonTextWriter.WriteRaw(")");
                        jsonTextWriter.Flush();
                    }
                }
            });
        }

        private bool IsJsonpRequest(HttpRequestMessage request, out string callback)
        {
            callback = null;

            if (request.Method != HttpMethod.Get)
                return false;

            var query = HttpUtility.ParseQueryString(request.RequestUri.Query);
            callback = query[CallbackQueryParameter];

            return !string.IsNullOrEmpty(callback);
        }
    }

Rick Strahlの実装は、RCで私にとって最もうまくいきました。

JSONPはHttp GETリクエストでのみ機能します。asp.net Web APIにはCORSサポートがあり、すべてのhttp動詞で正常に機能します。

この記事はあなたに役立つかもしれません。

更新しました

public class JsonpMediaTypeFormatter : JsonMediaTypeFormatter
    {
        private string callbackQueryParameter;

        public JsonpMediaTypeFormatter()
        {
            SupportedMediaTypes.Add(DefaultMediaType);
            SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/javascript"));

            MediaTypeMappings.Add(new UriPathExtensionMapping("jsonp", DefaultMediaType));
        }

        public string CallbackQueryParameter
        {
            get { return callbackQueryParameter ?? "callback"; }
            set { callbackQueryParameter = value; }
        }

        public override Task WriteToStreamAsync(Type type, object value, Stream writeStream, HttpContent content, TransportContext transportContext)
        {
            string callback;

            if (IsJsonpRequest(out callback))
            {
                return Task.Factory.StartNew(() =>
                {
                    var writer = new StreamWriter(writeStream);
                    writer.Write(callback + "(");
                    writer.Flush();

                    base.WriteToStreamAsync(type, value, writeStream, content, transportContext).Wait();

                    writer.Write(")");
                    writer.Flush();
                });
            }
            else
            {
                return base.WriteToStreamAsync(type, value, writeStream, content, transportContext);
            }
        }

        private bool IsJsonpRequest(out string callback)
        {
            callback = null;

            if (HttpContext.Current.Request.HttpMethod != "GET")
                return false;

            callback = HttpContext.Current.Request.QueryString[CallbackQueryParameter];

            return !string.IsNullOrEmpty(callback);
        }
    }

これは、RTMバージョンのWeb APIで動作する、いくつかの改良を加えた更新バージョンです。

• リクエスト自体のAccept-Encodingヘッダーに基づいて、正しいエンコーディングを選択します。new StreamWriter()前の例では、単純にUTF-8を使用します。の呼び出しでbase.WriteToStreamAsync別のエンコーディングが使用され、出力が破損する可能性があります。
• JSONPリクエストをapplication/javascript Content-Typeヘッダーにマッピングします。前の例ではJSONPが出力されますが、application/jsonヘッダーが含まれています。この作業はネストされたMappingクラスで行われます（JSONPを提供するのに最適なコンテンツタイプを参照）。
• aの作成とフラッシュのオーバーヘッドを先取りし、StreamWriter直接バイトを取得して出力ストリームに書き込みます。
• タスクを待つ代わりに、タスクパラレルライブラリのContinueWithメカニズムを使用して、複数のタスクをチェーンします。

コード：

public class JsonpMediaTypeFormatter : JsonMediaTypeFormatter
{
  private string _callbackQueryParameter;

  public JsonpMediaTypeFormatter()
  {
    SupportedMediaTypes.Add(DefaultMediaType);
    SupportedMediaTypes.Add(new MediaTypeHeaderValue("application/javascript"));

    // need a lambda here so that it'll always get the 'live' value of CallbackQueryParameter.
    MediaTypeMappings.Add(new Mapping(() => CallbackQueryParameter, "application/javascript"));
  }

  public string CallbackQueryParameter
  {
    get { return _callbackQueryParameter ?? "callback"; }
    set { _callbackQueryParameter = value; }
  }

  public override Task WriteToStreamAsync(Type type, object value, Stream writeStream, HttpContent content,
                                          TransportContext transportContext)
  {
    var callback = GetCallbackName();

    if (!String.IsNullOrEmpty(callback))
    {
      // select the correct encoding to use.
      Encoding encoding = SelectCharacterEncoding(content.Headers);

      // write the callback and opening paren.
      return Task.Factory.StartNew(() =>
        {
          var bytes = encoding.GetBytes(callback + "(");
          writeStream.Write(bytes, 0, bytes.Length);
        })
      // then we do the actual JSON serialization...
      .ContinueWith(t => base.WriteToStreamAsync(type, value, writeStream, content, transportContext))

      // finally, we close the parens.
      .ContinueWith(t =>
        {
          var bytes = encoding.GetBytes(")");
          writeStream.Write(bytes, 0, bytes.Length);
        });
    }
    return base.WriteToStreamAsync(type, value, writeStream, content, transportContext);
  }

  private string GetCallbackName()
  {
    if (HttpContext.Current.Request.HttpMethod != "GET")
      return null;
    return HttpContext.Current.Request.QueryString[CallbackQueryParameter];
  }

  #region Nested type: Mapping

  private class Mapping : MediaTypeMapping
  {
    private readonly Func<string> _param; 

    public Mapping(Func<string> discriminator, string mediaType)
      : base(mediaType)
    {
      _param = discriminator;
    }

    public override double TryMatchMediaType(HttpRequestMessage request)
    {
      if (request.RequestUri.Query.Contains(_param() + "="))
        return 1.0;
      return 0.0;
    }
  }

  #endregion
}

私はFunc<string>内部クラスコンストラクターのパラメーターの「ハッキング」を認識していますが、それが解決する問題を回避する最も速い方法でした。C＃には静的内部クラスしかないため、CallbackQueryParameterプロパティを表示できません。Funcinを渡すと、ラムダのプロパティがバインドMappingされるため、後ででそのプロパティにアクセスできますTryMatchMediaType。よりエレガントな方法がある場合は、コメントしてください！

残念ながら、コメントするには評判が足りないので、回答を掲載します。@Justinは、標準のJsonFormatterと共にWebApiContrib.Formatting.Jsonpフォーマッターを実行する問題を提起しました。この問題は、最新リリース（実際に少し前にリリースされた）で解決されています。また、最新のWeb APIリリースでも動作するはずです。

johperl、トーマス。上記のピーター・モバーグによる答えは、彼が継承したJsonMediaTypeFormatterがすでにNewtonSoft Jsonシリアライザーを使用しているため、RCバージョンでは正しいはずです。

しかし、なぜ次のようにすることができるのに、なぜ人々がまだパラメータを使用していないのですか？

public override Task WriteToStreamAsync(Type type, object value, Stream stream, HttpContentHeaders contentHeaders, TransportContext transportContext)
        {
            var isJsonpRequest = IsJsonpRequest();

            if(isJsonpRequest.Item1)
            {
                return Task.Factory.StartNew(() =>
                {
                    var writer = new StreamWriter(stream);
                    writer.Write(isJsonpRequest.Item2 + "(");
                    writer.Flush();
                    base.WriteToStreamAsync(type, value, stream, contentHeaders, transportContext).Wait();
                    writer.Write(")");
                    writer.Flush();
                });
            }

            return base.WriteToStreamAsync(type, value, stream, contentHeaders, transportContext);
        }

        private Tuple<bool, string> IsJsonpRequest()
        {
            if(HttpContext.Current.Request.HttpMethod != "GET")
                return new Tuple<bool, string>(false, null);

            var callback = HttpContext.Current.Request.QueryString[CallbackQueryParameter];

            return new Tuple<bool, string>(!string.IsNullOrEmpty(callback), callback);
        }

独自のJSONPフォーマッタバージョンをホストする代わりに、実装済みのWebApiContrib.Formatting.Jsonp NuGetパッケージをインストールできます（.NET Frameworkで動作するバージョンを選択してください）。

このフォーマッタをに追加しApplication_Startます。

GlobalConfiguration.Configuration.Formatters.Insert(0, new JsonpMediaTypeFormatter(new JsonMediaTypeFormatter()));

HttpSelfHostServerを使用している方は、このコードセクションがHttpContext.Currentで失敗します。これは、セルフホストサーバーに存在しないためです。

private Tuple<bool, string> IsJsonpRequest()
{
if(HttpContext.Current.Request.HttpMethod != "GET")
 return new Tuple<bool, string>(false, null);
 var callback = HttpContext.Current.Request.QueryString[CallbackQueryParameter];
 return new Tuple<bool, string>(!string.IsNullOrEmpty(callback), callback);
 }

ただし、このオーバーライドにより、セルフホストの「コンテキスト」をインターセプトできます。

public override MediaTypeFormatter GetPerRequestFormatterInstance(Type type, HttpRequestMessage request, MediaTypeHeaderValue mediaType)
        {
            _method = request.Method;
            _callbackMethodName =
                request.GetQueryNameValuePairs()
                       .Where(x => x.Key == CallbackQueryParameter)
                       .Select(x => x.Value)
                       .FirstOrDefault();

            return base.GetPerRequestFormatterInstance(type, request, mediaType);
        }

request.Methodは「GET」、「POST」などを提供し、GetQueryNameValuePairsは？callbackパラメータを取得できます。したがって、私の変更したコードは次のようになります。

private Tuple<bool, string> IsJsonpRequest()
 {
     if (_method.Method != "GET")
     return new Tuple<bool, string>(false, null);

     return new Tuple<bool, string>(!string.IsNullOrEmpty(_callbackMethodName), _callbackMethodName);
}

これがあなたの一部に役立つことを願っています。この方法では、必ずしもHttpContextシムは必要ありません。

C.

これをチェックしてください。それが役立つかどうかを確認します。

JSONPとWeb API

コンテキストがWeb Api、感謝の意を表し、010227leo回答を参照している場合は、WebContext.Currentこれからの価値を検討する必要がありますnull。

だから私は彼のコードをこれに更新しました：

public class JsonCallbackAttribute
    : ActionFilterAttribute
{
    private const string CallbackQueryParameter = "callback";

    public override void OnActionExecuted(HttpActionExecutedContext context)
    {
        var callback = context.Request.GetQueryNameValuePairs().Where(item => item.Key == CallbackQueryParameter).Select(item => item.Value).SingleOrDefault();

        if (!string.IsNullOrEmpty(callback))
        {
            var jsonBuilder = new StringBuilder(callback);

            jsonBuilder.AppendFormat("({0})", context.Response.Content.ReadAsStringAsync().Result);

            context.Response.Content = new StringContent(jsonBuilder.ToString());
        }

        base.OnActionExecuted(context);
    }
}

CORS（クロスオリジンリソースシェアリング）の問題は、2つの方法で解決できます。

1）Jsonpの使用2）Corsの有効化

1）Jsonp-を使用してJsonpを使用するには、WebApiContrib.Formatting.Jsonp nugetパッケージをインストールし、WebApiConfig.csにJsonpFormmaterを追加する必要があります。スクリーンショットを参照してください。

jqueryコード

2）Corsを有効にする-

corsを有効にするには、Microsoft.AspNet.WebApi.Cors nugetパッケージを追加し、WebApiConfig.csでcorsを有効にする必要があります。スクリーンショットを参照してください

詳細については、次のリンクを使用して、GitHubのサンプルリポジトリを参照できます。 https://github.com/mahesh353/Ninject.WebAPi/tree/develop