🖨️ 👩‍💼 🏇🏾 ग्रहण + जर्सी + ग्लासफिश 3 का उपयोग करके जावा में एक प्रतिष्ठित वेब सेवा बनाएं 👨🏿‍⚖️ 🤛🏾 😴

सभी को शुभ संध्या!

बहुत पहले नहीं (इस साल के फरवरी में), मैंने प्रोग्रामिंग करने का फैसला किया। जावा को भाषा के रूप में चुना गया था। और उस क्षण से मैं लगातार इस भाषा की सभी संभावनाओं का अध्ययन करता हूं। हाल ही में मैं एक हब पर RESTful के बारे में एक लेख आया मैंने पढ़ा और महसूस किया कि मुझे इन सेवाओं को बनाने के लिए एक वैकल्पिक तरीके पर प्रकाश डालने की आवश्यकता है। इसने मुझ पर भी प्रहार किया कि शुरुआती लेखों के लिए कुछ लेख कैसे लिखे गए थे। मैंने एक लेख लिखने का फैसला किया जिसमें मैं वेब सेवा बनाने के अनुप्रयोग भाग के बारे में बात करूंगा।

मैं सच होने का दिखावा नहीं करता। मैं केवल एक वेब सेवा बनाने के लिए एक सरल और त्वरित तरीका दिखाना चाहता हूं।

शुरुआत

आवश्यक सॉफ्टवेयर

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

परियोजना निर्माण

So. हमारे पास ग्रहण, जर्सी जार फ़ोल्डर और ग्लासफिश प्लगइन स्थापित है। अब एक्लिप्स चलाएं और अंतिम टैब पर एक खाली डायनेमिक वेब प्रोजेक्ट बनाएं, चेकबॉक्स को चेक करना न भूलें, जो कि web.xml फ़ाइल बनाने के लिए जिम्मेदार है।

ग्रहण हमारे लिए एक खाली परियोजना बनाएगा, जिसे आप पहले से ही हमारे सर्वर पर चला सकते हैं (Run As -> Run On Server)।
लॉन्च होने के बाद, एक अंतर्निहित ब्राउज़र हैलो वर्ल्ड पेज दिखाई देगा और प्रदर्शित करेगा। अब आपको जर्सी JAR फ़ाइलों को [ प्रोजेक्ट नाम ] / WebContent / WEB-INF / lib फ़ोल्डर में कॉपी करने की आवश्यकता है। इस प्रकार, हम सभी आवश्यक पुस्तकालयों को जोड़ देंगे। अब web.xml फ़ाइल की बारी है। यह [ प्रोजेक्ट नाम ] / WebContent / WEB-INF में स्थित है ।
यहाँ इस फ़ाइल की एक सूची दी गई है

<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5"> <display-name>WebRest</display-name> <servlet> <servlet-name>Jersey REST Service</servlet-name> <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class> <init-param> <param-name>com.sun.jersey.config.property.packages</param-name> <param-value>ru.example.rest.resource</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>Jersey REST Service</servlet-name> <url-pattern>/rest/*</url-pattern> </servlet-mapping> </web-app>

पैरामीटर com.sun.jersey.config.property.packages को हमारे साथ उस पैकेज को इंगित करना चाहिए जिसमें हमारी संसाधन फ़ाइलों को संग्रहीत किया जाएगा। और url- पैटर्न टैग हमारी वेब सेवा के लिए पथ संग्रहीत करता है। मुझे लगता है कि आपको यह नहीं कहना चाहिए कि यह Restful वेब सेवाओं का एक मौलिक क्षण है, क्योंकि इसकी विचारधारा खुद कहती है कि प्रत्येक संसाधन का अपना पता होना चाहिए। अब हमारी वेब सेवा लोकलहोस्ट पर उपलब्ध है: 8080 / [ हमारी परियोजना का नाम ] / बाकी /। यह हमारा आधार यूआरआई होगा।

