JAX-RS मूल बातें

परिचय

यह एपीआई JSR 311: JAX-RS: द रैस्टफुल वेब सर्विसेज के लिए जावा एपीआई और जावा ईई 6 (जावा ईई 5 में योजनाबद्ध) में शामिल था। जैसा कि नाम से ही स्पष्ट है, इसे रेस्टफुल वेब सेवाओं के विकास के लिए बनाया गया है।

इस लेख का मुख्य उद्देश्य पाठक को JAX-RS API की मूल बातों से परिचित कराना है। प्रारंभ में, मैंने JAX-RS सेवा का उपयोग करके रूपों के काम के साथ कुछ समस्याओं के बारे में लिखने की योजना बनाई। इस तकनीक के बारे में Habré से संबंधित लगभग कुछ भी नहीं मिला, मुझे एहसास हुआ कि मैं लेख के परिचय से छुटकारा पाने में सफल नहीं होऊंगा।

JAX-RS एपीआई की मूल बातें, JBoss से एक कार्यान्वयन प्रस्तुत किया जाएगा और रेस्टसी ढांचे के ग्राहक भाग के लिए एक छोटा सा परिचय दिया जाएगा।


यह javax.ws.rs। * में कक्षाओं के एक सेट द्वारा दर्शाया गया है । पर्यावरण द्वारा प्रदान किए गए आधुनिक AppServers के मामले में (आप maven में <scope>provided</scope> का उपयोग कर सकते हैं। सर्वलेट कंटेनर में अनुप्रयोगों के लिए कई कार्यान्वयन हैं:

• Apache CXF (कन्या में प्रयुक्त - स्प्रिंग डीएम सर्वर का उत्तराधिकारी),
• सन / ओरेकल जर्सी (वर्तमान आरआई, ग्लासफिश में प्रयुक्त),
• JBoss रेस्टसी (JBoss 7 में प्रयुक्त),
• Restlet ।

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

 package com.example; import javax.ws.rs.*; @Path("/") public interface RestService { @GET @Path("echo") String echo(@QueryParam("q") String original); } 

और कार्यान्वयन:

 package com.example; import javax.enterprise.ApplicationScoped; import javax.ws.rs.*; @ApplicationScoped @Path("/") public class Rest implements RestService{ @GET @Path("echo") @Override public String echo(@QueryParam("q") String original) { return original; } } 

बीन दोनों ही और इसके तरीकों को इसके व्यवहार का वर्णन करने वाले एनोटेशन के साथ पूरक किया जाता है: @Path , उदाहरण के लिए, इस संसाधन के सापेक्ष या निरपेक्ष पथ को इंगित करता है; एनोटेशन ग्रुप @GET , @POST , @PUT , @DELETE इस विधि के लिए प्रासंगिक HTTP अनुरोध के प्रकार के लिए जिम्मेदार है।

क्रमबद्धता

जाहिर है, मनमाने डेटा के हस्तांतरण के लिए, क्रमांकन आवश्यक है - बाइट्स के एक सेट में ऑब्जेक्ट प्रतिनिधित्व से डेटा का अनुवाद। मैं रेस्टसी पर एक नजर के साथ कहानी जारी रखूंगा।
इस मामले में, विशेष प्रदाताओं का उपयोग क्रमांकन / डिसेरिएलाइज़ेशन के लिए किया जाता है। परिणाम / डेटा सामग्री के MIME-प्रकार को इंगित करने के लिए @Produces और @Consumes का उपयोग किया जाता है। तदनुसार, डेटा क्लास को JAXB द्वारा एनोटेट किया जाना चाहिए। JBoss AS 7 में मानक प्रदाता resteasy-jaxb- प्रदाता (xml-marshaller / unmarshaller) और resteasy-jettison-provider (json) हैं। ये दो प्रदाता आपको बड़ी संख्या में बाहरी सेवाओं के साथ एकीकृत करने की अनुमति देते हैं, ताकि एक्सएमएल और JSON एपीआई को बाहर की ओर प्रदान किया जा सके।

कस्टम जवाब

यदि हम गैर-मानक प्रतिक्रिया या HTTP कोड वापस करना चाहते हैं तो क्या होगा? एनोटेट JAX-RS विधि से अपवाद के साथ, परिणाम 500 त्रुटि होगा। अनुकूलन के लिए, यह javax.ws.rs.core.Response को निर्दिष्ट करने के लिए पर्याप्त है javax.ws.rs.core.Response लौटे प्रकार के अनुसार।

 @GET @Path("file/get/{name}") Response getFile(@PathParam("file") String fileName) { if(!Files.exists(Paths.get(fileName)) { return Response.status(422).entity("I'm a teapot"); } else { Response.Builder response = Response.ok(); response.header("X-Some-Server-Header", "value"); response.entity(new StreamingOutput() { @Override public void write(OutputStream outputStream) throws IOException, WebApplicationException { Files.copy(Paths.get(fileName), outputStream); } }); return response.build(); } } 

ग्राहक की रूपरेखा

JBoss Resteasy के बारे में दूसरी अच्छी बात एक सुविधाजनक ग्राहक ढांचे की उपस्थिति है। इसके साथ कार्य अमूर्तता के विभिन्न स्तरों पर संभव है: निम्न-स्तर के ClientRequest , ClientResponse<T> और एनोटेट जेएएक्स-आरएस इंटरफेस के माध्यम से प्रॉक्सी ऑब्जेक्ट की पीढ़ी के साथ समाप्त। उदाहरण के लिए, पहले उदाहरण से RestService इंटरफ़ेस का उपयोग करना:

 RestService service = ProxyFactory.create(RestService.class, "http://localhost:8080/example"); log.info(service.echo("test message")); 

लेकिन कभी-कभी यह पर्याप्त नहीं होता है। उदाहरण के लिए, इस मामले में, जब सर्वर-साइड त्रुटि होती है, तो प्रॉक्सी अपवाद छोड़ देता है। काम के निचले स्तर के लिए, ClientRequest / ClientResponse<T> का उपयोग अपाचे httpcompenders (Resteasy 2.3.x.GA में) या Apache-httpclient (2.2.x.GA में) का उपयोग करके किया जा सकता है। उपयोग का एक उदाहरण इस प्रकार है:

 ClientRequest request = new ClientRequest(url); request.header("X-Additional-Header", "header value"); //     : GET, POST, PUT, DELETE ClientResponse<String> response = request.get(String.class); if(response.getCode() == 200) { String result = response.getEntity(); log.info(result); } 

UPD: क्लाइंट फ्रेमवर्क का उपयोग करने के मामले में, प्रोग्राम शुरू करते समय इसे एक बार इनिशियलाइज़ करना आवश्यक है:

 RegisterBuiltin.register(ResteasyProviderFactory.getInstance()); 

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

UPD: यहां निरंतर देखें