जावा में कॉन्फ़िगरेशन फ़ाइलें पढ़ना: nProperty

कई डेवलपर्स विकसित अनुप्रयोगों में कॉन्फ़िगरेशन (* .ini, * .prop, * .conf, आदि) फ़ाइलों को पढ़ने की आवश्यकता के साथ सामना कर रहे हैं। जावा में एक मानक गुण वर्ग है जिसके साथ आप बहुत आसानी से एक आईएनआई फ़ाइल को लोड कर सकते हैं और इसके गुणों को पढ़ सकते हैं। बड़ी मात्रा में कॉन्फ़िगरेशन फ़ाइलों के साथ, वस्तुओं को सेटिंग पढ़ना और लिखना बहुत थकाऊ और नियमित काम में बदल जाता है: एक गुण ऑब्जेक्ट बनाएं, प्रत्येक सेटिंग को वांछित प्रारूप में परिवर्तित करें और इसे फ़ील्ड में लिखें।

NProperty ( ए एन नोटेड प्रॉपर्टी ) लाइब्रेरी को इस प्रक्रिया को सरल बनाने के लिए डिज़ाइन किया गया है ताकि कॉन्फ़िगरेशन लोडर को लगभग आधे लिखने के लिए आवश्यक कोड काट दिया जा सके।

यह दिखाने के लिए कि कोड का वादा किया गया हल कैसे संभव है, दो उदाहरण नीचे दिए गए हैं: पहला उदाहरण मानक गुण वर्ग का उपयोग करता है, और दूसरा, nProperty।


लेख और nProperty पुस्तकालय खुद को मेरे दोस्त और दुकान सहायक Yorie द्वारा रोजमर्रा की आंतरिक जरूरतों के लिए लिखा गया था, और चूंकि वह, दुर्भाग्य से, वर्तमान में हब पर निमंत्रण नहीं है, मैंने उनकी रचना को प्रकाशित करने के लिए, उनकी सहमति से, स्वतंत्रता ली " खाबरोवस्की "जनता।

सामग्री

1. बस मुख्य बात के बारे में
2. आदिम और मानक प्रकार पढ़ना
3. सरणियों और संग्रहों में विवरण
4. कस्टम प्रकारों का वर्णन
5. पहुँच स्तर संशोधक
6. सभी वर्ग के सदस्यों का प्रारंभिक मूल्यांकन
7. डिफ़ॉल्ट मान
8. नाम पुनर्परिभाषित
9. गैर-स्थिर वर्ग क्षेत्रों के साथ काम करना
10. विधियों का उपयोग करना
11. इवेंट हैंडलिंग
12. स्ट्रीम और फ़ाइल डिस्क्रिप्टर का उपयोग करना
13. टिप्पणी
14. लाइसेंस
15. संदर्भ

बस मुख्य बात के बारे में

दोनों उदाहरणों में, एक ही कॉन्फ़िगरेशन फ़ाइल का उपयोग किया जाएगा:

SOME_INT_VALUE = 2 SOME_DOUBLE_VALUE = 1.2 SOME_STRING_VALUE = foo SOME_INT_ARRAY = 1;2;3 