वेब सेवा निर्माण

इकाई निर्माण

एक उदाहरण के रूप में, मैं एक साधारण वेब-सेविरिस देना चाहता था, जो इस तरह की एक मिनी डायरी है। यानी हमारे पास एक प्रकार की संदेश संस्थाएँ हैं और हम इसके साथ काम करेंगे।

यहां मैसेज क्लास है

 package ru.example.rest.entity; import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement public class Message { private long messageId; private String messageTitle; private String messageText; public Message() { } public Message(long messageId, String messageTitle, String messageText) { this.messageId = messageId; this.messageTitle = messageTitle; this.messageText = messageText; } public long getMessageId() { return messageId; } public void setMessageId(long messageId) { this.messageId = messageId; } public String getMessageTitle() { return messageTitle; } public void setMessageTitle(String messageTitle) { this.messageTitle = messageTitle; } public String getMessageText() { return messageText; } public void setMessageText(String messageText) { this.messageText = messageText; } @Override public String toString() { return "Message [messageId=" + messageId + ", messageTitle=" + messageTitle + ", messageText=" + messageText + "]"; } }

केवल एक चीज जो यहां सवाल उठा सकती है वह है @XmlRootElement एनोटेशन। हमें इसकी आवश्यकता है ताकि जावा स्वयं इस वर्ग को HTTP के माध्यम से ट्रांसमिशन के लिए XML प्रारूप में परिवर्तित कर दे। बाकी तीन क्षेत्रों के साथ एक नियमित वर्ग है। संदेश संदेश, शीर्षक संदेश और पाठ संदेश।

हमारी कक्षा के साथ काम करने के लिए एक मॉडल बनाना

सामग्री प्रदाता के रूप में, मैंने सामान्य सूची का उपयोग करने का निर्णय लिया। इस स्तर पर, मैं ओआरएम में गहराई से नहीं जाना चाहता हूं और डेटाबेस तालिकाओं में डेटा संग्रहीत कर रहा हूं, क्योंकि यह विषय एक अलग लेख के योग्य है, जो अगले हो सकता है। और इसलिए मैंने एक उपयोगिता वर्ग बनाया जो हमारे संदेशों की सूची संग्रहीत करेगा और इस शीट के साथ काम करने के तरीके प्रदान करेगा।

यहां डेटा वर्ग की एक सूची दी गई है

 package ru.example.rest.model; import java.util.ArrayList; import java.util.List; import ru.example.rest.entity.Message; public class Data { private static List<Message> data; private static long count = 5; static { data = new ArrayList<Message>(); data.add(new Message(1L, "Hello", "Hello! I'm first entry!")); data.add(new Message(2L, "2nd", "second messages")); data.add(new Message(3L, "here again!", "some text")); data.add(new Message(4L, "HI!", "pam param")); } public static List<Message> getData() { return data; } public static Message findMessageById(long id) { for (Message message : data) { if (message.getMessageId() == id) { return message; } } return null; } public static boolean deleteMessageById(long id) { boolean result = false; for (Message message : data) { if (message.getMessageId() == id) { result = data.remove(message); return result; } } return result; } public static boolean updateMessage(Message message) { boolean result = false; for (Message temp: data) { if (temp.getMessageId() == message.getMessageId()) { temp.setMessageText(message.getMessageText()); temp.setMessageTitle(message.getMessageTitle()); result = true; } } return result; } public static boolean addMesage(Message message) { message.setMessageId(count); count++; return data.add(message); } }

यहां हम केवल एक सूची बनाते हैं और इसे कुछ प्रविष्टियों के साथ आबाद करते हैं। अगला, getData () विधि हमें सूची के लिए एक लिंक देती है। अन्य तरीकों से उनके नामों का अनुमान लगाना आसान है।

अब सेवा ही

