GSOAP का उपयोग करके एक वेब सेवा लिखना

आप किस बारे में बात कर रहे हैं?

कभी-कभी पुराने और अच्छे C ++ में SOAP सेवाओं को लागू करने की आवश्यकता होती है। बेशक, सच्चे प्रोग्रामिंग प्रेमी अपने दम पर एक सर्वर लिखने के लिए दौड़ते हैं, लेकिन मैं समय बर्बाद करने और तैयार पुस्तकालयों का उपयोग करना पसंद नहीं करता हूं। आज मैं अपने C ++ एप्लिकेशन में सर्वर के रूप में gSOAP लाइब्रेरी का उपयोग करने के विषय को (बस थोड़ा सा) कवर करना चाहता हूं।

उपकरण

मैं अपनी कहानी में विज़ुअल स्टूडियो 2010 SP1 का उपयोग करूँगा, लेकिन मैं तुरंत उल्लेख करूँगा कि gSOAP अन्य प्लेटफार्मों और कंपाइलरों पर ठीक काम करता है, न कि केवल विंडोज़ पर।

पुस्तकालय को यहां डाउनलोड किया जा सकता है [http://www.cs.fsu.edu/~engelen/soap.html] (मैंने v2.8.2 का उपयोग किया)।

समस्या का बयान

प्रोटोकॉल के अनुसार काम करते हुए भुगतान स्वीकृति सेवा (अच्छी तरह से, मैं झूठ बोल रहा हूं) विकसित करना आवश्यक है।
सिस्टम में छद्म हस्ताक्षर के साथ केवल एक ही विधि है:
void MakePayment([IN] int qty, [OUT]int& errorCode, [OUT]string& message)

चलो चलते हैं!

GSOAP में सर्वर कोड जनरेट करने की प्रक्रिया लगभग पूरी तरह से स्वचालित है। अंदर सेवाओं का वर्णन करने के लिए अपनी भाषा विकसित की, तत्वों के साथ व्याकरण में बहुत समान "++"। इसलिए हमें WSDL के अध्ययन के साथ भी स्टीम बाथ नहीं लेना है (लेकिन फिर भी यह इसके बारे में एक विचार है)।

इसके अलावा, हम अविश्वसनीय रूप से भाग्यशाली थे, क्योंकि gSOAP वितरण में पहले से ही लोकप्रिय प्लेटफार्मों के लिए इस भाषा के लिए संकलित प्रोसेसर शामिल हैं, जिसमें विंडोज भी शामिल है (मेरा विश्वास करो, अपने हाथों से इसे संकलित करें (और यहां तक ​​कि विंडोज पर) आपको ओपनसोर्स पुस्तकालयों पर बड़ी संख्या में निर्भरता के कारण आपको खुशी देने की संभावना नहीं है, जो कि निर्माण भी करना है ...)।

तो, हम gsoap \ bin \ win32 \ directory में चढ़ते हैं और वहां दो प्रोग्राम देखते हैं। साबुनकैप 2.exe ठीक उसी तरह से जिम्मेदार है जिसकी हमें आवश्यकता है - सर्वर कोड, क्लाइंट प्रॉक्सी (यदि आवश्यक हो) में सी-लाइक सेवा विवरण भाषा का प्रसंस्करण, डब्ल्यूएसडीएल विवरण और साबुन अनुरोध-उत्तर-लिफाफे के उदाहरण। आस-पास झूठ wsdl2h.exe है - यह उपयोगिता आपको सेवा के डब्लूएसडीएल विवरण को चलाने की अनुमति देती है और आउटपुट पर, सी-लाइक भाषा में साबुनकैप 2.exe में आगे उपयोग के लिए सेवा का विवरण प्राप्त करती है। हमें उनमें से केवल पहले की आवश्यकता है, क्योंकि हमारे पास अभी तक WSDL पर सेवा का विवरण नहीं है।

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

सर्वर

आइए सेवा के विवरण के साथ शुरू करें। यह फाइलों में उत्पन्न होता है, आमतौर पर एक्सटेंशन एच के साथ। हम फ़ाइल भुगतान सेवा का नाम देते हैं। इसमें निम्नलिखित लिखें:

 //gsoap ns service name: paymentssl //gsoap ns service style: rpc //gsoap ns service encoding: encoded //gsoap ns service namespace: urn:paymentssl //gsoap ns service location: http://localhost:9999 //gsoap ns service method-action: MakePayment urn:MakePayment typedef int xsd__int; typedef char* xsd__string; enum t__status // remote status: { STATE_OK, // ok STATE_FAIL // fail to process }; class t__result { public: enum t__status errCode; xsd__string message; }; int ns__MakePayment(xsd__int qty, t__result* result); 

सीधे SOAP संदेशों को संसाधित करने के लिए पैरामीटर "मैजिक कमेंट" (पहली पंक्तियों) के रूप में सेट किए गए हैं। यह वहाँ बंद करने के लिए थोड़ा समझ में आता है, वे मानक SOAP की लगभग एक प्रति हैं। जब तक विधि-कार्रवाई का प्रारूप समझाने लायक नहीं है - इसके लिए पहला तर्क विधि के नाम को इंगित करता है, और दूसरा उचित स्थिरीकरण।

हम soapcpp2.exe -2 -i -e paymentservice.h लॉन्च soapcpp2.exe -2 -i -e paymentservice.h
मैं मापदंडों को समझाऊंगा:

• -2 - हम SOAP v1.2 का उपयोग करते हैं;
• -i - soap संरचना से विरासत में मिली सी ++ कक्षाओं के लिए कोड जनरेट करें। यह संरचना gSOAP कर्नेल का हिस्सा है (gSOAP C पर आधारित है, जिसके शीर्ष पर, हमेशा की तरह, आप C ++ आवरण बना सकते हैं);
• -e - SOAP RPC की शैली में बाइंडिंग उत्पन्न करें

परिणाम फ़ाइलों का एक गुच्छा होगा। चलो उन्हें क्रम में क्रमबद्ध करें:

• paymentssl.wsdl - सेवा का WSDL विवरण;
• t.xsd - हमारे द्वारा घोषित प्रकार (हमारे मामले में, हमारी t.xsd वहां मिलेगी);
• paymentssl.MakePayment.req.xml और paymentssl.MakePayment.res.xml - SOAP संदेशों के उदाहरण (अनुरोध और उत्तर दें) जो सेवा को स्वीकार / जारी करना होगा;
• soappaymentsslProxy.cpp और soappaymentsslProxy.h - क्लाइंट प्रॉक्सी कोड;
• soappaymentsslService.cpp और soappaymentsslService.h - सर्वर पार्ट कोड;
• paymentssl.nsmap - SOAP हेडर जेनरेट करते समय सर्वर और क्लाइंट द्वारा उपयोग किए जाने वाले स्थिरांक;
• soapC.cpp और soapH.h - सी संदेश पार्सर कोड;
• soapStub.h एक हेडर हिस्सा है जो सर्वर और क्लाइंट द्वारा उपयोग की जाने वाली कक्षाओं का वर्णन करता है।

यहाँ परिणामी WSDL विवरण कैसा दिखता है:


यह सर्वर प्रोग्रामिंग करने का समय है (सर्वर विवरण में एसएसएल स्ट्रिंग्स हैं, लेकिन हम एन्क्रिप्शन के बारे में बात नहीं करते हैं (लेकिन यह समर्थित है)।

प्रोग्राम करने योग्य सर्वर

एक खाली कंसोल एप्लिकेशन बनाएं जो Precompiled Headers का उपयोग नहीं करेगा। और हम उत्पन्न फ़ाइलों को प्रोजेक्ट में जोड़ते हैं।

परियोजना का रूप लेता है:


GSOAP कर्नेल फ़ाइलें भी इसमें जोड़ी जाती हैं: stdsoap2.cpp और stdsoap2.h ।

मैंने तुरंत PaymentServiceImpl वर्ग जोड़ा, जिसमें मैं सेवा को लागू करने की योजना बना रहा हूं।
सब कुछ इकट्ठा करने के लिए, फ़ंक्शन को निर्धारित करना आवश्यक है

 paymentsslService::MakePayment(int qty, t__result *result) 

यह आभासी है (लेकिन विशुद्ध रूप से आभासी नहीं है), और मेरा PaymentServiceImpl कार्यान्वयन PaymentServiceImpl paymentsslService से विरासत PaymentServiceImpl मिला है और इस ऑपरेशन को अधिभार देगा, इसलिए आपको इसे किसी तरह से स्टब के रूप में कहीं घोषित करने की आवश्यकता है:

 // //implementation for generated code always return FAIL. //This method will be override in PaymentServiceImpl class // int paymentsslService::MakePayment(int qty, t__result *result) { return SOAP_ERR; } 

स्थिर SOAP_ERR अन्य लोगों के बीच stdsoap2.h में परिभाषित किया गया है।

हम PaymentServiceImpl वर्ग में अतिभारित MakePayment फ़ंक्शन के कार्यान्वयन को भी जोड़ देंगे।

यह सेवा को संख्यात्मक कोड और पाठ संदेश के साथ ऑपरेशन की सफलता के बारे में संदेश लौटने का तर्क देने का समय है।

हमारे पास निम्नलिखित तर्क होंगे:
1) अगर मात्रा <0 है तो हम एक SOAP अपवाद (SOAP FAULT) फेंकते हैं
2) अगर मात्रा> 100 है तो हम "त्रुटि" संदेश के साथ विफल त्रुटि कोड लौटाते हैं
3) अन्यथा, त्रुटि कोड को ठीक करें और संदेश के बिना

