जावा 8 विधि संदर्भ के साथ संपत्ति शाब्दिक अनुकरण

एक अनुवादक से: जावा में एक nameOf ऑपरेटर की कमी के अपराध ने मुझे इस लेख का अनुवाद करने के लिए प्रेरित किया। अधीर के लिए - लेख के अंत में स्रोतों और बायनेरिज़ में तैयार कार्यान्वयन है।

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

अकिन से क्लास लिटरल (उदा। ग्राहक.क्लास), प्रॉपर्टी लिटरल, बीन क्लासेस के गुणों को संदर्भित करना संभव बनाता है। यह एक एपीआई डिजाइन करने के लिए उपयोगी होगा जहां गुणों पर कार्रवाई करने या किसी तरह उन्हें कॉन्फ़िगर करने की आवश्यकता होती है।

अनुवादक से: कट के तहत, हम विश्लेषण करते हैं कि इसे कैसे सुधार किया जाए।

उदाहरण के लिए, हाइबरनेट खोज में इंडेक्स मैपिंग कॉन्फ़िगरेशन API पर विचार करें:

 new SearchMapping().entity(Address.class) .indexed() .property("city", ElementType.METHOD) .field(); 

या बीन वैलिडेशन एपीआई से validateValue() विधि, जो आपको संपत्ति पर प्रतिबंध के खिलाफ मूल्य की जांच करने की अनुमति देती है:

 Set<ConstraintViolation<Address>> violations = validator.validateValue(Address.class, "city", "Purbeck" ); 

दोनों स्थितियों में, Address ऑब्जेक्ट की city संपत्ति को संदर्भित करने के लिए String प्रकार का उपयोग किया जाता है।

इससे त्रुटियां हो सकती हैं:

• पता वर्ग में city संपत्ति नहीं हो सकती है। या, जब कोई रिफैक्टिंग करते हैं, तो गेट / सेट के तरीकों का नाम बदलने के बाद संपत्ति का स्ट्रिंग नाम अपडेट करना भूल सकता है।
• validateValue() के मामले में, हमारे पास यह सत्यापित करने का कोई तरीका नहीं है कि पारित मूल्य किस प्रकार की संपत्ति से मेल खाता है।

इस एपीआई के उपयोगकर्ता केवल एप्लिकेशन लॉन्च करके इन समस्याओं के बारे में जान सकते हैं। यदि कंपाइलर और टाइप सिस्टम ने शुरुआत से ही इस तरह के उपयोग को रोका तो क्या यह अच्छा नहीं होगा? यदि जावा में संपत्ति के शाब्दिक थे, तो हम ऐसा कर सकते हैं (यह कोड संकलित नहीं करता है):

 mapping.entity(Address.class) .indexed() .property(Address::city, ElementType.METHOD ) .field(); 

और:

 validator.validateValue(Address.class, Address::city, "Purbeck"); 

हम ऊपर वर्णित समस्याओं से बच सकते हैं: संपत्ति के नाम में कोई भी टाइपो एक संकलन त्रुटि का कारण होगा, जिसे सीधे आपके आईडीई में देखा जा सकता है। यह हमें हाइबरनेट खोज कॉन्फ़िगरेशन API को डिज़ाइन करने की अनुमति देगा ताकि यह केवल पता वर्ग के गुणों को स्वीकार करे जब हम पता इकाई को कॉन्फ़िगर करते हैं। और बीन मान्यता सत्यापन के मामले में validateValue() संपत्ति शाब्दिकता यह सुनिश्चित करने में मदद करेगी कि हम सही प्रकार के मूल्य से गुजर रहे हैं।

जावा 8 विधि संदर्भ

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

संपत्ति के शाब्दिक के रूप में गेट्टर विधि के संदर्भ का उपयोग करने के विचार पर विचार करें:

 validator.validateValue(Address.class, Address::getCity, "Purbeck"); 

जाहिर है, यह केवल तभी काम करेगा जब आपके पास एक गटर हो। लेकिन अगर आपकी कक्षाएं पहले से ही JavaBeans कन्वेंशन का अनुसरण करती हैं, जो कि अक्सर होता है, तो यह ठीक है।

validateValue() विधि validateValue() विधि की घोषणा क्या दिखती है? मुख्य बिंदु नए Function प्रकार का उपयोग है:

 public <T, P> Set<ConstraintViolation<T>> validateValue( Class<T> type, Function<? super T, P> property, P value); 