सेवा अपने आप में एक संसाधन वर्ग है, जिसमें एनोटेशन होता है, जो यह बताता है कि URI किस संसाधन या अनुरोध के प्रकार के आधार पर क्या कार्रवाई करेगा। मुख्य एनोटेशन हैं
पथ ("इस संसाधन के लिए पथ") यह एनोटेशन किसी विशिष्ट वर्ग या विधि पते को इंगित करता है।
पथ का एक रूपांतर भी है ("{id}") जो हमें बताता है कि आईडी एक परिवर्तनशील है जिसे हम अपनी विधि में पास कर सकते हैं।
खपत (मीडिया टाइप) और प्रोड्यूस (मीडिया टाइप) हमें क्रमशः प्राप्त और भेजे गए डेटा के बारे में बताएंगे। हमारे मामले में, मैंने APPLICATION_XML का चयन किया। JSON क्यों नहीं पूछें, यह मेरे लिए बहुत आसान है। कोई आश्चर्य नहीं कि वे JAX-Bind के साथ आए थे।
GET - का कहना है कि यह विधि ग्राहक को सेवा से डेटा भेज देगी।
PUT / POST - का कहना है कि यह विधि हमारी सेवा में डेटा जोड़ेगी / अपडेट करेगी।
व्यक्तिगत रूप से, मैं अपडेट करने के लिए और पोस्ट को जोड़ने के लिए PUT का उपयोग करता हूं।
DELETE - कहता है कि यह विधि हमारे संग्रहण से डेटा हटा देगी

यहाँ संसाधन वर्ग की एक सूची दी गई है
पैकेज ru.example.rest.resource;

 import java.util.List; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; import javax.ws.rs.GET; import javax.ws.rs.POST; import javax.ws.rs.PUT; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; import javax.xml.bind.JAXBElement; import ru.example.rest.entity.Message; import ru.example.rest.model.Data; @Path("message") public class MessageResource { @GET @Produces(MediaType.APPLICATION_XML) public List<Message> getAllMessages() { List<Message> messages = Data.getData(); if (messages == null) { throw new RuntimeException("Can't load all messages"); } return messages; } @GET @Path("{id}") @Produces(MediaType.APPLICATION_XML) public Message getMessageById(@PathParam("id") long id) { Message message = Data.findMessageById(id); if (message == null) { throw new RuntimeException("can't find mesage with id = " + id); } return message; } @PUT @Consumes(MediaType.APPLICATION_XML) public void addMessage(JAXBElement<Message> message) { if (Data.addMesage(message.getValue()) != true) { throw new RuntimeException("can't add mesage with id = " + message.getValue().getMessageId()); } } @DELETE @Path("{id}") public void deleteMessage(@PathParam("id") long id) { if (Data.deleteMessageById(id) != true) { throw new RuntimeException("can't delete mesage with id = " + id); } } @POST @Consumes(MediaType.APPLICATION_XML) public void updateMessage(JAXBElement<Message> message) { if (Data.updateMessage(message.getValue()) != true) { throw new RuntimeException("can't update mesage with id = " + message.getValue().getMessageId()); } } }

मुझे लगता है कि यह कुछ बिंदुओं को स्पष्ट करने के लायक है। हमारा संसाधन वर्ग लोकलहोस्ट पर उपलब्ध होगा: 8080 / [ परियोजना का नाम ] / बाकी / संदेश जब एक GET प्रकार का अनुरोध करते हैं, तो हमें सभी रिकॉर्डों की एक सूची मिलेगी। जब संदेश पैरामीटर के साथ POST का अनुरोध किया जाता है, तो संदेश तत्व अपडेट किया जाएगा। संदेश पैरामीटर के साथ एक PUT प्रकार का अनुरोध करते समय, हम अपने डेटा वेयरहाउस में एक नया संदेश जोड़ेंगे। जीईटी लोकलहोस्ट : 8080 / [ प्रोजेक्ट नाम ] / रेस्ट / मैसेज / आईडी जैसी विधि का उपयोग करते हुए एक पते पर पहुंचते समय, हम आईडी के बराबर एक नंबर के साथ एक संदेश लौटाएंगे। और अगर आप DELETE मेथड भी कहते हैं, तो आईडी नंबर वाला मैसेज डिलीट हो जाएगा।

