हम जावा में रेस्टफुल वेब सेवा को लागू करते हैं

सभी हब्रोज़िटेल को शुभ दिन!

इस लेख को लिखने का कारण यह था कि, मेरे बड़े आश्चर्य के कारण, मुझे हैबर पर एक लेख नहीं मिला। जावा में रेस्टफुल वेब सेवा को लागू करने के बारे में, शायद, मैंने खराब तरीके से खोजा। हां, रेस्टफुल वेब सेवाओं के बारे में बहुत कुछ लिखा गया है, लेकिन कुछ ऐसा है, जिससे कोड उदाहरणों के साथ, एक काम करने वाली सेवा को ढूंढना इतना आसान नहीं है, और केवल हब पर ही नहीं ...

सामान्य तौर पर, मैं REST से हाल ही में मिला, एक महीने से अधिक समय पहले नहीं। इसलिए मैं सलाह, सुधार और आलोचना के लिए बहुत आभारी रहूंगा!

यह पता लगाने के लिए आम तौर पर मुश्किल नहीं था, लेकिन मुझे लगता है कि एक समान पोस्ट मुझे बहुत मदद करेगी और सीखने की प्रक्रिया को बहुत तेज करेगी! इसके अलावा, यदि आप एक नौसिखिया डेवलपर हैं और सिर्फ बहुत कुछ के बारे में सुना है, लेकिन आपने इसे अपने हाथों से कभी नहीं छुआ।

मेरी पहली धारणा में: वास्तव में, यह बात बहुत सुविधाजनक है, और सबसे महत्वपूर्ण बात यह है कि अगर आप JSON का उपयोग करते हैं, और XML का भी उपयोग नहीं करते हैं, तो ठीक है, कम से कम यह मुझे SOAP और WSDL के साथ अनुभव के बाद लग रहा था। खैर, हां, मैं इसके बारे में सोचता हूं, और इसलिए हर कोई जानता है कि किसने कम से कम वेब सेवाओं के साथ थोड़ा काम किया है।

इसलिए, जो कार्यान्वयन में रुचि रखते हैं, मैं कटौती के लिए कहता हूं

आइए, हम तुरंत आरक्षण करें:

1. बेशक, आप लेख में सभी कोड नहीं डाल सकते हैं और आप इसके बारे में नहीं बताएंगे;
2. प्रक्षेपण संस्करण, ज़ाहिर है, अंतिम नहीं है और, जैसा कि मैंने ऊपर कहा था - मैं टिप्पणियों और सलाह के लिए बहुत आभारी रहूंगा;
3. बेशक, कीड़े हैं।

और हां, चलो क्रम में शुरू करते हैं:

1. प्रयुक्त सॉफ्टवेयर:

• Jdk 1.6
• Apache_CXF
• स्प्रिंग 3 फ्रेमवर्क JDBC
• Apache Tomcat 7.0
• MySQL 5.1
• ग्रहण 4.2 जून
• मावेन 3.0

सॉफ्टवेयर को एक बहुत ही सरल सिद्धांत के अनुसार चुना गया - जितना सरल उतना ही बेहतर। हां, डेटाबेस में जटिल प्रश्न करने की आवश्यकता के बिना लोड की गई सेवाओं के लिए MySQL के बजाय, MongoDB का उपयोग करना बहुत अच्छा है, ठीक है, कम से कम इस बारे में बहुत कुछ लिखा गया है, और फिर से इसका उपयोग करना अधिक सुविधाजनक है क्योंकि इनपुट समान JSON है ।

2. सिद्धांत रूप में, हमारी सेवा क्या करेगी - यहां सब कुछ बहुत ही सामान्य है: सेवा डेटाबेस में एक प्लेट के साथ काम करेगी - सम्मिलित करें, अपडेट करें, इसे हटाएं और, ज़ाहिर है, सूची या आईडी द्वारा रिकॉर्ड प्राप्त करें। बेशक, मैं रिकॉर्ड्स की एक सूची प्राप्त करने के लिए एक पैरामीटर क्वेरी करने में सक्षम होना चाहूंगा, सेवा के लिए "सुंदर" URL बनाना बुरा नहीं होगा, किसी तरह के इंटरसेप्टर को जकड़ना, उदाहरण के लिए, सेवा तक पहुंचने के लिए उपयोगकर्ता के अधिकारों की जांच करना, या कुछ और करना। सेवा शुरू करने से पहले, ठीक है, किसी भी तरह सर्वर से प्रतिक्रियाओं में त्रुटि कोड का प्रबंधन करें।

दरअसल, प्लेट:

CREATE TABLE `customer` ( `id` varchar(45) NOT NULL, `first_name` varchar(45) DEFAULT NULL, `last_name` varchar(45) DEFAULT NULL, `phone` varchar(45) DEFAULT NULL, `mail` varchar(45) DEFAULT NULL, `adress` varchar(45) DEFAULT NULL, `contract_id` varchar(45) DEFAULT NULL, `contract_expire_date` date DEFAULT NULL ) 

WS समापन बिंदु:

  1.http: //mysite.com/service/customer 

  2. http://mysite.com/service/customer/unningid} 

