क्लासिक ASP.NET में एक प्रतिष्ठित सेवा को लागू करना

लेख बताता है कि कैसे एक मौजूदा क्लासिक ASP.NET अनुप्रयोग में एक RESTful एपीआई को जल्दी से लागू किया जाए।
MVC पुस्तकालय की क्षमताओं का अधिकतम उपयोग कैसे करें।

हम किन उपकरणों का उपयोग करेंगे

1. System.Web.Routing। MyTite.ru/rest/client/0 जैसे लिंक प्राप्त करने के लिए रूटटेबल और IRouteHandler
2. System.Web.Mvc। DefaultModelBinder मॉडल के अनुरोध से डेटा लिखने से बचने के लिए
3. प्रणाली। IHttpHandler को CRUD संचालन में से एक में अनुरोधों को परिवर्तित करने के लिए

कार्य सिद्धांत

रूटटेबल में हम रूट जोड़ते हैं, जो टेम्पलेट के अनुसार, उस अनुरोध को पुनर्निर्देशित करता है, जिसे हमें HttpHandler की आवश्यकता है।
हम दो रूट रजिस्टर करते हैं - सीआरयूडी ऑपरेशंस के लिए और पैरामीटर्स सर्च ऑपरेशंस के लिए।
HttpHandler अनुरोध विधि और पारित मापदंडों द्वारा वांछित संचालन का चयन करता है।
यदि यह एक अनुरोध है और क्वेरी पैरामीटर मौजूद है, तो पैरामीटर द्वारा एक खोज ऑपरेशन चुना जाता है।
यदि यह एक लेखन ऑपरेशन (क्रिएट, अपडेट, डिलीट) है, तो DefaultModelBinder वंशज का उपयोग वांछित मॉडल बनाने या लोड करने के लिए किया जाता है और अनुरोध से प्राप्त डेटा उस पर लागू होता है।
रीड ऑपरेशन के दौरान, यदि आईडी पैरामीटर पास किया जाता है, तो एक मॉडल का चयन किया जाता है, यदि आईडी पास नहीं होती है, तो मॉडल का पूरा संग्रह वापस आ जाता है।
मॉडल को JSON ऑब्जेक्ट में बदलने के लिए अंतिम चरण है।

प्रतिक्रिया 30 सेकंड के लिए कैशिंग कॉन्फ़िगर करती है।
मैंने कॉन्फ़िगरेशन लागू नहीं किया ताकि कोड को अव्यवस्थित न किया जाए।

किसी समाधान को कॉन्फ़िगर करते समय, दो कठिनाइयाँ उत्पन्न हो सकती हैं:
1. 404 त्रुटि - IIS में फ़ाइल अस्तित्व की जांच को अक्षम करके इलाज किया जाता है
( यहां देखें या नीचे web.config सेटिंग्स)
2. सत्र की वस्तु अनुपस्थित है - इसका उपचार सत्र मॉड्यूल को फिर से पंजीकृत करके किया जाता है
( यहां देखें या नीचे web.config सेटिंग्स)

आवेदन स्रोत यहां से डाउनलोड किए जा सकते हैं

ग्राहक मॉडल के लिए सेवा कार्यान्वयन उदाहरण

क्लास ClientRestHttpHandler

public class ClientRestHttpHandler : RestHttpHandler<Client, ClientModelBinder> { protected override IEnumerable<Client> GetAll() { return ClientService.GetAll(); } protected override Client GetBy(int id) { return ClientService.GetById(id); } protected override IEnumerable<Client> GetBy(NameValueCollection query) { var result = ClientService.GetAll(); var contains = query["contains"]; if (contains != null) { result = from item in result where item.FirstName.Contains(contains) || item.LastName.Contains(contains) select item; } return result; } protected override void Create(Client entity) { ClientService.Create(entity); } protected override void Update(Client entity) { ClientService.Update(entity); } protected override void Delete(Client entity) { ClientService.Delete(entity); } protected override object ToJson(Client entity) { return new { entity.Id, entity.FirstName, entity.LastName }; } } 

क्लास ClientModelBinder

 public class ClientModelBinder : DefaultModelBinder { protected override object CreateModel(ControllerContext controllerContext, ModelBindingContext bindingContext, System.Type modelType) { var value = bindingContext.ValueProvider.GetValue("id"); if (value == null) return ClientService.New(); var result = (int)value.ConvertTo(typeof(int)); return ClientService.GetById(result); } } 

Global.asax में नाम

  void Application_Start(object sender, EventArgs e) { RestRouteHandler<ClientRestHttpHandler>.Register("client", "clients"); } 

वेब कॉन्फ़िगर करना

 <configuration> <system.webServer> <modules runAllManagedModulesForAllRequests="true"> <!-- fix for empty session on RESTful requests. see http://stackoverflow.com/questions/218057/httpcontext-current-session-is-null-when-routing-requests --> <remove name="Session" /> <add name="Session" type="System.Web.SessionState.SessionStateModule"/> </modules> <handlers> <add name="WildCard" path="*" verb="*" resourceType="Unspecified" /> </handlers> </system.webServer> </configuration> 

