सीयूबीए में स्प्रिंग जेपीए रिपोजिटरी

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

आवश्यक शर्तें

डेवलपर्स आमतौर पर अपनी आदतों को बदलना पसंद नहीं करते हैं (अक्सर, रूपरेखा को आदतों की सूची में भी शामिल किया जाता है)। जब मैंने सीयूबीए के साथ काम करना शुरू किया, तो मुझे बहुत सी नई चीजें नहीं सीखनी पड़ीं , लगभग तुरंत प्रोजेक्ट पर काम में सक्रिय रूप से शामिल होना संभव था। लेकिन एक बात थी कि मुझे अधिक समय तक बैठना था - यह डेटा के साथ काम कर रहा था।

स्प्रिंग में कई लाइब्रेरी हैं जिनका उपयोग डेटाबेस के साथ काम करने के लिए किया जा सकता है, सबसे लोकप्रिय में से एक है स्प्रिंग-डेटा-जेपीए , जो ज्यादातर मामलों में आपको SQL या JPQL नहीं लिखने की अनुमति देता है। आपको बस उन तरीकों से एक विशेष इंटरफ़ेस बनाने की आवश्यकता है जो एक विशेष तरीके से नामित किए गए हैं और वसंत उत्पन्न करेगा और डेटाबेस से डेटा प्राप्त करने और इकाई ऑब्जेक्ट्स के इंस्टेंसेस बनाने के लिए बाकी काम करेंगे।

नीचे एक अंतिम नाम के साथ ग्राहकों को गिनने की विधि के साथ इंटरफेस है।

interface CustomerRepository extends CrudRepository<Customer, Long> { long countByLastName(String lastName); } 

इस इंटरफ़ेस का उपयोग बिना किसी कार्यान्वयन के सीधे वसंत सेवाओं में किया जा सकता है, जो काम को बहुत तेज़ करता है।

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

सीयूबीए में कोई जेपीए रिपॉजिटरी क्यों नहीं है और क्या मैं उन्हें जोड़ सकता हूं?

CUBA में डेटा के साथ काम करना

CUBA में, डेटा के साथ काम करने के लिए तीन मुख्य वर्ग जिम्मेदार हैं: DataStore, EntityManager, और DataManager।

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

EntityManager प्रसिद्ध JPA EntityManager की एक प्रति है। मानक कार्यान्वयन के विपरीत, इसमें सीयूबीए अभ्यावेदन के साथ काम करने के लिए विशेष तरीके हैं, डेटा के "सॉफ्ट" (तार्किक) हटाने के लिए, और सीयूबीए में प्रश्नों के साथ काम करने के लिए भी। डेटास्टोर के मामले में, 90% परियोजनाओं में, एक सामान्य डेवलपर को EntityManager के साथ सौदा नहीं करना होगा, सिवाय इसके कि जब डेटा एक्सेस प्रतिबंध प्रणाली को दरकिनार करके कुछ अनुरोधों को पूरा करना आवश्यक हो।

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

नीचे CUBA घटकों के इंटरैक्शन का एक आरेख है जो डेटा प्रबंधक के माध्यम से डेटा लाने में शामिल हैं।

DataManager का उपयोग करके, आप अपेक्षाकृत आसानी से संस्थाओं और CUBA विचारों का उपयोग करते हुए संस्थाओं की पूरी पदानुक्रम लोड कर सकते हैं। अपने सरलतम रूप में, क्वेरी इस तरह दिखाई देती है:

 dataManager.load(Customer.class).list(); 

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

लेकिन, जब अधिक जटिल प्रश्नों की बात आती है, तो आपको CUBA में JPQL लिखना होगा।

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

 public Long countByLastName(String lastName) { return dataManager .loadValue("select count(c) from sample$Customer c where c.lastName = :lastName", Long.class) .parameter("lastName", lastName) .one(); } 

या ऐसे:

 public Long countByLastName(String lastName) { LoadContext<Customer> loadContext = LoadContext.create(Customer.class); loadContext .setQueryString("select c from sample$Customer c where c.lastName = :lastName") .setParameter("lastName", lastName); return dataManager.getCount(loadContext); } 

CUBA एपीआई में, आपको एक स्ट्रिंग के रूप में JPQL अभिव्यक्ति को पास करने की आवश्यकता है (मानदंड एपीआई अभी तक समर्थित नहीं है), यह प्रश्न बनाने का एक पठनीय और समझने योग्य तरीका है, लेकिन ऐसे प्रश्नों को डीबग करना बहुत मजेदार मिनट ला सकता है। इसके अलावा, जेपीक्यूएल स्ट्रिंग्स को कंटेनर इनिशियलाइज़ेशन के दौरान कंपाइलर या स्प्रिंग फ्रेमवर्क द्वारा सत्यापित नहीं किया जाता है, जो केवल रनटाइम में त्रुटियों की ओर जाता है।

स्प्रिंग जेपीए के साथ इसकी तुलना करें:

 interface CustomerRepository extends CrudRepository<Customer, Long> { long countByLastName(String lastName); } 