निष्कर्ष

छोटे ग्राहक उदाहरण

इस सेवा का परीक्षण करने के लिए, मैंने एक छोटा जावा क्लाइंट लिखा। एक नियमित जावा एप्लिकेशन जो सभी विधियों को कॉल प्रदर्शित करता है और कंसोल को परिणाम प्रदर्शित करता है।

यहाँ उसकी लिस्टिंग है

 public class RestClient { public static void main(String[] args) { ClientConfig config = new DefaultClientConfig(); Client client = Client.create(config); WebResource service = client.resource(getBaseURI()); /* * Get list of messages */ GenericType<List<Message>> genericType = new GenericType<List<Message>>() { }; List<Message> messages = service.path("rest").path("message") .accept(MediaType.APPLICATION_XML).get(genericType); for (Message temp : messages) { System.out.println(temp); } /* * Get message by ID */ long id = 4; Message message = service.path("rest").path("message") .path(String.valueOf(id)).accept(MediaType.APPLICATION_XML) .get(Message.class); System.out.println("Message with ID = " + id); System.out.println(message); /* * Update message */ message.setMessageTitle("udated title"); message.setMessageText("updated text"); service.path("rest").path("message").post(message); message = service.path("rest").path("message").path(String.valueOf(id)) .accept(MediaType.APPLICATION_XML).get(Message.class); System.out.println("Message with ID = " + id); System.out.println(message); /* * Delete message */ System.out.println("delete message with ID = " + id); service.path("rest").path("message").path(String.valueOf(id)).delete(); messages = service.path("rest").path("message") .accept(MediaType.APPLICATION_XML).get(genericType); for (Message temp : messages) { System.out.println(temp); } /* * Put message */ System.out.println("puttin' message"); message = new Message(); message.setMessageText("PUT MESSAGE!"); message.setMessageTitle("Put message"); service.path("rest").path("message") .accept(MediaType.APPLICATION_XHTML_XML).put(message); messages = service.path("rest").path("message") .accept(MediaType.APPLICATION_XML).get(genericType); for (Message temp : messages) { System.out.println(temp); } } private static URI getBaseURI() { return UriBuilder.fromUri("http://localhost:8080/WebRest").build(); } }

यहाँ सबसे दिलचस्प लाइनें हैं

 GenericType<List<Message>> genericType = new GenericType<List<Message>>() {}; List<Message> messages = service.path("rest").path("message") .accept(MediaType.APPLICATION_XML).get(genericType);

जेनेरिक टाइप मोटे तौर पर एक सूची प्रकार है, इसे JAX-B का उपयोग करके अधिक जटिल संरचनाएं भेजने और प्राप्त करने की आवश्यकता है। और सभी डेटा जो हम JAXBElement के रूप में पास करते हैं।

इस क्लाइंट में, आपको जर्सी लाइब्रेरीज़ को भी शामिल करना होगा और मैसेज क्लास के लिए विवरण फ़ाइल शामिल करनी होगी।

और निष्कर्ष में

अंत में, मैं यह कहना चाहूंगा कि यदि यह लेख किसी की मदद करता है तो मुझे बहुत खुशी होगी। मैं किसी भी सुझाव और किसी भी आलोचना को सुनने के लिए तैयार हूं। मैं अभी सीख रहा हूँ

क्लाइंट कोड और सर्विस कोड मेरे github HERE पर उपलब्ध हैं।

मेरे द्वारा उपयोग किया जाने वाला डेटा वोगेला लेख और इंटरनेट है।

ग्रहण + जर्सी + ग्लासफिश 3 का उपयोग करके जावा में एक प्रतिष्ठित वेब सेवा बनाएं