ASP.NET वेब एपीआई के लिए JSONP फॉर्मेटर

बॉक्स से बाहर ASP.NET वेब एपीआई में JSONP फॉर्मैटर शामिल नहीं है, लेकिन इसे अपने हाथों से बनाना काफी सरल है।

हमें JSONP की आवश्यकता क्यों है

JSONP जावास्क्रिप्ट अनुप्रयोगों में से एक सर्वर से डेटा प्राप्त करने पर प्रतिबंध को दरकिनार करने के लिए जावास्क्रिप्ट अनुप्रयोगों में से एक है, जहां से एप्लिकेशन डाउनलोड किया गया था। JSONP एक फ़ंक्शन में JSON डेटा लपेटता है जो सर्वर से डेटा प्राप्त होने पर निष्पादित होता है। कल्पना कीजिए कि हमारे पास एक संसाधन है, उदाहरण के लिए, RemoteDomain/aspnetWebApi/albums RemoteDomain/aspnetWebApi/albums , जो हमें GET अनुरोध पर एल्बमों की एक सूची देता है और यह जानता है कि इस सूची को JSONP प्रारूप में कैसे दिया जाए। JQuery का उपयोग करते समय यह इस तरह दिखता है:

 function getAlbums() { $.getJSON("http://remotedomain/aspnetWebApi/albums?callback=?", null, function (albums) { alert(albums.length); }); } 

JSONP कैसा दिखता है

JSONP एक काफी सरल "प्रोटोकॉल" है। वह जो कुछ भी करता है वह एक फ़ंक्शन में JSON प्रारूप में डेटा को लपेटता है। उपरोक्त क्वेरी का परिणाम कुछ इस प्रकार है:

Query17103401925975181569_1333408916499( [{"Id":"34043957","AlbumName":"Dirty Deeds Done Dirt Cheap",…},{…}] )

jQuery एक अनुरोध भेजता है, एक प्रतिक्रिया प्राप्त करता है और इसे "निष्पादित करता है", JSON डेटा को एक पैरामीटर के रूप में लेता है।

JSONP कैसे काम करता है