उदाहरण संख्या १। मानक गुण वर्ग का उपयोग करके कॉन्फ़िगरेशन लोड हो रहा है।

 public class Example1 { private static int SOME_INT_VALUE = 1; private static String SOME_STRING_VALUE; private static int[] SOME_INT_ARRAY; private static double SOME_DOUBLE_VALUE; public Example1() throws IOException { Properties props = new Properties(); props.load(new FileInputStream(new File("config/example.ini"))); SOME_INT_VALUE = Integer.valueOf(props.getProperty("SOME_INT_VALUE", "1")); SOME_STRING_VALUE = props.getProperty("SOME_STRING_VALUE"); SOME_DOUBLE_VALUE = Double.valueOf(props.getProperty("SOME_DOUBLE_VALUE", "1.0")); // ,           String[] parts = props.getProperty("SOME_INT_ARRAY").split(";"); SOME_INT_ARRAY = new int[parts.length]; for (int i = 0; i < parts.length; ++i) { SOME_INT_ARRAY[i] = Integer.valueOf(parts[i]); } } public static void main(String[] args) throws IOException { new Example1(); } } 

उदाहरण संख्या 2। NProperty का उपयोग करके कॉन्फ़िगरेशन डाउनलोड करें।

 @Cfg public class Example2 { private static int SOME_INT_VALUE = 1; private static String SOME_STRING_VALUE; private static int[] SOME_INT_ARRAY; private static double SOME_DOUBLE_VALUE; public Example2() throws NoSuchMethodException, InstantiationException, IllegalAccessException, IOException, InvocationTargetException { ConfigParser.parse(Example2.class, "config/example.ini"); } public static void main(String[] args) throws InvocationTargetException, NoSuchMethodException, InstantiationException, IOException, IllegalAccessException { new Example2(); } } 

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

आदिम और मानक प्रकार पढ़ना

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

कॉन्फ़िगरेशन फ़ाइल से सेटिंग पढ़ने के लिए जिसका प्रकार आदिम है, यह एनोटेशन @ gg के साथ वर्ग के प्रत्येक क्षेत्र को नामित करने के लिए पर्याप्त है:

 public class Example3 { @Cfg private static int SOME_INT_VALUE; @Cfg private static short SOME_SHORT_VALUE; @Cfg private static long SOME_LONG_VALUE; @Cfg private static Double SOME_DOUBLE_VALUE; /* ... */ } 

NProperty लाइब्रेरी मानक प्रकारों के काफी समृद्ध सेट का समर्थन करती है:

• पूर्णांक / इंट
• छोटा / छोटा
• डबल / डबल
• लंबा / लंबा
• बूलियन / बूलियन
• तार
• चरित्र / चार
• बाइट / बाइट
• एटोमिकइंटर, एटॉमिकलॉन्ग, एटॉमिकबुलियन
• BigInteger, BigDecimal

इन सभी सूचीबद्ध प्रकारों का उपयोग ऊपर दिए गए उदाहरण में किया जा सकता है।

सरणियों और संग्रहों में विवरण

मानक प्रकारों के अलावा, सरणियों में विचलन भी एक स्थिति के साथ संभव है - सरणी का प्रकार कई मानक मानकों से संबंधित होना चाहिए:

 /*     : SOME_INT_ARRAY = 1--2--3 SOME_SHORT_ARRAY = 3>2<1 SOME_BIGINTEGER_ARRAY = 1;2;3 */ public class Example5 { @Cfg(splitter = "--") private static int[] SOME_INT_ARRAY; @Cfg(splitter = "[><]") private static short[] SOME_SHORT_ARRAY; @Cfg private static BigInteger[] SOME_BIGINTEGER_ARRAY; } 

सरणियों के मामले में, पुस्तकालय स्वयं आवश्यक आकार के सरणी को आरम्भ करने का ध्यान रखेगा।

SOME_INT_ARRAY और SOME_SHORT_ARRAY के एनोटेशन पर ध्यान दें। डिफ़ॉल्ट रूप से, nProperty एक सीमांकक के रूप में ";" वर्ण का उपयोग करता है। फ़ील्ड एनोटेशन में स्प्लिटर प्रॉपर्टी को निर्दिष्ट करके इसे आसानी से पुनर्परिभाषित किया जा सकता है। और, जैसा कि आप देख सकते हैं, सीमांकक एक पूर्ण नियमित अभिव्यक्ति हो सकती है।

सरणियों के अलावा, संग्रह का उपयोग करना संभव है, अर्थात् सूचियां। यहां एक शर्त आवश्यक है - कॉन्फ़िगरेशन को पढ़ना शुरू करने से पहले संग्रह को आरंभीकृत किया जाना चाहिए। ऐसा इसलिए है क्योंकि संग्रह वस्तुओं के उदाहरण अलग हो सकते हैं (ArrayList, LinkedList, आदि)।

 public class Example6 { @Cfg private static List<Integer> SOME_ARRAYLIST_COLLECTION = new ArrayList<>(); @Cfg private static List<Integer> SOME_LINKEDLIST_COLLECTION = new LinkedList<>(); } 

अन्यथा, सरणियों के सभी deserialization गुण संग्रह के लिए संरक्षित हैं।

कस्टम प्रकारों का वर्णन

एक अतिरिक्त कार्य के रूप में, पुस्तकालय कस्टम कक्षाओं के साथ काम कर सकता है। एक कस्टम प्रकार में एक निर्माता होना चाहिए: MyClass (स्ट्रिंग), अन्यथा एक अपवाद फेंक दिया जाएगा। कंस्ट्रक्टर दृश्यता स्तर मायने नहीं रखता है, यह सार्वजनिक या निजी हो सकता है:

 public class Example8 { private static class T { private final String value; private T(String value) { this.value = value; } public String getValue() { return value; } } @Cfg private static T CUSTOM_CLASS_VALUE; } 

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

पहुँच स्तर संशोधक

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

सभी वर्ग के सदस्यों का प्रारंभिक मूल्यांकन

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

 @Cfg public class Example7 { /*           */ private static int SOME_INT_VALUE = 1; private static String SOME_STRING_VALUE; private static int[] SOME_INT_ARRAY; private static double SOME_DOUBLE_VALUE; private static List<Integer> SOME_ARRAYLIST_COLLECTION = new ArrayList<>(); private static List<Integer> SOME_LINKEDLIST_COLLECTION = new LinkedList<>(); @Cfg(ignore = true) private final static Logger log = Logger.getAnonymousLogger(); } 

यहां यह लॉग क्लास के सदस्य पर ध्यान देने योग्य है। उन्हें नजरअंदाज की गई संपत्ति के साथ @ fg एनोटेशन सौंपा गया था। इस संपत्ति का मतलब है कि इस फ़ील्ड का उपयोग लाइब्रेरी द्वारा कॉन्फ़िगरेशन को पढ़ते समय नहीं किया जाएगा, लेकिन बस इसे छोड़ दिया जाएगा। इस संपत्ति का उपयोग केवल तब किया जाना चाहिए जब एनोटेशन पूरे वर्ग पर कार्य करता है, जैसा कि ऊपर दिए गए उदाहरण में दिखाया गया है।

डिफ़ॉल्ट मान

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

 /*      WRONG_PROPERTY */ @Cfg public class Example9 { private int WRONG_PROPERTY = 9000; private int SOME_INT_VALUE; } 

इस स्थिति में, कॉन्फ़िगरेशन को पार्स करने के बाद, 9000 का समान मान WRONG_PROPERTY फ़ील्ड में संग्रहीत किया जाएगा।

नाम पुनर्परिभाषित

ऐसे मामलों में जहां क्लास फ़ील्ड नाम कॉन्फ़िगरेशन फ़ाइल में कॉन्फ़िगरेशन नाम से मेल नहीं खाता है, आप इसे फिर से परिभाषित करने के लिए मजबूर कर सकते हैं:

 public class Example10 { @Cfg("SOME_INT_VALUE") private int myIntValue; } 

स्वाभाविक रूप से, यदि कोड और कॉन्फ़िगरेशन फ़ाइलों में नामों की समानता को संरक्षित करना संभव है, तो ऐसा करना बेहतर है - इससे कक्षा के प्रत्येक क्षेत्र को एनोटेट करने की आवश्यकता समाप्त हो जाती है।

गैर-स्थिर वर्ग क्षेत्रों के साथ काम करना

पुस्तकालय दोनों वर्गों और उनके उदाहरणों के साथ काम करने में सक्षम है। यह configParser.parse () विधि के लिए विभिन्न कॉल द्वारा निर्धारित किया जाता है:

 @Cfg public class Example11 { private static int SOME_SHORT_VALUE; private int SOME_INT_VALUE; public static void main(String[] args) throws NoSuchMethodException, InstantiationException, IllegalAccessException, IOException, InvocationTargetException { ConfigParser.parse(Example11.class, "config/example.ini"); //        SOME_INT_VALUE ConfigParser.parse(new Example11(), "config/example.ini"); } } 

जैसा कि आप देख सकते हैं, उदाहरण एक ही विधि के दो अलग-अलग कॉल का उपयोग करता है। ConfigParser.parse मेथड (उदाहरण11.class, "config / example.ini") पर काम करने के बाद, SOME_INT_VALUE शून्य हो जाएगा, और यह कॉन्फ़िगरेशन फ़ाइल से पूरी तरह स्वतंत्र है, क्योंकि यह फ़ील्ड स्थिर नहीं है और इसे ऑब्जेक्ट के इंस्टेंस के बिना उपयोग नहीं किया जा सकता है।

ConfigParser.parse (नया उदाहरण 11 (), "config / example.ini") के दूसरे कॉल के तुरंत बाद, बनाई गई ऑब्जेक्ट के लिए SOME_INT_VALUE फ़ील्ड कॉन्फ़िगरेशन फ़ाइल की सामग्री के अनुसार मूल्य पर ले जाती है।

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

विधियों का उपयोग करना

आइए कल्पना करें कि कॉन्फ़िगरेशन फ़ाइल से एक संपत्ति को पढ़ते समय, आपको इसकी सामग्री की जांच करने की आवश्यकता है, या, उदाहरण के लिए, एक विशेष तरीके से सामग्री को वशीकरण करें।

ऐसी स्थितियों में तीन समाधान हैं:

1. लाइब्रेरी की सेटिंग फ़ाइल का विश्लेषण करने और कक्षा के सभी क्षेत्रों को भरने के बाद स्वतंत्र रूप से मूल्य की जाँच करें या बदलें
2. कंस्ट्रक्टर के साथ अपना रैपर क्लास टाइप करें (जैसा कि ऊपर दिखाया गया है)
3. संपत्ति सूची से वर्ग फ़ील्ड को बाहर करें और इसे विधि को असाइन करें

सबसे सुविधाजनक और सही तरीका नंबर 3 है। NProperty पुस्तकालय आपको न केवल खेतों के साथ काम करने की अनुमति देता है, बल्कि विधियों के साथ भी:

 public class Example12 { private static List<Integer> VALUE_CHECK = new ArrayList<>(); @Cfg("SOME_INT_ARRAY") private void checkIntArray(String value) { String[] values = value.split("--"); for (String val : values) { try { /*    [0,100] */ VALUE_CHECK.add(Math.max(0, Math.min(100, Integer.parseInt(val)))); } catch (Exception ignored) {} } } } 

यहां, कॉन्फ़िगरेशन फ़ाइल से SOME_INT_ARRAY का मान पहले पैरामीटर के रूप में checkIntArray (स्ट्रिंग) विधि को दिया जाएगा। यह उन मामलों के लिए बहुत सुविधाजनक तंत्र है जब मानक पुस्तकालय समाधान उपयुक्त नहीं हैं। आप हैंडलर विधि में कुछ भी कर सकते हैं।

हालांकि, यह ध्यान देने योग्य है कि विधियों के साथ काम करने के मामले में पुस्तकालय विभाजक तंत्र का उपयोग नहीं करता है, अर्थात्, इस समय संपत्ति के स्वचालित विभाजन को एक सरणी में व्यवस्थित करना असंभव है।

यदि विधि का पहला पैरामीटर का प्रकार स्ट्रिंग से भिन्न है, तो टाइप रूपांतरण अभी भी समर्थित है।

क्लास फ़ील्ड्स की तरह, यदि कॉन्फ़िगरेशन फ़ाइल में विधि का नाम सेटिंग के नाम के बराबर है, तो आप एनोटेशन में नाम सेटिंग को छोड़ सकते हैं।

इवेंट हैंडलिंग

NProperty लाइब्रेरी आपको कॉन्फ़िगरेशन पढ़ते हुए कुछ घटनाओं को संभालने की अनुमति देता है। ईवेंट हैंडलिंग को लागू करने के लिए, IPropertyListener इंटरफ़ेस और उसके सभी तरीकों को लागू करना आवश्यक है। ईवेंट पूर्णरूपेण ऑब्जेक्ट्स के साथ काम करने पर ही उठाए जा सकते हैं, ऐसे वर्ग के उदाहरण जो IPropertyLiveener इंटरफेस को लागू करते हैं।

समर्थित घटनाएँ:

• onStart (स्ट्रिंग पथ) - कॉन्फ़िगरेशन फ़ाइल लोड करने से पहले भेजा गया
• onPropertyMiss (स्ट्रिंग नाम) - अगर कुछ नामित कॉन्फ़िगरेशन सेटिंग्स फ़ाइल में नहीं मिला था, तो कॉल किया गया था, लेकिन @ fg एनोटेशन द्वारा वर्ग में इंगित किया गया था
• onDone (स्ट्रिंग पथ) - कॉन्फ़िगरेशन फ़ाइल का डाउनलोड पूरा होने पर कहा जाता है
• onInvalidPropertyCast (स्ट्रिंग नाम, स्ट्रिंग मान) - उस समय कहा जाता है जब कॉन्फ़िगरेशन फ़ाइल से सेटिंग मान को पढ़ना संभव था, लेकिन इस मान को संबंधित वर्ग फ़ील्ड के प्रकार में नहीं डाल सका।

 @Cfg public class Example13 implements IPropertyListener { public int SOME_INT_VALUE; public int SOME_MISSED_VALUE; public int SOME_INT_ARRAY; @Override public void onStart(String path) { } @Override public void onPropertyMiss(String name) { } @Override public void onDone(String path) { } @Override public void onInvalidPropertyCast(String name, String value) { } public static void main(String[] args) throws NoSuchMethodException, InstantiationException, IllegalAccessException, IOException, InvocationTargetException { ConfigParser.parse(new Example13(), "config/example.ini"); } } 

उपरोक्त उदाहरण में, सभी 4 घटनाओं को ट्रिगर किया जाएगा। OnPropertyMiss इवेंट SOME_MISSED_VALUE फ़ील्ड के कारण उठाया जाएगा, जो कॉन्फ़िगरेशन फ़ाइल में नहीं है। एक अमान्य फ़ील्ड प्रकार SOME_INT_ARRAY के कारण onInvalidPropertyCast घटना को उठाया जाएगा।

स्ट्रीम और फ़ाइल डिस्क्रिप्टर का उपयोग करना

लाइब्रेरी न केवल नाम को इनपुट के रूप में स्वीकार कर सकती है, यह java.io.File ऑब्जेक्ट, या अमूर्त वर्ग java.io.InputStream से प्राप्त डेटा स्ट्रीम को स्थानांतरित करना भी संभव है:

 @Cfg public class Example14 { public int SOME_INT_VALUE; public int SOME_MISSED_VALUE; public int SOME_INT_ARRAY; public static void main(String[] args) throws NoSuchMethodException, InstantiationException, IllegalAccessException, IOException, InvocationTargetException { ConfigParser.parse(new Example14(), "config/example.ini"); ConfigParser.parse(new Example14(), new File("config", "example.ini")); ConfigParser.parse(new Example14(), new FileInputStream("config/example.ini"), "config/example.ini"); } } 

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

इस प्रकार, डेटा न केवल फ़ाइल सिस्टम से प्राप्त किया जा सकता है, बल्कि जावा मानकों के अनुसार काम करने वाले किसी भी डेटा स्रोत से भी प्राप्त किया जा सकता है। Java.io.InputStream के साथ काम करने की क्षमता लाइब्रेरी को एंड्रॉइड ऑपरेटिंग सिस्टम में सफलतापूर्वक उपयोग करने में सक्षम बनाती है:

 @Cfg public class ConfigGeneral extends PropertyListenerImpl { public static String SERVER_IP; public static int SERVER_PORT; private ConfigGeneral() { String path = "config/network/general.ini"; try { InputStream input = getApplicationContext().getResources().getAssets().open(path); ConfigParser.parse(this, input, path); } catch(Exception e) { Log.e(TAG, "Failed to Load " + path + " File.", e); } } public static void loadConfig() { new ConfigGeneral(); } } 

टिप्पणी

SecurityManager के बहुत पारदर्शी संचालन के कारण, लायब्रेरी को सेट करने के लिए कॉन्फ़िगरेशन फ़ील्ड के प्रकार पर प्रतिबंध है: फ़ील्ड में अंतिम संशोधक नहीं होना चाहिए ।

लाइसेंस

पुस्तकालय को Apache लाइसेंस v.2.0 के तहत लाइसेंस प्राप्त है

संदर्भ

• Google कोड पर स्रोत और निर्माण
• लेखक के ब्लॉग में मूल लेख