जावा / स्प्रिंग: स्पीड का उपयोग करके CRUD REST API को पूरी तरह से कैसे जनरेट करें

इस लेख में, आप सीखेंगे कि किसी डेटाबेस के लिए पूर्ण CRUD REST API बनाने के लिए Speedment का उपयोग कैसे करें।



यह हर साल तेजी से स्पष्ट होता जा रहा है कि स्प्रिंग फ्रेमवर्क सबसे व्यापक रूप से उपयोग किए जाने वाले जावा वेब डेवलपमेंट फ्रेमवर्क में से एक है।

अगले दशक के करीब आते ही, स्प्रिंग के सबसे लोकप्रिय मॉड्यूल, स्प्रिंग बूट को अभी एक बड़ा अपडेट मिला है। स्प्रिंग बूट "2.2.0" और 2020 के नए संस्करण लगभग एक दूसरे से पूरी तरह से मेल खाते हैं। इसलिए, स्पीड डेवलपमेंट टीम ने स्प्रिंग बूट प्लगइन को अपडेट करके अंतर को भर दिया।

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

स्पीड के बारे में

गति को ORM के रूप में वर्णित किया जा सकता है, जो जावा समुदाय के योग्य है - उन लोगों के लिए एक टूलकिट जो तेजी से विकास और यहां तक ​​कि तेजी से अनुप्रयोगों से प्यार करते हैं।

चयनित डेटाबेस के साथ संचार करने के प्राथमिक साधन के रूप में जावा स्ट्रीम एपीआई का उपयोग करके, गति जावा के साथ डेवलपर्स को घर पर महसूस करने की अनुमति देती है। उपयोग में आसान एपीआई के अलावा, गति डेवलपर्स को एक ग्राफिकल टूल प्रदान करता है जो सेकंड में उनके लिए एक डोमेन मॉडल तैयार करता है।

यदि आप संपूर्ण रूप से स्पीडमेंट में रुचि रखते हैं, तो उदाहरणों के साथ विस्तृत दस्तावेज़ के लिए निम्न लिंक पर क्लिक करें। इस लेख का बाकी भाग स्प्रिंग बूट प्लगइन पर केंद्रित होगा।

स्प्रिंग बूट: सबसे तेज शुरुआत

स्पीड स्प्रिंग बूट प्लगइन कुछ समय के लिए आसपास रहा है, लेकिन स्पीड 3.2.2 ने मुख्य कार्य को शुरू किया - आपके डेटाबेस मॉडल से सीधे पूरे सीआरयूडी रीस्ट एपीआई को उत्पन्न करने की क्षमता।

इस पर निर्भर करते हुए कि आप स्क्रैच से शुरू करते हैं या आपके पास पहले से ही एक परियोजना है, चरण अलग-अलग होंगे, लेकिन यह सुनिश्चित करें कि एकीकरण परियोजना आपकी परियोजना की स्थिति की परवाह किए बिना सरल होगी।

यदि आप स्प्रिंग बूट को मौजूदा स्पीड प्रोजेक्ट में एकीकृत करना चाहते हैं, तो आपको अपने pom.xml पर निम्न 2 तत्वों को जोड़ना होगा:

<plugin> <groupId>com.speedment.enterprise</groupId> <artifactId>speedment-enterprise-maven-plugin</artifactId> <version>${speedment.version}</version> <configuration> <components> component>com.speedment.enterprise.plugins.spring.SpringGeneratorBundle</component> </components> <appName>${project.artifactId}</appName> <packageName>${project.groupId}</packageName> </configuration> ... // Database connector dependency </plugin> <dependencies> ... <dependency> <groupId>javax.annotation</groupId> <artifactId>javax.annotation-api</artifactId> <version>1.3.1</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>2.2.1.RELEASE</version> </dependency> <dependency> <groupId>com.speedment.enterprise.plugins</groupId> <artifactId>spring-runtime</artifactId> <version>${speedment.version}</version> </dependency> ... </dependencies> 

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

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

