वेबएपीआई का प्रभावी उपयोग: स्वयं होस्टिंग आरईएसटी सेवाएं

ASP.NET WebAPI की रिलीज़ के साथ, डेवलपर्स के पास REST सेवाओं को सुविधाजनक तरीके से बनाने का अवसर है, एक तरफ पूरी तरह से REST के सिद्धांतों को लागू करने का, और दूसरी ओर ASP.NET प्लेटफॉर्म की पूरी शक्ति का उपयोग करने का।

बहुत सारे लेख पहले ही WebAPI की क्षमताओं और अनुप्रयोग के बारे में लिखे जा चुके हैं, उदाहरण के लिए, आप ApiExplorer के माध्यम से स्व-दस्तावेज एपीआई सेवाओं के दिलचस्प कार्य के बारे में जान सकते हैं।

वेबएपीआई की एक और बड़ी विशेषता है, जिसके बारे में बहुत कुछ नहीं लिखा गया है - यह वेबएपीआई की स्वतंत्र होस्टिंग सेवा (सेल्फ होस्टिंग) प्रदान करने की क्षमता है। यह लेख उदाहरण के उपयोग से WebAPI पर आधारित REST सेल्फहोस्टिंग सेवाओं को बनाने और चलाने का तरीका दिखाता है।

स्वयं की मेजबानी REST सेवा

सेवा एपीआई तक पहुंच प्रदान करने के लिए, इसे हमेशा IIS सर्वर के आधार पर तैनात करना उचित नहीं है। यदि सेवा किसी वेब एप्लिकेशन का हिस्सा नहीं है, तो यह अपने स्वयं के बुनियादी ढांचे के आधार पर इसे चलाने के लिए समझ में आता है।

स्वयं होस्टिंग तंत्र का उपयोग करने के लिए एक अन्य विकल्प उन प्लेटफार्मों पर सेवाओं को लॉन्च करना हो सकता है जिनमें आईआईएस सर्वर शामिल नहीं है या जिस पर आईआईएस का प्रक्षेपण जटिल या अनावश्यक है।

एक या दूसरा तरीका, वेबएपीआई आपको आईआईएस-स्वतंत्र सेवाएं बनाने की अनुमति देता है जो वेब सर्वर पर वेब एप्लिकेशन को स्थापित किए बिना एक्सेस किया जा सकता है।

कंसोल एप्लिकेशन के अंदर सेवा

कंसोल एप्लिकेशन के सबसे सरल उदाहरण पर स्वयं-होस्टिंग के कार्य पर विचार करें। विज़ुअल स्टूडियो 2012 के लिए C # में एक विज़ुअल कंसोल-आधारित कंसोल एप्लिकेशन बनाएँ।

NuGet पैकेज मैनेजर कंसोल का उपयोग करके, AspNetWebApi.Selfhost पैकेज स्थापित करें। यह निम्नलिखित कमांड के साथ किया जा सकता है:

इंस्टॉल करें-पैकेज AspNetWebApi.Selfhost

यह कमांड कंसोल एप्लिकेशन प्रोजेक्ट में सभी आवश्यक घटकों को स्थापित करेगा। उसके बाद, इस तरह के लिंक नहीं होने पर, प्रोजेक्ट में System.Web असेंबली के लिए एक लिंक जोड़ें।

सेल्फहॉस्टिंग सेवा बनाने के लिए पहला कदम इसे कॉन्फ़िगर करना है। कॉन्फ़िगरेशन HttpSelfHostConfiguration वर्ग की जिम्मेदारी है। नीचे एक सेवा को कॉन्फ़िगर करने का एक उदाहरण है:

var selfHostConfiguraiton = new HttpSelfHostConfiguration("http://localhost:5555"); selfHostConfiguraiton.Routes.MapHttpRoute( name: "DefaultApiRoute", routeTemplate: "api/{controller}", defaults: null ); 

पहली पंक्ति पता सेट के साथ सर्वर वर्ग का एक उदाहरण बनाती है। दूसरी पंक्ति सर्वर रूटिंग तंत्र को कॉन्फ़िगर करती है ताकि हम उस पर अपने REST API को चला सकें।

अगला कदम सर्वर को शुरू करना है, यह एक अन्य वर्ग HttpSelfHostServer का उपयोग करके हासिल किया गया है। नीचे वह कोड है जो सेल्फहोस्टिंग सेवाओं के लिए सर्वर शुरू करता है:

 using (var server = new HttpSelfHostServer(selfHostConfiguraiton)) { server.OpenAsync().Wait(); Console.ReadLine(); } 

यह हमारे सर्वर पर होस्ट करने के लिए हमारे अनुप्रयोग में एक REST सेवा जोड़ने का समय है। ऐसा करने के लिए, प्रोजेक्ट के लिए एक नया वेब एपीआई नियंत्रक वर्ग तत्व जोड़ें, उदाहरण के लिए, ProductController नाम। उत्पाद नामक परियोजना में एक नया वर्ग जोड़ें:

 public class Product { public int ID { get; set; } public string Name { get; set; } public string Description { get; set; } } 

नए बनाए गए ProductController में, नया GetAllProducts विधि जोड़ें:

 public IList<Product> GetAllProducts() { return new List<Product>(){ new Product(){ID = 1, Name="Product 1", Description="Desc 1"}, new Product(){ID = 2, Name="Product 2", Description="Desc 2"}, new Product(){ID = 3, Name="Product 3", Description="Desc 3"}, }; } 

