.NET MVC 4 में एपीआई संस्करण

शुभ दिन।

ASP.NET वेब एपीआई के आगमन के साथ , आपकी साइट के लिए एपीआई बनाने के लिए एक सुविधाजनक और शक्तिशाली उपकरण दिखाई दिया है। लेकिन, जैसा कि आप जानते हैं, समय के साथ, आपका एपीआई बदल सकता है, पूरक हो सकता है या खरोंच से पूरी तरह से छुटकारा पाया जा सकता है। पुराने ग्राहकों के साथ संगतता के लिए, संस्करण को लागू किया जाना चाहिए।

दुर्भाग्य से, फिलहाल, Microsoft ने वर्जनिंग को लागू करने के लिए एक सुविधाजनक और आसान तरीका प्रदान नहीं किया है। इंटरनेट पर आप इस विषय पर कुछ जानकारी पा सकते हैं, लेकिन, एक नियम के रूप में, मैंने जो भी समाधान पाया है उनमें से प्रत्येक के लिए संस्करण के लिए एक पैरामीटर जोड़ने और इसे संसाधित करने के लिए नीचे आ गया है। मैं संस्करणकरण के लिए अधिक लचीली विधि प्राप्त करना चाहता था, जो नियंत्रक विधियों को रोक नहीं पाएगा और यदि बहुत सारे ब्लॉक बचाएंगे। और मेरे लिए मुख्य मानदंड समान एपीआई विधियों के लिए समान नामों के साथ नियंत्रकों की क्षमता थी, लेकिन नामस्थानों का उपयोग करके संस्करणों में अलग हो गए।

इसी समय, ASP.NET MVC वेब एपीआई में IHttpControllerSelector इंटरफ़ेस के रूप में एक काफी शक्तिशाली तंत्र है, जिसके साथ आप कोड को साफ और समझ में छोड़कर, संस्करण को लागू कर सकते हैं।

देखते हैं कि यह क्या आया।


सबसे पहले, हमें राउटिंग को सही तरीके से कॉन्फ़िगर करने की आवश्यकता है ताकि संस्करण संख्या को एक पैरामीटर के रूप में व्याख्या की जाए (नियंत्रक में हम केवल इसे अनदेखा करेंगे)।

httpRoutes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/v{version}/{controller}/{id}", defaults: new { id = RouteParameter.Optional } ); 

इस प्रकार, हमारे सभी एपीआई तरीके एपीआई / वी {संस्करण} / {नियंत्रक} / {आईडी} की तरह दिखेंगे, जहां {संस्करण} एपीआई की संस्करण संख्या है। वास्तव में, आप न केवल संख्या का उपयोग कर सकते हैं, बल्कि आम तौर पर कुछ भी। मुख्य बात यह है कि हम इस पैरामीटर द्वारा एपीआई कार्यान्वयन को अलग कर सकते हैं।

अगला, आपको सही अनुरोध प्रसंस्करण स्थापित करने की आवश्यकता है: नियंत्रकों का चयन और निर्माण। यह प्रक्रिया बहुत सरल लगती है। कंट्रोलर फैक्ट्री को पता होना चाहिए कि उसे कौन सा कंट्रोलर बनाना है। यह ठीक वही है जो IHttpControllerSelector इंटरफ़ेस के लिए है।

ज्यादातर मामलों में, हम पूरी तरह से मानक DefaultHttpControllerSelector से संतुष्ट हैं, इसलिए संस्करण को लागू करने के लिए इसे पूरी तरह से खरोंच से लिखना आवश्यक नहीं है।

ऐसा करने के लिए, हम DefaultHttpControllerSelector को त्याग देंगे और इसकी मुख्य SelectController विधि को ओवरराइड करेंगे। यह वह है जो नियंत्रक की पसंद के लिए जिम्मेदार है और नियंत्रक को एक हैंडल के साथ कारखाना प्रदान करता है।

 public class HttpControllerSelector : DefaultHttpControllerSelector { private readonly HttpConfiguration configuration; public HttpControllerSelector(HttpConfiguration configuration) : base(configuration) { this.configuration = configuration; } public override HttpControllerDescriptor SelectController(HttpRequestMessage request) { } } 

कंट्रोलर सेलेक्टर को एक पैरामीटर के रूप में वर्तमान HttpConfiguration की आवश्यकता होती है। इसलिए, हम इसे IoC कंटेनर में निर्भरता के साथ पंजीकृत करते हैं। अक्सर मैं कैसल विंडसर का उपयोग करता हूं, यही वजह है कि इसका उपयोग उदाहरण में किया जाता है।

 container.Register( Component.For<IHttpControllerSelector>().ImplementedBy<HttpControllerSelector>().DependsOn( Dependency.OnValue<HttpConfiguration>(GlobalConfiguration.Configuration))); 

अब हम सीधे SelecController विधि में उपयुक्त नियंत्रक के चयन की प्रक्रिया पर जाते हैं।
नियंत्रक कारखाने को उम्मीद है कि हम से HttpControllerDescriptor डिस्क्रिप्टर है, जिसमें नियंत्रक का नाम और इसके प्रकार शामिल हैं।

 HttpControllerDescriptor(HttpConfiguration, String, Type) 

नियंत्रक का नाम प्राप्त करने के लिए, हम DefaultHttpControllerSelector वर्ग की मूल कार्यक्षमता का उपयोग कर सकते हैं।

 var controllerName = GetControllerName(request); 