अंतिम कार्यान्वयन:

 // PaymentServiceImpl.h #pragma once #include "Autogenerated/soappaymentsslService.h" class PaymentServiceImpl : public paymentsslService { public: virtual int MakePayment(int qty, t__result *result); }; // PaymentServiceImpl.cpp #include "PaymentServiceImpl.h" #include "Autogenerated/paymentssl.nsmap" /*virtual*/ int PaymentServiceImpl::MakePayment(int qty, t__result *result) { this->mode = this->mode | SOAP_C_UTFSTRING; if(qty<0) { this->soap_senderfault("error!", "<error xmlns=\"http://tempuri.org/\">The input parameter must be positive</error>"); return SOAP_CLI_FAULT; } if(qty>100){ result->errCode = STATE_FAIL; char err[] = "error (2)!"; int len=strlen(err); result->message = reinterpret_cast<char*>(soap_malloc(this, len+1)); strcpy_s(result->message, len+1, err); result->message[len] = '\0'; } return SOAP_OK; } 

यह सेवा शुरू करने और यह जांचने का समय है कि क्या यह कुछ भी देता है या सामान्य तौर पर हम सभी व्यर्थ गए।
मुख्य दर्ज करें:

 #include "PaymentServiceImpl.h" int _tmain(int argc, _TCHAR* argv[]) { const int SERVICE_PORT = 9999; std::auto_ptr<PaymentServiceImpl> srv (new PaymentServiceImpl()); if (srv->run(SERVICE_PORT)) { srv->soap_stream_fault(std::cerr); exit(-1); } return 0; } 

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