यही है, क्लाइंट मॉडल हमारी वेबसाइट से REST API के माध्यम से उपलब्ध है।

बेस कक्षाओं के स्रोत रेस्टहेटफैंडलर और रेस्टेरटहैंडलर

 public abstract class RestHttpHandler : IHttpHandler, IReadOnlySessionState { public const string ParamKeyId = "id"; public const string ParamKeyQuery = "query"; /// <summary> /// RouteData property gives an access to request data provided by the router /// It has a setter to simplify instantiation from the RestRouteHandler class /// </summary> public RouteData RouteData { get; set; } protected bool HasId { get { return this.RouteData.Values[ParamKeyId] != null; } } protected bool HasQuery { get { return this.RouteData.Values[ParamKeyQuery] != null; } } protected int ParseId() { return int.Parse(this.RouteData.Values[ParamKeyId].ToString()); } protected NameValueCollection ParseQuery() { var regex = new Regex("(?<key>[a-zA-Z\\-]+)($|/)(?<value>[^/]+)?"); var matches = regex.Matches(this.RouteData.Values[ParamKeyQuery].ToString()); var result = new NameValueCollection(); foreach (Match match in matches) { result.Add(match.Groups["key"].Value, match.Groups["value"].Value); } return result; } public bool IsReusable { get { return false; } } public abstract void ProcessRequest(HttpContext context); } 

 public abstract class RestHttpHandler<T, TBinder> : RestHttpHandler where T : class where TBinder : DefaultModelBinder, new() { /// <summary> /// ProcessRequest actually does request mapping to one of CRUD actions /// </summary> public override void ProcessRequest(HttpContext context) { var @params = new NameValueCollection { context.Request.Form, context.Request.QueryString }; foreach (var value in this.RouteData.Values) { @params.Add(value.Key, value.Value.ToString()); } RenderHeader(context); if (context.Request.HttpMethod == "GET") { if (this.HasQuery) { @params.Add(this.ParseQuery()); this.Render(context, this.GetBy(@params)); } else { if (this.HasId) { this.Render(context, this.GetBy(this.ParseId())); } else { this.Render(context, this.GetAll()); } } } else { var entity = BindModel(@params); switch (context.Request.HttpMethod) { case "POST": this.Create(entity); break; case "PUT": this.Update(entity); break; case "DELETE": this.Delete(entity); break; default: throw new NotSupportedException(); } this.Render(context, entity); } } protected abstract T GetBy(int id); protected abstract IEnumerable<T> GetBy(NameValueCollection query); protected abstract IEnumerable<T> GetAll(); protected abstract void Create(T entity); protected abstract void Update(T entity); protected abstract void Delete(T entity); protected abstract object ToJson(T entity); private object ToJson(IEnumerable<T> entities) { return ( from entity in entities select this.ToJson(entity)).ToArray(); } private static T BindModel(NameValueCollection @params) { return new TBinder().BindModel( new ControllerContext(), new ModelBindingContext { ModelMetadata = ModelMetadataProviders.Current.GetMetadataForType(null, typeof(T)), ValueProvider = new NameValueCollectionValueProvider( @params, CultureInfo.InvariantCulture ) } ) as T; } private static void RenderHeader(HttpContext context) { context.Response.ClearHeaders(); context.Response.ClearContent(); context.Response.ContentType = "application/json"; context.Response.ContentEncoding = Encoding.UTF8; var cachePolicy = context.Response.Cache; cachePolicy.SetCacheability(HttpCacheability.Public); cachePolicy.SetMaxAge(TimeSpan.FromSeconds(30.0)); } private void Render(HttpContext context, IEnumerable<T> entities) { Render(context, RuntimeHelpers.GetObjectValue(this.ToJson(entities))); } private void Render(HttpContext context, T entity) { Render(context, RuntimeHelpers.GetObjectValue(this.ToJson(entity))); } private static void Render(HttpContext context, object result) { context.Response.Write( new JavaScriptSerializer().Serialize( RuntimeHelpers.GetObjectValue(result) ) ); } } 

 public class RestRouteHandler<T> : IRouteHandler where T : RestHttpHandler, new() { IHttpHandler IRouteHandler.GetHttpHandler(RequestContext requestContext) { return new T() { RouteData = requestContext.RouteData }; } public static void Register(string name, string pluralName) { RouteTable.Routes.Add( name, new Route( string.Format( "rest/{0}/{{{1}}}", name, RestHttpHandler.ParamKeyId ), new RestRouteHandler<T>() ) { Defaults = new RouteValueDictionary { { RestHttpHandler.ParamKeyId, null } }, Constraints = new RouteValueDictionary { { RestHttpHandler.ParamKeyId, "\\d*" } } } ); RouteTable.Routes.Add( pluralName, new Route( string.Format( "rest/{0}/{{*{1}}}", pluralName, RestHttpHandler.ParamKeyQuery ), new RestRouteHandler<T>()) { Defaults = new RouteValueDictionary { { RestHttpHandler.ParamKeyQuery, "" } } } ); } } 

मुझे आशा है कि मेरा अनुभव आपके लिए उपयोगी होगा।