यह समझने के लिए कि JSONP कैसे काम करता है, मैं निम्नलिखित उदाहरण शुद्ध जावास्क्रिप्ट में दूंगा:

 function jsonp(url, callback) { //    var id = "_" + (new Date()).getTime(); //    window[id] = function (result) { //    if (callback) callback(result); // :     var sc = document.getElementById(id); sc.parentNode.removeChild(sc); window[id] = null; } url = url.replace("callback=?", "callback=" + id); //   <script>,   JSONP- //   ,   window[id] var script = document.createElement("script"); script.setAttribute("id", id); script.setAttribute("src", url); script.setAttribute("type", "text/javascript"); document.body.appendChild(script); } 

पिछले jQuery के उदाहरण के समान, हम एल्बम की सूची प्राप्त करने के लिए इस फ़ंक्शन का उपयोग करते हैं:

 function getAlbumsManual() { jsonp("http://remotedomain/aspnetWebApi/albums?callback=?", function (albums) { alert(albums.length); }); } 

JSONP और ASP.NET वेब एपीआई

जैसा कि लेख की शुरुआत में कहा गया है, ASP.NET वेब एपीआई बॉक्स से बाहर JSONP का समर्थन नहीं करता है। हालांकि, अपना खुद का JSONP फॉर्मैटर बनाना और इसे प्रोजेक्ट से कनेक्ट करना बहुत सरल है।

नीचे दिया गया कोड क्रिश्चियन वियर पर आधारित है। कोड को नवीनतम वेब एपीआई आरटीएम के साथ संगतता के लिए परिष्कृत किया गया है।

 using System; using System.IO; using System.Net; using System.Net.Http.Formatting; using System.Net.Http.Headers; using System.Threading.Tasks; using System.Web; using System.Net.Http; using Newtonsoft.Json.Converters; using System.Web.Http; namespace Westwind.Web.WebApi { /// <summary> /// Handles JsonP requests when requests are fired with text/javascript /// </summary> public class JsonpFormatter : JsonMediaTypeFormatter { public JsonpFormatter() { SupportedMediaTypes.Add(new MediaTypeHeaderValue("application/json")); SupportedMediaTypes.Add(new MediaTypeHeaderValue("text/javascript")); JsonpParameterName = "callback"; } /// <summary> /// Name of the query string parameter to look for /// the jsonp function name /// </summary> public string JsonpParameterName {get; set; } /// <summary> /// Captured name of the Jsonp function that the JSON call /// is wrapped in. Set in GetPerRequestFormatter Instance /// </summary> private string JsonpCallbackFunction; public override bool CanWriteType(Type type) { return true; } /// <summary> /// Override this method to capture the Request object /// </summary> /// <param name="type"></param> /// <param name="request"></param> /// <param name="mediaType"></param> /// <returns></returns> public override MediaTypeFormatter GetPerRequestFormatterInstance(Type type, System.Net.Http.HttpRequestMessage request, MediaTypeHeaderValue mediaType) { var formatter = new JsonpFormatter() { JsonpCallbackFunction = GetJsonCallbackFunction(request) }; // this doesn't work unfortunately //formatter.SerializerSettings = GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings; // You have to reapply any JSON.NET default serializer Customizations here formatter.SerializerSettings.Converters.Add(new StringEnumConverter()); formatter.SerializerSettings.Formatting = Newtonsoft.Json.Formatting.Indented; return formatter; } public override Task WriteToStreamAsync(Type type, object value, Stream stream, HttpContent content, TransportContext transportContext) { if (string.IsNullOrEmpty(JsonpCallbackFunction)) return base.WriteToStreamAsync(type, value, stream, content, transportContext); StreamWriter writer = null; // write the pre-amble try { writer = new StreamWriter(stream); writer.Write(JsonpCallbackFunction + "("); writer.Flush(); } catch (Exception ex) { try { if (writer != null) writer.Dispose(); } catch { } var tcs = new TaskCompletionSource<object>(); tcs.SetException(ex); return tcs.Task; } return base.WriteToStreamAsync(type, value, stream, content, transportContext) .ContinueWith( innerTask => { if (innerTask.Status == TaskStatus.RanToCompletion) { writer.Write(")"); writer.Flush(); } },TaskContinuationOptions.ExecuteSynchronously) .ContinueWith( innerTask => { writer.Dispose(); return innerTask; },TaskContinuationOptions.ExecuteSynchronously) .Unwrap(); } /// <summary> /// Retrieves the Jsonp Callback function /// from the query string /// </summary> /// <returns></returns> private string GetJsonCallbackFunction(HttpRequestMessage request) { if (request.Method != HttpMethod.Get) return null; var query = HttpUtility.ParseQueryString(request.RequestUri.Query); var queryVal = query[this.JsonpParameterName]; if (string.IsNullOrEmpty(queryVal)) return null; return queryVal; } } } 

मैं एक बार फिर ध्यान देता हूं कि यह कोड वेब एपीआई के बीटा संस्करण के साथ काम नहीं करेगा; यह केवल RTM संस्करण के साथ काम करता है।

यह भी ध्यान दिया जाना चाहिए कि जब आप इस JSONP फॉर्मैटर को कनेक्ट करते हैं, तो आप वास्तव में स्टॉक JSON फॉर्मैटर को बदलते हैं, क्योंकि यह उसी MIME प्रकार को प्रोसेस करता है। यह कोड अभी भी स्टॉक JSON फॉर्मेटर का उपयोग करता है, लेकिन इसे प्रारंभ नहीं करता है, लेकिन प्रत्येक JSON या JSONP अनुरोध के लिए एक नया उदाहरण बनाता है। इसका मतलब है कि यदि आपको कुछ छवियों के लिए JSON GetPerRequestFormatterInstance() को कॉन्फ़िगर करने की आवश्यकता है, तो आपको GetPerRequestFormatterInstance() को ओवरराइड करके इस कोड में ऐसा करना होगा।

JSONP फॉर्मेटर कनेक्शन

JSONP फॉर्मैटर को Global_as.l फ़ाइल के Application_Start() अनुभाग में फ़ॉर्मैटर संग्रह में जोड़कर जोड़ा जाता है

 protected void Application_Start(object sender, EventArgs e) { //   GlobalConfiguration .Configuration .Formatters .Insert(0, new Westwind.Web.WebApi.JsonpFormatter()); } 

वह सब है।

नोट। मैंने सभी के सामने एक JSONP फॉर्मैटर जोड़ा। यह आवश्यक है कि JSON फॉर्मेटर को स्टॉक JSON फॉर्मेटर से पहले निर्दिष्ट किया जाए, अन्यथा इसे कभी नहीं कहा जाएगा।

GitHub स्रोत कोड

अनुवादक से

सामान्य तौर पर, यह एक बहुत ही मुफ्त अनुवाद है, इसलिए कानों में सभी थप्पड़, कृपया, पीएम में। कई हिस्सों को छोड़ दिया गया है, क्योंकि उन्होंने सार को व्यक्त करने में महत्वपूर्ण भूमिका नहीं निभाई है। किसी भी स्थिति में, कृपया मूल को देखें।

वेब API RTM में, एक WriteToStreamAsync() में WriteToStreamAsync() विधि वेब API RC में भिन्न होती है: पहले HttpContent में, दूसरे में - HttpContentHeader ।

मैंने ApiConfig.cs फ़ाइल में JSON ApiConfig.cs शामिल किया:

ApiConfig.cs

 public static void RegisterApiConfigure(HttpConfiguration config) { // Remove the JSON formatter //config.Formatters.Remove(config.Formatters.JsonFormatter); // Remove the XML formatter config.Formatters.Remove(config.Formatters.XmlFormatter); // Indenting //config.Formatters.JsonFormatter.SerializerSettings.Formatting = Newtonsoft.Json.Formatting.Indented; // Add a custom JsopFormatter config.Formatters.Insert(0, new JsonpFormatter()); } 

Global.asax.cs

 protected void Application_Start() { AreaRegistration.RegisterAllAreas(); FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters); RouteConfig.RegisterRoutes(RouteTable.Routes); BundleConfig.RegisterBundles(BundleTable.Bundles); ApiConfig.RegisterApiConfigure(GlobalConfiguration.Configuration); }