यह सत्यापन का समय है, जिसके लिए हमें एक ग्राहक की आवश्यकता है

हम एक ग्राहक बनाते हैं

प्रदर्शन के लिए, हम जल्दी से सी # क्लाइंट को स्केच करेंगे, यह बहुत सरल है (हालांकि सी ++ में यह अधिक जटिल नहीं है, मैं एकल प्रोटोकॉल का उपयोग करके डिसेमिलर टूल के संचार को दिखाने के लिए सी # का एक उदाहरण दिखाऊंगा (जिसके लिए SOAP खुद एक बार सोचा गया था))।

एक नया C # कंसोल प्रोजेक्ट जोड़ें, और फिर उसमें सेवा वापसी जोड़ें। हम पते के रूप में paymentssl.wsdl फ़ाइल के लिए पथ का संकेत देंगे।


प्रोजेक्ट गुणों में, यह इंगित करना न भूलें कि हम .Net4 का उपयोग कर रहे हैं, न कि .NET4 क्लाइंट प्रोफाइल फ्रेमवर्क।

यहाँ सत्यापन कोड है:

 var proxy = new PaymentService.paymentsslPortTypeClient(); string msg; var errCode = proxy.MakePayment(out msg, 10); 

//
// हाँ, स्टूडियो (या बल्कि svcutil उपयोगिता) की एक अजीब समझ है कि पैरामीटर क्या होना चाहिए,
// लेकिन विषय "अन्य प्रणालियों और gSOAP के साथ बातचीत" इस परिचय के लिए पर्याप्त व्यापक है
//


आपको जनरेट किए गए ऐप को भी ठीक करना होगा।

 <configuration> <system.serviceModel> <bindings> <customBinding> <binding name="paymentssl"> <textMessageEncoding messageVersion="Soap12" /> <httpTransport/> </binding> </customBinding> </bindings> <client> <endpoint address="http://localhost:9999" binding="customBinding" bindingConfiguration="paymentssl" contract="PaymentService.paymentsslPortType" name="paymentssl"/> </client> </system.serviceModel> <startup> <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/> </startup> </configuration> 

Voila, हमारे पास एक क्लाइंट है जो SOAP प्रोटोकॉल का उपयोग करके किसी सेवा को कॉल करना जानता है (आप इसे स्वयं जांच सकते हैं)।

जो मैंने नहीं बताया

• ओपनएसएसएल का उपयोग करके एसएसएल एन्क्रिप्शन
• उनके प्रमाण पत्र द्वारा ग्राहक प्राधिकरण
• सर्वर मल्टीथ्रेडिंग (अब यह एक एकल-थ्रेडेड संस्करण है)
• स्ट्रिंग एन्कोडिंग

यदि यह दिलचस्प है, तो शायद मैं इसे एक अलग पोस्ट में बताऊंगा (समय कैसे प्रकट होगा)।
सभी को धन्यवाद और SOAP के साथ शुभकामनाएं।