4 मानक स्थितियां जिन्हें हम अतिरिक्त रूप से संसाधित करेंगे (उदाहरण के लिए, प्रतिक्रिया में हमारी वेब सेवाओं का एक संस्करण जोड़ें, और यदि कोई त्रुटि होती है - हमारी त्रुटि कोड):

200 - सफल;
401 - अधिकृत नहीं;
404 - नहीं मिला;
500 - ऑपरेशन के दौरान सर्वर की त्रुटि।

3. कार्यान्वयन (जीथूब कोड यहां ):

हाँ, कोड, कम से कम टिप्पणी की, यहाँ एनोटेशन का विवरण।

स्वयं वेब सेवाएँ:

 public class CustomersServiceJSON implements ICustomersService { // link to our dao object private ICustomersDAO customersDAO; // for customersDAO bean property injection public ICustomersDAO getCustomersDAO() { return customersDAO; } public void setCustomersDAO(ICustomersDAO customersDAO) { this.customersDAO = customersDAO; } // for retrieving request headers from context // an injectable interface that provides access to HTTP header information. @Context private HttpHeaders requestHeaders; private String getHeaderVersion() { return requestHeaders.getRequestHeader("version").get(0); } // get by id service @GET @Path("/{id}") public Response getCustomer(@PathParam("id") String id) { Customer customer = customersDAO.getCustomer(id); if (customer != null) { return ResponseCreator.success(getHeaderVersion(), customer); } else { return ResponseCreator.error(404, Error.NOT_FOUND.getCode(), getHeaderVersion()); } } // remove row from the customers table according with passed id and returned // status message in body @DELETE @Path("/{id}") public Response removeCustomer(@PathParam("id") String id) { if (customersDAO.removeCustomer(id)) { return ResponseCreator.success(getHeaderVersion(), "removed"); } else { return ResponseCreator.success(getHeaderVersion(), "no such id"); } } // create row representing customer and returns created customer as // object->JSON structure @POST @Consumes(MediaType.APPLICATION_JSON) public Response createCustomer(Customer customer) { System.out.println("POST"); Customer creCustomer = customersDAO.createCustomer(customer); if (creCustomer != null) { return ResponseCreator.success(getHeaderVersion(), creCustomer); } else { return ResponseCreator.error(500, Error.SERVER_ERROR.getCode(), getHeaderVersion()); } } // update row and return previous version of row representing customer as // object->JSON structure @PUT @Consumes(MediaType.APPLICATION_JSON) public Response updateCustomer(Customer customer) { Customer updCustomer = customersDAO.updateCustomer(customer); if (updCustomer != null) { return ResponseCreator.success(getHeaderVersion(), updCustomer); } else { return ResponseCreator.error(500, Error.SERVER_ERROR.getCode(), getHeaderVersion()); } } // returns list of customers meeting query params @GET //@Produces(MediaType.APPLICATION_JSON) public Response getCustomers(@QueryParam("keyword") String keyword, @QueryParam("orderby") String orderBy, @QueryParam("order") String order, @QueryParam("pagenum") Integer pageNum, @QueryParam("pagesize") Integer pageSize) { CustomerListParameters parameters = new CustomerListParameters(); parameters.setKeyword(keyword); parameters.setPageNum(pageNum); parameters.setPageSize(pageSize); parameters.setOrderBy(orderBy); parameters.setOrder(Order.fromString(order)); List<Customer> listCust = customersDAO.getCustomersList(parameters); if (listCust != null) { GenericEntity<List<Customer>> entity = new GenericEntity<List<Customer>>( listCust) { }; return ResponseCreator.success(getHeaderVersion(), entity); } else { return ResponseCreator.error(404, Error.NOT_FOUND.getCode(), getHeaderVersion()); } } } 

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

सेवा से पहले जो चीज पूरी होती है उसे कहते हैं:

 public class PreInvokeHandler implements RequestHandler { // just for test int count = 0; private boolean validate(String ss_id) { // just for test // needs to implement count++; System.out.println("SessionID: " + ss_id); if (count == 1) { return false; } else { return true; } } public Response handleRequest(Message message, ClassResourceInfo arg1) { Map<String, List<String>> headers = CastUtils.cast((Map<?, ?>) message .get(Message.PROTOCOL_HEADERS)); if (headers.get("ss_id") != null && validate(headers.get("ss_id").get(0))) { // let request to continue return null; } else { // authentication failed, request the authentication, add the realm return ResponseCreator.error(401, Error.NOT_AUTHORIZED.getCode(), headers.get("version").get(0)); } } } 

यहां, मान्य () विधि में, आप कुछ पूर्व शर्त की जांच कर सकते हैं, पूरी तरह से परीक्षण के लिए, अनुरोध सत्र पहचानकर्ता "ss_id" में कस्टम हेडर का सत्यापन जोड़ा गया है, ठीक है, पहली बार 401 भी इस हेडर के साथ ड्रॉप होगा।

सामान्य अपवाद हैंडलर:

 public class CustomExceptionMapper implements ExceptionMapper<Exception> { @Context private HttpHeaders requestHeaders; private String getHeaderVersion() { return requestHeaders.getRequestHeader("version").get(0); } public Response toResponse(Exception ex) { System.out.println(ex.getMessage() + ex.getCause()); return ResponseCreator.error(500, Error.SERVER_ERROR.getCode(), getHeaderVersion()); } } 

पोस्ट के लिए कुछ पहले से ही थोड़ा अधिक कोड है, सर्वर के प्रति प्रतिक्रिया उत्पन्न करने के लिए एक सहायक वर्ग और हमारे त्रुटि कोड को संग्रहीत करने के लिए एक वैश्विक एनम है। हाँ, तैनाती विवरणक और सेम। Xml अभी भी यहाँ दिया जाएगा:

web.xml:

 ... <web-app> <display-name>service</display-name> <context-param> <param-name>contextConfigLocation</param-name> <param-value>WEB-INF/beans.xml</param-value> </context-param> <listener> <listener-class> org.springframework.web.context.ContextLoaderListener </listener-class> </listener> <servlet> <servlet-name>CXFServlet</servlet-name> <display-name>CXF Servlet</display-name> <servlet-class> org.apache.cxf.transport.servlet.CXFServlet </servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/*</url-pattern> </servlet-mapping> </web-app> 

यहां, मुख्य रुचि अपाचे - सीएक्सएफसर्वलेट और एक्शन स्प्रिंग कॉन्टेक्स्टेलैडेरलीनर से एक्शन सर्वलेट को जोड़ने के लिए है।

beans.xml:

 ... <!-- Imported resources for cxf --> <import resource="classpath:META-INF/cxf/cxf.xml" /> <import resource="classpath:META-INF/cxf/cxf-extension-jaxrs-binding.xml" /> <import resource="classpath:META-INF/cxf/cxf-servlet.xml" /> <!-- Imported bean for dao --> <import resource="classpath:META-INF/spring/dao.xml"/> <bean id="customersService" class="com.test.services.customers.rest.CustomersServiceJSON"> <property name="customersDAO" ref="customersDAO"/> </bean> <bean id="preInvokeHandler" class="com.test.services.rest.PreInvokeHandler" /> <bean id="customExceptionMapper" class="com.test.services.rest.CustomExceptionMapper" /> <jaxrs:server id="restContainer" address="/customer"> <jaxrs:serviceBeans> <ref bean="customersService" /> </jaxrs:serviceBeans> <jaxrs:providers> <ref bean="preInvokeHandler" /> <ref bean="customExceptionMapper" /> </jaxrs:providers> </jaxrs:server> ......... 

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

क्रोम के लिए मैंने REST कंसोल 4.0.2 प्लगइन का उपयोग की जाने वाली सेवाओं को चिकोटी देने के लिए - बात काफी सरल है, मुख्य बात यह है कि आवश्यक समापन बिंदु, कस्टम हेडर सेट करना है (जैसा कि मैंने कहा कि "ss_id" 401 के बिना हमेशा गिर जाएगा) और सामग्री प्रकार। एक उदाहरण के लिए:

अनुरोध निकाय:

 Request Url: http://localhost:8080/service/customer Request Method: GET Status Code: 200 

अनुरोध शीर्षलेख:

 Accept: application/json Content-Type: application/json ss_id: 12312.111 version: 12312.111 ........ 

प्रतिक्रिया शीर्षलेख:

 Status Code: 200 Date: Tue, 21 Aug 2012 13:09:45 GMT Content-Length: 877 Server: Apache-Coyote/1.1 Content-Type: application/json version: 12312.111 

प्रतिक्रिया शरीर:

 { "customer": [{ "id": "89ad5a46-c9a2-493f-a583-d8250ee31766", "adress": "null", "contract_id": "null", "first_name": "serg", "last_name": "serg", "mail": "serg", "phone": "null" }, { "id": "300ff688-a783-4e6a-9048-8bb625128dc0", "first_name": "serg" }, { "id": "67731ab9-87b1-4ff9-a7e4-618c1f9e8c4c", "first_name": "serg" }, { "id": "cd5039bb-031f-4697-a70c-ad3e628963dd", "first_name": "serg" }, { "id": "86da5446-7439-4242-b730-31c8b57a5c7d", "first_name": "serg" }, .......... 

और आखिरी, मैं एक "सुंदर" होना चाहता था, हम बेहतर यह कहते हैं कि हमें वेब सेवाओं के लिए आवश्यक URL चाहिए। बेशक, आप server.xml को ठीक कर सकते हैं या urlRewrite के लिए कुछ टूल का उपयोग कर सकते हैं, लेकिन मेरी राय में हमारे वेब संग्रह को कान में पैक करना और application.xml में हमारी वेब सेवाओं के लिए एक अलग रूट सेट करना है, लेकिन इस पोस्ट के हिस्से के रूप में मैं मैंने पहले ही ऐसा नहीं किया था।

पुनश्च: मुझे आशा है कि यह पोस्ट उन लोगों के लिए उपयोगी होगी जो जावा रेस्टफुल वेब सेवाओं से परिचित होना चाहते हैं, और अधिक अनुभवी लोग सलाह और आलोचना करेंगे!