CRUD सरलीकृत

एक बार जब आप प्लगइन स्थापित कर लेते हैं, तो कुछ विशिष्ट स्प्रिंग बूट विकल्प स्पीड टूल में उपलब्ध होंगे जिनका उपयोग आप अपने REST API को कॉन्फ़िगर करने के लिए कर सकते हैं। आप निम्न कमांड को चलाकर स्पीड टूल को चला सकते हैं:

 mvn speedment:tool 

यदि यह आपका पहली बार स्पीड का उपयोग कर रहा है, तो आप संक्षिप्त हैलो स्पीड ट्यूटोरियल का पालन ​​करके वर्कफ़्लो के साथ खुद को परिचित करना चाह सकते हैं।

डिफ़ॉल्ट रूप से, स्पीड टूल REST API जनरेट नहीं करता है। एक विशिष्ट तालिका के लिए एक CRUD REST API जनरेट करने के लिए, ट्री व्यू में तालिका का चयन करें और “ REST Enable Create / Update / Delete ” विकल्प के साथ “ Generate @RestController ” चेक बॉक्स का चयन करें । जब आप Generate पर क्लिक करते हैं, तो REST मैपिंग का एक सेट बनाया जाएगा - वे URL जो एक विशेष तालिका के लिए CRUD संचालन को कार्यान्वित करते हैं।



वह सब है! मैनुअल कोडिंग की आवश्यकता नहीं है। कमांड चलाकर बस जेनरेट स्प्रिंग प्रोजेक्ट को चलाएं:

 mvn spring-boot:run 

REST का उपयोग करके एंटिटी बनाना

आपके द्वारा बनाए गए REST API का उपयोग करके एक नई इकाई बनाने के लिए, आपको टूल में निर्दिष्ट पथ पर एक POST अनुरोध निष्पादित करना होगा। डिफ़ॉल्ट रूप से, इस पथ का नाम आपके स्कीमा के नाम के उपसर्ग के साथ, आपकी तालिका के नाम से मेल खाता है। यदि आप " REST समापन बिंदु " चेकबॉक्स साफ़ करते हैं, तो आप एक मनमाना पथ नाम निर्दिष्ट कर सकते हैं। अनुरोध निकाय में JSON ऑब्जेक्ट में कुंजी-मूल्य जोड़े शामिल होने चाहिए, जहां स्पीड टूल से " REST फ़ील्ड नाम " मान कुंजी हैं।

उदाहरण के लिए, यदि हमारे पास कॉलम आईडी , नाम और उम्र के साथ एक तालिका नाम वाला व्यक्ति है , तो हम एक नई इकाई बनाने के लिए निम्नलिखित प्रश्न भेजेंगे:

 POST localhost:8080/db/person { "id": 1, "name": "Jane", "age": 25 } 

या

 curl -d '{"id": 1,"name": "Jane","age": 25}' -H "Content-Type:application/json" -X POST localhost:8080/db/person 

यदि आईडी कॉलम का मान स्वतः उत्पन्न होता है (या अनुक्रम का उपयोग करता है), तो आप इसे POST निकाय से बाहर कर सकते हैं। यदि आप किसी विशिष्ट स्तंभ को POST निकाय से जबरन बाहर करना चाहते हैं, तो टूल ट्री दृश्य में संबंधित कॉलम पर क्लिक करें और " Create बॉडी में शामिल करें " बॉक्स को अनचेक करें और अपने डोमेन मॉडल को फिर से बनाएँ। दूसरी ओर, यदि आप यह सुनिश्चित करना चाहते हैं कि अनुरोध को निष्पादित करते समय POST बॉडी में एक विशिष्ट कॉलम मौजूद है, तो "आवश्यक निकाय बनाएं" जांचें और अपने डोमेन मॉडल को फिर से बनाएं।