कोड तीन गुना छोटा है, और कोई रेखा नहीं है। इसके अलावा, विधि नाम countByLastName स्प्रिंग कंटेनर के प्रारंभ के दौरान जाँच की countByLastName है। यदि कोई टाइपो है और आपने countByLastNsme लिखा है, तो एप्लिकेशन परिनियोजन के दौरान त्रुटि के साथ क्रैश हो जाएगा:

 Caused by: org.springframework.data.mapping.PropertyReferenceException: No property LastNsme found for type Customer! 

CUBA स्प्रिंग फ्रेमवर्क के आसपास बनाया गया है, इसलिए आप CUBA का उपयोग करके लिखे गए एप्लिकेशन में स्प्रिंग-डेटा-जेपीए लाइब्रेरी में प्लग कर सकते हैं, लेकिन एक छोटी समस्या है - एक्सेस कंट्रोल। स्प्रिंग CrudRepository कार्यान्वयन अपने EntityManager का उपयोग करता है। इस प्रकार, सभी प्रश्नों को DataManager को दरकिनार कर प्रदर्शन किया जाएगा। इस प्रकार, CUBA में JPA रिपॉजिटरी का उपयोग करने के लिए, आपको DataManager कॉल के साथ सभी EntityManager कॉल को बदलने और CUBA के विचारों के लिए समर्थन जोड़ने की आवश्यकता है।

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

कार्यान्वयन

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

सबसे कठिन बात वस्तुओं के एक पदानुक्रम के आधार पर JPQL पीढ़ी को सही ढंग से लागू करना था - विधि के नाम को पार्स करने का परिणाम। लेकिन, सौभाग्य से, Apache इग्नाइट में एक समान कार्य पहले से ही लागू किया गया था, इसलिए कोड को वहां से लिया गया था और SQL के बजाय JPQL उत्पन्न करने और delete ऑपरेटर का समर्थन करने के लिए थोड़ा अनुकूलित किया गया था।

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

सीयूबीए में रिपोजिटरी का उपयोग करना

CUBA में रिपॉजिटरी का उपयोग करने के लिए, आपको प्रोजेक्ट बिल्ड फ़ाइल में मॉड्यूल को कनेक्ट करना होगा:

  appComponent("com.haulmont.addons.cuba.jpa.repositories:cuba-jpa-repositories-global:0.1-SNAPSHOT") 

आप XML कॉन्फ़िगरेशन का उपयोग रिपॉजिटरी को "सक्षम" करने के लिए कर सकते हैं:

 <?xml version="1.0" encoding="UTF-8"?> <beans:beans xmlns:beans="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:repositories="http://www.cuba-platform.org/schema/data/jpa" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd http://www.cuba-platform.org/schema/data/jpa http://www.cuba-platform.org/schema/data/jpa/cuba-repositories.xsd"> <!-- Annotation-based beans --> <context:component-scan base-package="com.company.sample"/> <repositories:repositories base-package="com.company.sample.core.repositories"/> </beans:beans> 

और आप एनोटेशन का उपयोग कर सकते हैं:

 @Configuration @EnableCubaRepositories public class AppConfig { //Configuration here } 

रिपॉजिटरी का समर्थन सक्रिय होने के बाद, आप उन्हें सामान्य रूप में बना सकते हैं, उदाहरण के लिए:

 public interface CustomerRepository extends CubaJpaRepository<Customer, UUID> { long countByLastName(String lastName); List<Customer> findByNameIsIn(List<String> names); @CubaView("_minimal") @JpqlQuery("select c from sample$Customer c where c.name like concat(:name, '%')") List<Customer> findByNameStartingWith(String name); } 

प्रत्येक विधि के लिए, आप एनोटेशन का उपयोग कर सकते हैं:

• @CubaView क्यूबा दृश्य - @CubaView में उपयोग की जाने वाली CUBA दृश्य सेट करने के लिए
• @JpqlQuery - @JpqlQuery क्वेरी निर्दिष्ट करने के लिए जिसे विधि नाम की परवाह किए बिना निष्पादित किया जाएगा।

इस मॉड्यूल का उपयोग सीयूबीए ढांचे के global मॉड्यूल में किया जाता है, इसलिए, रिपॉजिटरी का उपयोग core मॉड्यूल और web दोनों में किया जा सकता है। केवल एक चीज जो आपको याद रखने की आवश्यकता है, वह है दोनों मॉड्यूल की कॉन्फ़िगरेशन फ़ाइलों में रिपॉजिटरी को सक्रिय करना।

CUBA सेवा में भंडार का उपयोग करने का एक उदाहरण:

 @Service(CustomerService.NAME) public class CustomerServiceBean implements PersonService { @Inject private CustomerRepository customerRepository; @Override public List<Date> getCustomersBirthDatesByLastName(String name) { return customerRepository.findByNameStartingWith(name) .stream().map(Customer::getBirthDate).collect(Collectors.toList()); } } 

निष्कर्ष

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