Apache CXF और स्प्रिंग के साथ जावा सोप सर्वर

हाल ही में, कई लेख सामने आए हैं जो SOAP प्रोटोकॉल के बारे में बात करते हैं, साथ ही विभिन्न भाषाओं और प्लेटफार्मों में एक सर्वर बनाने की प्रक्रिया का वर्णन करते हैं। हम विषय जारी रखते हैं। यह आलेख वर्णन करेगा कि Apache CXF और स्प्रिंग फ्रेमवर्क का उपयोग करके जावा सर्वर कैसे बनाया जाए। यह माना जाता है कि पाठक को पहले से वर्णित प्रोटोकॉल की सामान्य समझ है, साथ ही साथ चींटी और मावेन के साथ काम करना। कार्य को थोड़ा और दिलचस्प बनाने के लिए, हम प्रारंभिक स्थिति जोड़ते हैं: वेब सेवा का वर्णन करते हुए एक डब्ल्यूएसडीएल योजना दी गई है। इसलिए ...
( विकिपीडिया पर एक लेख से छवि।)

0. प्रारंभिक शर्तें

जो कार्य हम के लिए निर्धारित किया गया था: यह एक वेब सेवा को लागू करने के लिए आवश्यक है जो एसओएपी 1.1 विनिर्देश को पूरा करता है , जो एक तैयार डब्ल्यूएसडीएल योजना पर आधारित है। "लिफाफे" को प्रसारित करने के लिए एक प्रोटोकॉल के रूप में हम HTTP का उपयोग करेंगे। इस प्रकार, हमारे कार्य को दो घटकों में विभाजित किया जा सकता है:

• डब्लूएसडीएल योजना के आधार पर जावा इंटरफ़ेस का निर्माण;
• परिणामी इंटरफ़ेस के आधार पर एक वेब सेवा का कार्यान्वयन।

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

यह मूल WSDL योजना जैसा दिखता है:

<?xml version="1.0" encoding="UTF-8"?> <wsdl:definitions name="CurrentTimeService" targetNamespace="http://artspb.me/cts" xmlns:tns="http://artspb.me/cts" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"> <wsdl:types> <xsd:schema targetNamespace="http://artspb.me/cts"> <xsd:element name="timeZoneId" nillable="true" type="xsd:string"/> <xsd:element name="currentTime" type="xsd:dateTime"/> </xsd:schema> </wsdl:types> <wsdl:message name="getCurrentTimeMsg"> <wsdl:part element="tns:timeZoneId" name="timeZoneId"/> </wsdl:message> <wsdl:message name="currentTimeMsg"> <wsdl:part element="tns:currentTime" name="currentTime"/> </wsdl:message> <wsdl:portType name="CurrentTimeService"> <wsdl:operation name="getCurrentTime"> <wsdl:input message="tns:getCurrentTimeMsg" name="getCurrentTime"/> <wsdl:output message="tns:currentTimeMsg" name="currentTime"/> </wsdl:operation> </wsdl:portType> <wsdl:binding name="CurrentTimeService_HttpBinding" type="tns:CurrentTimeService"> <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/> <wsdl:operation name="getCurrentTime"> <soap:operation soapAction="http://artspb.me/cts" style="document"/> <wsdl:input name="getCurrentTime"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="currentTime"> <soap:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:service name="CurrentTimeService_HttpService"> <wsdl:port binding="tns:CurrentTimeService_HttpBinding" name="CurrentTimeService_HttpPort"> <soap:address location="http://localhost:8080/YetAnotherService/service/currentTimeService"/> </wsdl:port> </wsdl:service> </wsdl:definitions> 

सेवा की एक बहुत ही सरल कार्यक्षमता है: यह वर्तमान समय को निर्दिष्ट समय क्षेत्र में लौटाता है। बेल्ट निर्दिष्ट नहीं होने की स्थिति में, सेवा वर्तमान सर्वर समय लौटाती है।

इस प्रक्रिया में, हम निम्नलिखित उपकरणों का उपयोग करेंगे:

• अपाचे सीएक्सएफ ;
• अपाचे मावेन
• अपाचे चींटी ;
• अपाचे टोमाकट
• साबुन बनाने की मशीन ।

सभी एक साथ IntelliJ IDEA के साथ उपयोग करने के लिए बहुत सुविधाजनक हैं, लेकिन यह उपकरण वैकल्पिक है।

परियोजना की संरचना

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

पोम-फाइलों में हम मॉड्यूल के लिए आवश्यक निर्भरता दर्शाते हैं। हमारे पास कई बाहरी निर्भरताएं नहीं होंगी: स्प्रिंग-वेब, लॉग 4 जे, cxf-rt-frontend-jaxws और cxf-rt-transports-http - ये सभी http://repo1.maven.org.maven2 पर उपलब्ध हैं।

1. डब्लूएसडीएल-स्कीम के आधार पर जावा-इंटरफेस का निर्माण

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

 <?xml version="1.0"?> <project name="BuildObject"> <property name="cxf.home" value="/home/art/tools/apache-cxf-2.5.2"/> <path id="cxf.classpath"> <fileset dir="${cxf.home}/lib"> <include name="*.jar"/> </fileset> </path> <target name="cxfWSDLToJava"> <java classname="org.apache.cxf.tools.wsdlto.WSDLToJava" fork="true"> <arg value="-verbose"/> <arg value="-d"/> <arg value="../ObjectLibrary/src/main/java"/> <arg value="../ObjectLibrary/src/main/resources/CurrentTimeService.wsdl"/> <classpath> <path refid="cxf.classpath"/> </classpath> </java> </target> <target name="regenerate.object.library"> <delete dir="../ObjectLibrary/src/main/java"/> <antcall target="cxfWSDLToJava"/> </target> </project> 