पुनर्निवेश का उपयोग कर संस्थाओं को पुनः प्राप्त करना

हमारी नई बनाई गई इकाई को पाने के लिए, हमें उसी तरह से एक GET अनुरोध निष्पादित करना चाहिए जिस तरह से इकाई बनाने के लिए इस्तेमाल किया गया था:

 GET localhost:8080/db/person 

या

 curl localhost:8080/db/person/1 

एक पूर्ण अनुरोध सभी मौजूदा संस्थाओं के JSON एरे को वापस करेगा। हमारे मामले में, यह केवल हमारी एकमात्र इकाई के साथ एक सरणी लौटाएगा:

 [ { "id": 1, "name": "Jane", "age": 25 } ] 

फ़िल्टर और सॉर्टर्स जैसी उन्नत अवधारणाएँ स्पीडमेंट के आधिकारिक प्रलेखन में विस्तृत हैं।

REST का उपयोग करके मौजूदा संस्थाओं को अपडेट करना

REST API का उपयोग करके किसी मौजूदा इकाई को अपडेट करना एक इकाई बनाने के समान है। एक POST अनुरोध के बजाय, हम एक PATCH अनुरोध निष्पादित करते हैं, और पथ को एक इकाई पहचानकर्ता के साथ विस्तारित किया जाता है। हमारी इकाई का कौन सा पहचानकर्ता इस तालिका के प्राथमिक कुंजी कॉलम पर निर्भर करता है। चूंकि हमारा पीके (प्राथमिक कुंजी) कॉलम एक संख्यात्मक प्रकार है, इसलिए हमारी इकाई पहचानकर्ता एक पूर्णांक होगा।

हमारे द्वारा पिछले उदाहरण में बनाई गई इकाई को अपडेट करने के लिए, हम निम्नलिखित प्रश्न को चलाएंगे:

 PATCH localhost:8080/db/person/1 { "name": "Mike", "age": 43 } 

या

 curl -d '{"name": "Jane","age": 25}' -H "Content-Type:application/json" -X PATCH localhost:8080/db/person/1 

डिफ़ॉल्ट रूप से, सभी स्तंभ PATCH निकाय (प्राथमिक कुंजी स्तंभ को छोड़कर) में शामिल हैं, लेकिन उनकी आवश्यकता नहीं है। यदि आप किसी विशिष्ट स्तंभ को जबरन अनुरोध निकाय से बाहर करना चाहते हैं, तो टूल ट्री दृश्य में संबंधित कॉलम पर क्लिक करें और " अपडेट बॉडी में शामिल करें " बॉक्स को अनचेक करें और अपने डोमेन मॉडल को फिर से बनाएँ। दूसरी ओर, यदि आप यह सुनिश्चित करना चाहते हैं कि अनुरोध निकाय में एक कॉलम मौजूद है, तो " अपडेट बॉडी में आवश्यक " जांचें और अपने डोमेन मॉडल को अपडेट करें।

रीस्ट का उपयोग करके एंटिटीज को हटाना

REST API का उपयोग करके एक इकाई को निकालना काफी सरल है - हम उसी तरह से DELETE अनुरोध निष्पादित करते हैं, जिसका उपयोग संस्थाओं को अपडेट करने के लिए किया जाता है।

पिछले उदाहरणों में हमारे द्वारा बनाई और अद्यतन की गई इकाई को निकालने के लिए, हम निम्नलिखित प्रश्न को चलाएंगे:

 DELETE localhost:8080/db/person/1 

या

 curl -X DELETE localhost:8080/db/person/1 

सारांश

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

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

अतिरिक्त पढ़ने

REST API पार्ट 4 बनाना: POST, PUT और DELETE अनुरोधों को संभालना

एक मूल CRUD रेस्टफुल स्प्रिंग बूट MVC एप्लीकेशन का निर्माण: जावा स्प्रिंग के साथ शुरुआत करना