दो टाइपिंग मापदंडों का उपयोग करके, हम यह सत्यापित कर सकते हैं कि बिन प्रकार, गुण, और पारित मूल्य सही हैं। एपीआई के दृष्टिकोण से, हमें वह मिल गया है जिसकी हमें आवश्यकता है: इसका उपयोग करना सुरक्षित है और आईडीई भी स्वचालित रूप से Address:: साथ शुरू होने वाले तरीकों के नामों का पूरक होगा। लेकिन वैद्युत विधि validateValue() विधि के कार्यान्वयन में Function ऑब्जेक्ट से संपत्ति का नाम कैसे प्राप्त करें?

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

बचाव के लिए ByteBuddy

जैसा कि यह पता चला है, चाल समारोह को लागू करने में है! टाइप टी का एक प्रॉक्सी उदाहरण बनाकर, हमें विधि को कॉल करने और प्रॉक्सी कॉल हैंडलर में उसका नाम प्राप्त करने का लक्ष्य है। (अनुवादक से: इसके बाद हम गतिशील जावा प्रॉक्सी के बारे में बात कर रहे हैं - java.lang.reflect.Proxy)।

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

आइए एक इंटरफ़ेस को परिभाषित करने से शुरू करें जो हमें विधि संदर्भ से निकाले गए संपत्ति के नाम को संग्रहीत और पुनर्प्राप्त करने की अनुमति देगा।

 public interface PropertyNameCapturer { String getPropertyName(); void setPropertyName(String propertyName); } 

अब हम ByteBuddy का उपयोग प्रोग्रामेटिक रूप से उन प्रॉक्सी कक्षाओं को बनाने के लिए करते हैं जो हमारे लिए रुचि के प्रकारों के अनुकूल हैं (उदाहरण के लिए: पता) और PropertyNameCapturer लागू करें:

 public <T> T /* & PropertyNameCapturer */ getPropertyNameCapturer(Class<T> type) { DynamicType.Builder<?> builder = new ByteBuddy() (1) .subclass( type.isInterface() ? Object.class : type ); if (type.isInterface()) { (2) builder = builder.implement(type); } Class<?> proxyType = builder .implement(PropertyNameCapturer.class) (3) .defineField("propertyName", String.class, Visibility.PRIVATE) .method( ElementMatchers.any()) (4) .intercept(MethodDelegation.to( PropertyNameCapturingInterceptor.class )) .method(named("setPropertyName").or(named("getPropertyName"))) (5) .intercept(FieldAccessor.ofBeanProperty()) .make() .load( (6) PropertyNameCapturer.class.getClassLoader(), ClassLoadingStrategy.Default.WRAPPER ) .getLoaded(); try { @SuppressWarnings("unchecked") Class<T> typed = (Class<T>) proxyType; return typed.newInstance(); (7) } catch (InstantiationException | IllegalAccessException e) { throw new HibernateException( "Couldn't instantiate proxy for method name retrieval", e ); } } 

कोड थोड़ा भ्रामक लग सकता है, इसलिए मुझे इसे समझाएं। पहले हमें ByteBuddy (1) का एक उदाहरण मिलता है, जो कि DSL प्रविष्टि बिंदु है। इसका उपयोग गतिशील प्रकार बनाने के लिए किया जाता है जो या तो वांछित प्रकार (यदि यह एक वर्ग है) या वारिस ऑब्जेक्ट का विस्तार करते हैं और वांछित प्रकार को लागू करते हैं (यदि यह एक इंटरफ़ेस है) (2)।

उसके बाद, हम इंगित करते हैं कि प्रकार PropertyNameCapturer इंटरफ़ेस को लागू करता है और वांछित संपत्ति (3) के नाम को संग्रहीत करने के लिए एक फ़ील्ड जोड़ता है। फिर हम कहते हैं कि सभी तरीकों से कॉल को PropertyNameCapturingInterceptor (4) द्वारा इंटरसेप्ट किया जाना चाहिए। केवल setPropertyName () और getPropertyName () (PropertyNameCapturer इंटरफ़ेस से) पहले बनाई गई वास्तविक संपत्ति (5) तक पहुंचना चाहिए। अंत में, वर्ग बनाया गया है, लोड किया गया है (6) और त्वरित (7)।

