गिटार के साथ लचीला विन्यास

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

Double double = config.getDouble("number"); Integer integer = config.getInteger("number"); 

लेकिन यह दृष्टिकोण मुझे कई कारणों से सूट नहीं करता है:

• सबसे पहले, यह काफी क्रियात्मक निकलता है;
• संपूर्ण कॉन्फ़िगरेशन ऑब्जेक्ट को स्थानांतरित करना आवश्यक है, भले ही इसमें से केवल एक पैरामीटर आवश्यक हो;
• कुंजी में गलती करना और गलत डेटा पढ़ना बहुत सरल है।

कुछ समय पहले मैंने गाइस डॉक्यूमेंटेशन पढ़ा और एक पैराग्राफ पर ठोकर खाई जो इस विचार के साथ आया कि यह बेहतर किया जा सकता है। यहाँ एक प्रासंगिक मार्ग है:

Guice बाइंडिंग एनोटेशन का समर्थन करता है जिसमें विशेषताएँ होती हैं।
उन दुर्लभ मामलों में जब आपको उनकी आवश्यकता होती है:
1) एक @interface एनोटेशन बनाएँ।
2) एक वर्ग बनाएं जो एनोटेशन इंटरफ़ेस को लागू करता है। एनोटेशन जवादोक में परिभाषित बराबर () और हैशकोड () के लिए दिशानिर्देशों का पालन करें। एनोटेटिडविथ () में कक्षा का एक उदाहरण दें।

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

लक्ष्यों

मैं लागू करना चाहूंगा:

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

मुझे इस बात की परवाह नहीं है कि बाहरी इंटरफ़ेस का उपयोग क्या किया जाएगा: सेटिंग्स कैसे प्राप्त होती हैं, यह फ्रेमवर्क के लिए प्रासंगिक नहीं है, वे XML, JSON के रूप में हो सकते हैं, नेटवर्क पर या डेटाबेस से आ सकते हैं। सेटिंग्स से मैप फ्रेमवर्क के इनपुट पर, और मैं उन्हें वहां से प्राप्त करता हूं।

जब तक हम खत्म नहीं करेंगे, तब तक हम कुछ कर सकते हैं:

 # - properties- host=foo.com port=1234 

हम कोड में इन मूल्यों का उपयोग करते हैं:

 public class A { @Inject @Prop(Property.HOST) private String host; @Inject @Prop(Property.PORT) private Integer port; // ... } 

कार्यान्वयन

प्रोप एनोटेशन परिभाषा तुच्छ है:

 @Retention(RUNTIME) @Target({ ElementType.FIELD, ElementType.PARAMETER }) @BindingAnnotation public @interface Prop { Property value(); } 

प्रॉपर्टी एक एनम है जिसमें आपकी सेटिंग्स के लिए आवश्यक सभी जानकारी है। ऊपर दिए गए उदाहरण के लिए:

 public enum Property { HOST("host", "The host name", new TypeLiteral<String>() {}, "foo.com"), PORT("port", "The port", new TypeLiteral<Integer>() {}, 1234); } 

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

अगला कदम उन सभी गुणों को बांधना है, जिन्हें हमने इनपुट पर पार्स किया है - चलो मानचित्र को "ऑलप्रॉप्स" कहते हैं - हमारे मॉड्यूल में ताकि गिटार समझें कि उन्हें कैसे इंजेक्ट किया जाए।
ऐसा करने के लिए, हम इन सभी संपत्तियों पर जाएँगे और उन्हें हमारे प्रदाता को बाँध देंगे। चूंकि हम टाइप किए गए फ़ील्ड का उपयोग करते हैं, Guice API से Key.get () के उपयोग पर ध्यान दें, जो आपको संपत्ति को संबंधित एनोटेशन में मैप करने की अनुमति देता है:

  for (Property prop : Property.values()) { Object value = PropertyConverters.getValue(prop.getType(), prop, allProps.asMap()); binder.bind(Key.get(prop.getType(), new PropImpl(prop))) .toProvider(new PropertyProvider(prop, value)); } 

उदाहरण में तीन वर्ग हैं जिन्हें मैंने अभी तक समझाया नहीं है। पहले, PropertyConverters, बस संपत्ति को एक स्ट्रिंग के रूप में पढ़ता है और इसे जावा प्रकार में परिवर्तित करता है। दूसरा प्रॉपर्टीप्रॉइडर है - गाइस से सबसे सरल प्रदाता:

 public class PropertyProvider<T> implements Provider<T> { private final T value; private final Property property; public PropertyProvider(Property property, T value) { this.property = property; this.value = value; } @Override public T get() { return value; } } 

PropImpl थोड़ा अधिक जटिल है और इसने मुझे हर समय रोक दिया जब मैं इस तरह की रूपरेखा विकसित कर रहा था जब तक कि मैं गाइस प्रलेखन में उस tidbit के पार नहीं आया। इस वर्ग की आवश्यकता को समझने के लिए, आपको सीखना चाहिए कि Key.get () कैसे काम करता है। Guice इसका उपयोग विशिष्ट प्रकार की मानचित्र कुंजी के लिए करता है, जिसका उपयोग वांछित मानों को इंजेक्ट करने के लिए किया जाता है। यहां महत्वपूर्ण हिस्सा यह है कि यह विधि न केवल क्लास और टाइपलाइन के साथ काम करती है, बल्कि संबंधित एनोटेशन से भी जुड़ी है। यह एनोटेशन @Named हो सकता है, हालांकि मैं इसका बहुत बड़ा प्रशंसक नहीं हूं, क्योंकि यह स्ट्रिंग्स के साथ काम करता है, इसका मतलब है कि यह टाइपोस, या इसके स्वयं के एनोटेशन के अधीन है, यह हमें अधिक सूट करेगा। हालाँकि, जावा में एनोटेशन एक विशेष बात है; आपको इसका उदाहरण नहीं मिल सकता है।

यह वह जगह है जहां लेख की शुरुआत में वर्णित चाल खेलने में आती है: जावा, वास्तव में, आपको नियमित वर्ग के साथ एनोटेशन को लागू करने की अनुमति देता है। कार्यान्वयन काफी सरल निकला, कठिनाई यह थी कि यह आमतौर पर संभव था।

अब सभी भागों में जगह है, यह विश्लेषण करने के लिए बनी हुई है कि यहां किस तरह का जादू है:

  @Inject @Prop(Property.HOST) private String host; 

जब गुईस इस इंजेक्शन बिंदु पर पहुंचता है, तो उसे अपने ज़ाश्श्निक में तार के लिए कई बाइंडर्स मिलते हैं क्योंकि वे की के लिए बाध्य थे, जो अनिवार्य रूप से एक जोड़ी है (String, Prop) । इस मामले में, वह String, Property.HOST की एक जोड़ी की तलाश करेगा और वहाँ एक प्रदाता मिलेगा जो कि संपत्ति फ़ाइल से मूल्य के साथ त्वरित किया गया था, जिसे वह वापस करता है।

हम सामान्यीकरण

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

 @Retention(RUNTIME) @Target({ ElementType.FIELD, ElementType.PARAMETER }) @BindingAnnotation public @interface Prop { Property value(); } 

इसे और अधिक सार्वभौमिक बनाने के लिए, मुझे Enum लौटना पड़ा:

 @Retention(RUNTIME) @Target({ ElementType.FIELD, ElementType.PARAMETER }) @BindingAnnotation public @interface Prop { Enum value(); } 

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

संकल्पना का एक छोटा सा प्रमाण यहाँ है , मुझे आशा है कि आप इसे उपयोगी पाएंगे।