संघर्षों से बचने के लिए, आपको टेम्पलेट में उत्पन्न गेट () विधि को हटाने या टिप्पणी करने की आवश्यकता होगी।

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

निष्पादन के लिए आवेदन चलाएँ।

अब, जब हमारा आवेदन चल रहा है, हम selfhosting सेवा तक पहुँच सकते हैं, जिसे IIS का उपयोग किए बिना शुरू किया गया है। बस http: // localhost: 5555 / एपीआई / उत्पाद / पर जाएं । परीक्षण के लिए, आप ब्राउज़र का उपयोग कर सकते हैं या फ़िडलर (चित्र 1) का उपयोग कर सकते हैं।


चित्र 1। एक सेल्फहॉस्टिंग सेवा को कॉल करने का परिणाम

विंडोज सेवा के रूप में सेल्फहोस्टिंग सेवाएं चलाना

सेल्फहॉस्टिंग सेवा शुरू करने के लिए, विंडोज सेवा के रूप में सर्वर एप्लिकेशन शुरू करना एक अच्छा विचार हो सकता है। यह करना काफी आसान है।

एक बहुत ही सुविधाजनक TopShelf टूल का उपयोग सिस्टम सेवाओं को जल्दी से बनाने के लिए किया जा सकता है। NuGet पैकेज मैनेजर कंसोल में, पैकेज इंस्टॉलेशन कमांड चलाएँ:

स्थापित-पैकेज topshelf

पैकेज को स्थापित करने के बाद, आपको एपीआई तक पहुंच प्राप्त होगी, जो आपको अपने एप्लिकेशन से आसानी से विंडोज सेवा बनाने की अनुमति देगा।

हम अपने प्रोजेक्ट का कोड थोड़ा बदल देंगे। सबसे पहले, हमने सर्वर के लॉन्च को एक अलग उत्पाद सेवा वर्ग में रखा:

 class ProductService { private readonly HttpSelfHostServer server; public ProductService() { var selfHostConfiguraiton = new HttpSelfHostConfiguration("http://127.0.0.1:5555"); selfHostConfiguraiton.Routes.MapHttpRoute( name: "DefaultApiRoute", routeTemplate: "api/{controller}", defaults: null ); server = new HttpSelfHostServer(selfHostConfiguraiton); } public void Start() { server.OpenAsync(); } public void Stop() { server.CloseAsync(); server.Dispose(); } } 

तब हम TopShelf API का उपयोग करके सेवा शुरू करने के लिए मुख्य विधि के कोड को संशोधित करते हैं:

 static void Main(string[] args) { HostFactory.Run(x => { x.Service<ProductService>(s => { s.SetServiceName("ProductService Example"); s.ConstructUsing(name => new ProductService()); s.WhenStarted(svc => svc.Start()); s.WhenStopped(svc => svc.Stop()); }); x.RunAsLocalSystem(); x.SetDescription("ProductService WebAPI selfhosting Windows Service Example"); x.SetDisplayName("ProductService Example"); x.SetServiceName("ProductService"); }); } 

यहां, TopShelf द्वारा प्रदान की जाने वाली विशेष विधियों का उपयोग करते हुए, हम सेवा को शुरू करने के लिए आवश्यक वर्ग, इसकी शुरुआत और रोक के तरीकों, सेवा का विवरण और उसके नाम को निर्धारित करके सेवा को पंजीकृत करते हैं।

आवश्यक संशोधनों के बाद परियोजना को संकलित करें। अब आप अपने एप्लिकेशन को विंडोज सेवा के रूप में चला सकते हैं, यह कमांड का उपयोग करके किया जाता है:

WebApiSelfhosting इंस्टॉल करें

सेवा स्थापित की जाएगी (चित्र 2)।


अंजीर। २। Windows सेवा स्थापित करें

अब, यदि आप विंडोज सिस्टम सेवाओं की सूची में जाते हैं, तो आप आसानी से अपना आवेदन (चित्र 3) पा सकते हैं।


चित्र 3। सिस्टम सेवा सूची में सेवा

यदि यह नहीं चल रहा है तो आपको अपनी सेवा शुरू करने की आवश्यकता हो सकती है (चित्र 4)


चित्र 4। सेवा शुरू

आइए फ़िडलर में विंडोज सेवा के रूप में शुरू की गई सेल्फहॉस्टिंग सेवा के संचालन की जांच करें और सुनिश्चित करें कि सब कुछ काम करता है।

आप कमांड का उपयोग करके सिस्टम से एक सेवा को हटा सकते हैं:

WebApiSelfhosting की स्थापना रद्द करें

निष्कर्ष

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

ASP.NET WebAPI विजुअल स्टूडियो 2012 में डेवलपर्स के लिए एक नया टूल उपलब्ध है। आप विजुअल स्टूडियो 2012 RC के नए संस्करण को विशेष संक्षिप्त पते पर डाउनलोड कर सकते हैं: http://vs2012.ru/ ।

अंतिम परियोजना के स्रोत कोड (सभी पैकेज और बाइनरी घटकों के साथ) sdrv.ms/K9F7Hs पर उपलब्ध हैं