इस स्क्रिप्ट को बिल्ड / बिल्ड.xml फ़ाइल में रखें। टास्क regenerate.object.library को रन करें, जिसके परिणामस्वरूप ObjectLibrary फ़ोल्डर में हमें वह इंटरफ़ेस मिलता है जिसकी हमें आवश्यकता होती है।

 package me.artspb.cts; import javax.jws.WebMethod; import javax.jws.WebParam; import javax.jws.WebResult; import javax.jws.WebService; import javax.jws.soap.SOAPBinding; import javax.xml.bind.annotation.XmlSeeAlso; /** * This class was generated by Apache CXF 2.5.2 * 2012-02-02T17:39:35.466+04:00 * Generated source version: 2.5.2 * */ @WebService(targetNamespace = "http://artspb.me/cts", name = "CurrentTimeService") @XmlSeeAlso({ObjectFactory.class}) @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE) public interface CurrentTimeService { @WebResult(name = "currentTime", targetNamespace = "http://artspb.me/cts", partName = "currentTime") @WebMethod(action = "http://artspb.me/cts") public javax.xml.datatype.XMLGregorianCalendar getCurrentTime( @WebParam(partName = "timeZoneId", name = "timeZoneId", targetNamespace = "http://artspb.me/cts") java.lang.String timeZoneId ); } 

यह ध्यान में रखा जाना चाहिए कि wsdl2java उपयोगिता की मदद से हम तुरंत तैयार सर्वर (-सेवर स्विच) और यहां तक ​​कि इसके लिए कार्यान्वयन लागू कर सकते हैं (-impl स्विच)। हालांकि, इस लेख के ढांचे में, हम इसका उपयोग केवल उस इंटरफ़ेस को प्राप्त करने के लिए करेंगे जिसकी आवश्यकता हमें उत्पन्न कोड से तंग बंधन से बचने के लिए है।

2. परिणामी इंटरफेस के आधार पर एक वेब सेवा को लागू करना

हम उसी नाम के मॉड्यूल में CurrentTimeService इंटरफ़ेस के कार्यान्वयन को जगह देंगे। कोड सीधा है और अतिरिक्त टिप्पणियों की आवश्यकता नहीं है।

 package me.artspb.cts; import org.apache.log4j.Logger; import javax.jws.WebParam; import javax.xml.datatype.DatatypeConfigurationException; import javax.xml.datatype.DatatypeFactory; import javax.xml.datatype.XMLGregorianCalendar; import java.util.GregorianCalendar; import java.util.TimeZone; public class CurrentTimeServiceImpl implements CurrentTimeService { private Logger logger = Logger.getLogger(CurrentTimeServiceImpl.class); public XMLGregorianCalendar getCurrentTime( @WebParam(partName = "timeZoneId", name = "timeZoneId", targetNamespace = "http://artspb.me/cts") String timeZoneId) { logger.debug("Operation getCurrentTime was requested."); XMLGregorianCalendar gregorianCalendar; try { gregorianCalendar = getXmlGregorianCalendar(timeZoneId); } catch (DatatypeConfigurationException e) { throw new RuntimeException(e); } logger.debug("Successful."); return gregorianCalendar; } private XMLGregorianCalendar getXmlGregorianCalendar(String id) throws DatatypeConfigurationException { TimeZone timeZone; if (!"".equals(id)) { logger.debug("TimeZoneId isn't null: " + id); timeZone = TimeZone.getTimeZone(id); } else { logger.debug("TimeZoneId is null. Will use default value."); timeZone = TimeZone.getDefault(); } GregorianCalendar gregorianCalendar = new GregorianCalendar(timeZone); return DatatypeFactory.newInstance().newXMLGregorianCalendar(gregorianCalendar); } } 

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

3. विधानसभा और निरीक्षण

परियोजना का निर्माण करने के लिए, हम मावेन "पैकेज" कार्य करेंगे। Tomcat सर्वर पर परिणामी युद्ध फ़ाइल तैनात करें। हम मानते हैं कि यह पोर्ट 8080 पर उपलब्ध है।



जांच करने के लिए, हम साबुनयूआई कार्यक्रम का उपयोग करते हैं। सेवा की डब्लूएसडीएल योजना http: // localhost: 8080 / CurrentTimeService / Service /TimeTimeService? Wsdl पर उपलब्ध है , इसका उपयोग करके हम एक नई साबुन परियोजना बना सकते हैं।

हम एक अनुरोध भेजते हैं:

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cts="http://artspb.me/cts"> <soapenv:Header/> <soapenv:Body> <cts:timeZoneId>PST</cts:timeZoneId> </soapenv:Body> </soapenv:Envelope> 

हमें जवाब मिलता है:

 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <currentTime xmlns="http://artspb.me/cts">2012-02-02T08:48:24.402-08:00</currentTime> </soap:Body> </soap:Envelope> 

एक निष्कर्ष के बजाय

कार्य प्राप्त किया गया है: वेब सेवा अनुरोधों को सही ढंग से संसाधित करती है। हम जनरेट किए गए कार्यान्वयन के लिए "तंग" बंधन से बचने में भी कामयाब रहे, जो कोड को अधिक लचीला बनाता है और आपको आगे बदलाव करने में कम प्रयास करने की अनुमति देता है।

सौभाग्य!

एक साथ मुख्य लिंक:

• ड्रॉपबॉक्स स्रोत कोड
• विकिपीडिया पर SOAP ;
• विकिपीडिया पर WSDL ;
• डब्लूएसडीएल टू जावा ;
• वसंत के साथ एक सेवा लिखना ।