हमें केवल प्रॉक्सी प्रकार बनाने की आवश्यकता है, धन्यवाद बाइटबॉडी, यह कोड की कुछ पंक्तियों में किया जा सकता है। अब कॉल इंटरसेप्टर पर नजर डालते हैं:

 public class PropertyNameCapturingInterceptor { @RuntimeType public static Object intercept(@This PropertyNameCapturer capturer, @Origin Method method) { (1) capturer.setPropertyName(getPropertyName(method)); (2) if (method.getReturnType() == byte.class) { (3) return (byte) 0; } else if ( ... ) { } // ... handle all primitve types // ... } else { return null; } } private static String getPropertyName(Method method) { (4) final boolean hasGetterSignature = method.getParameterTypes().length == 0 && method.getReturnType() != null; String name = method.getName(); String propName = null; if (hasGetterSignature) { if (name.startsWith("get") && hasGetterSignature) { propName = name.substring(3, 4).toLowerCase() + name.substring(4); } else if (name.startsWith("is") && hasGetterSignature) { propName = name.substring(2, 3).toLowerCase() + name.substring(3); } } else { throw new HibernateException( "Only property getter methods are expected to be passed"); (5) } return propName; } } 

अवरोधन () विधि कॉल (1) के लिए विधि और लक्ष्य को स्वीकार करता है। @Origin और @This उपयुक्त मापदंडों को निर्दिष्ट करने के लिए उपयोग किया जाता है ताकि बाइटबड्डी एक डायनेमिक प्रॉक्सी में सही इंटरसेप्ट () कॉल उत्पन्न कर सके।

ध्यान दें कि ByteBuddy प्रकार पर रिसेप्टर की कोई सख्त निर्भरता नहीं है, क्योंकि ByteBuddy का उपयोग केवल एक गतिशील प्रॉक्सी बनाने के लिए किया जाता है, लेकिन इसका उपयोग करते समय नहीं।

getPropertyName() (4) को कॉल करके हम पास किए गए विधि संदर्भ के अनुसार गुण नाम प्राप्त कर सकते हैं, और इसे PropertyNameCapturer (2) में सहेज सकते हैं। यदि विधि एक गेटर नहीं है, तो कोड एक अपवाद (5) फेंकता है। गेट्टर का वापसी प्रकार कोई फर्क नहीं पड़ता है, इसलिए हम संपत्ति के प्रकार (3) पर विचार करते हुए शून्य लौट आते हैं।

अब हम validateValue() विधि में संपत्ति का नाम पाने के लिए तैयार हैं:

 public <T, P> Set<ConstraintViolation<T>> validateValue( Class<T> type, Function<? super T, P> property, P value) { T capturer = getPropertyNameCapturer(type); property.apply(capturer); String propertyName = ((PropertyLiteralCapturer) capturer).getPropertyName(); //      } 

फ़ंक्शन को बनाए गए प्रॉक्सी पर लागू करने के बाद, हम टाइप करें PropertyNameCapturer टाइप करें और विधि से नाम प्राप्त करें।

इसलिए, बाइटकोड बनाने के कुछ जादू का उपयोग करते हुए, हमने संपत्ति शाब्दिकों का अनुकरण करने के लिए जावा 8 से विधि संदर्भ का उपयोग किया।

बेशक, अगर हमारे पास भाषा में वास्तविक संपत्ति के शाब्दिक थे, तो हम सभी बेहतर होंगे। मैं निजी संपत्तियों के साथ काम करने की अनुमति भी दूंगा, शायद, संपत्तियों को एनोटेशन से संदर्भित किया जा सकता है। रियल प्रॉपर्टी लिटरल टिडियर होगा ("प्राप्त" उपसर्ग के बिना) और हैक की तरह नहीं दिखेगा।

अनुवादक से

यह ध्यान देने योग्य है कि अन्य अच्छी भाषाएं पहले से ही (या लगभग) एक समान तंत्र का समर्थन करती हैं:

• सी # - nameOf स्टेटमेंट
• ग्रूवी और स्काला - अच्छी तरह से ज्ञात मेटाप्रोग्रामिंग हैक और मैक्रोज़ हैं
• कोटलिन - एक सामान्य वाक्यविन्यास User::login.name

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

लेख में वर्णित दृष्टिकोण से प्रेरित होकर, आपके विनम्र सेवक ने एक छोटी सी लाइब्रेरी का नाम रखा, जो Java 8 के लिए nameOfProperty () को लागू करती है:

स्रोत कोड
बाइनरी