यदि नाम के साथ सब कुछ सरल और स्पष्ट है, तो नियंत्रक के प्रकार को निर्धारित करने के लिए हमें हमारे सिस्टम में उपलब्ध नियंत्रकों को जानना होगा। ऐसा करने के लिए, उन्हें गणना करने के लिए एक फ़ील्ड और एक विधि जोड़ें। उसके बाद, हमारी कक्षा इस तरह दिखती है:

 public class HttpControllerSelector : DefaultHttpControllerSelector { private readonly HttpConfiguration configuration; private readonly Lazy<ConcurrentDictionary<string, Type>> controllerTypes; public HttpControllerSelector(HttpConfiguration configuration) : base(configuration) { this.configuration = configuration; controllerTypes = new Lazy<ConcurrentDictionary<string, Type>>(GetControllerTypes); } public override HttpControllerDescriptor SelectController(HttpRequestMessage request) { var controllerName = GetControllerName(request); } private static ConcurrentDictionary<string, Type> GetControllerTypes() { var assemblies = AppDomain.CurrentDomain.GetAssemblies(); var types = assemblies .SelectMany(a => a.GetTypes().Where(t => !t.IsAbstract && t.Name.EndsWith(ControllerSuffix, StringComparison.OrdinalIgnoreCase) && typeof (IHttpController).IsAssignableFrom(t))) .ToDictionary(t => t.FullName, t => t); return new ConcurrentDictionary<string, Type>(types); } } 

हमें अनुरोध से संस्करण संख्या भी चाहिए

 object version; request.GetRouteData().Values.TryGetValue("version", out version); 

संस्करण द्वारा नियंत्रक प्रकार प्राप्त करने के लिए एक विधि जोड़ें

 var type = GetControllerType((string)version, controllerName); 

विधि स्वयं बेहद सरल है: नियंत्रक प्रकारों की सूची से, हमें एपीआई के संगत संस्करण के नाम स्थान में पड़े नियंत्रक का चयन करना होगा

 private Type GetControllerType(string version, string controllerName) { var query = controllerTypes.Value.AsEnumerable(); return query.ByVersion(version) .ByControllerName(controllerName) .Select(x => x.Value) .Single(); } 

यह नियंत्रकों को फ़िल्टर करने के लिए दो कस्टम एक्सटेंशन का उपयोग करता है

 public static IEnumerable<KeyValuePair<string, Type>> ByVersion(this IEnumerable<KeyValuePair<string, Type>> query, string version) { var versionNamespace = string.Format(CultureInfo.InvariantCulture, ".V{0}.", version); return query.Where(x => x.Key.IndexOf(versionNamespace, StringComparison.OrdinalIgnoreCase) != -1); } public static IEnumerable<KeyValuePair<string, Type>> ByControllerName(this IEnumerable<KeyValuePair<string, Type>> query, string controllerName) { var controllerNameToFind = string.Format(CultureInfo.InvariantCulture, ".{0}{1}", controllerName, DefaultHttpControllerSelector.ControllerSuffix); return query.Where(x => x.Key.EndsWith(controllerNameToFind, StringComparison.OrdinalIgnoreCase)); } 

अब हमारे पास नियंत्रक के लिए एक हैंडल बनाने के लिए आवश्यक सब कुछ है। परिणामी कक्षा:

 public class HttpControllerSelector : DefaultHttpControllerSelector { private readonly HttpConfiguration configuration; private readonly Lazy<ConcurrentDictionary<string, Type>> controllerTypes; public HttpControllerSelector(HttpConfiguration configuration) : base(configuration) { this.configuration = configuration; controllerTypes = new Lazy<ConcurrentDictionary<string, Type>>(GetControllerTypes); } public override HttpControllerDescriptor SelectController(HttpRequestMessage request) { object version; request.GetRouteData().Values.TryGetValue("version", out version); var controllerName = GetControllerName(request); var type = GetControllerType((string)version, controllerName); return new HttpControllerDescriptor(configuration, controllerName, type); } private static ConcurrentDictionary<string, Type> GetControllerTypes() { var assemblies = AppDomain.CurrentDomain.GetAssemblies(); var types = assemblies .SelectMany(a => a.GetTypes().Where(t => !t.IsAbstract && t.Name.EndsWith(ControllerSuffix, StringComparison.OrdinalIgnoreCase) && typeof (IHttpController).IsAssignableFrom(t))) .ToDictionary(t => t.FullName, t => t); return new ConcurrentDictionary<string, Type>(types); } private Type GetControllerType(string version, string controllerName) { var query = controllerTypes.Value.AsEnumerable(); return query.ByVersion(version) .ByControllerName(controllerName) .Select(x => x.Value) .Single(); } } public static class ControllerTypeSpecifications { public static IEnumerable<KeyValuePair<string, Type>> ByVersion(this IEnumerable<KeyValuePair<string, Type>> query, string version) { var versionNamespace = string.Format(CultureInfo.InvariantCulture, ".V{0}.", version); return query.Where(x => x.Key.IndexOf(versionNamespace, StringComparison.OrdinalIgnoreCase) != -1); } public static IEnumerable<KeyValuePair<string, Type>> ByControllerName(this IEnumerable<KeyValuePair<string, Type>> query, string controllerName) { var controllerNameToFind = string.Format(CultureInfo.InvariantCulture, ".{0}{1}", controllerName, DefaultHttpControllerSelector.ControllerSuffix); return query.Where(x => x.Key.EndsWith(controllerNameToFind, StringComparison.OrdinalIgnoreCase)); } } 

नतीजतन, हमारे पास फॉर्म का नियंत्रक रखने की क्षमता के साथ एक सरल एपीआई संस्करण तंत्र है

 Controllers.Api.V1.UserController Controllers.Api.V2.UserController 

यदि आपका एपीआई मौलिक रूप से नहीं बदला है, तो हमें केवल फ़िल्टरिंग विधियों को थोड़ा समायोजित करने की आवश्यकता है जो नवीनतम उपलब्ध संस्करण के नियंत्रक का चयन करेंगे।

आपका ध्यान देने के लिए धन्यवाद।