कॉमन्स-क्ली 1.2 के साथ काम करें

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

पहिया को सुदृढ़ नहीं करने के लिए, मैंने तैयार लाइब्रेरी को लेने का फैसला किया। मैंने कॉमन्स-क्ली को चुना, मैं इसके लिए कुछ उदाहरणों को खोजने में कामयाब रहा और इसका उपयोग करना बहुत जटिल नहीं था।

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

तो चलिए शुरू करते हैं। कॉमन्स-क्ली विकल्पों की अवधारणा पर आधारित है। तुरंत स्पष्ट करने के लिए, आइए शब्दावली को निर्धारित करने का प्रयास करें। निम्नलिखित पंक्ति पर विचार करें:

Text.exe -l लॉगिन -पासवर्ड 123456

Test.exe प्रोग्राम को l विकल्प का उपयोग करते हुए कहा जाता है, जो स्ट्रिंग "लॉगिन" को एक तर्क के रूप में लेता है और पासवर्ड विकल्प का उपयोग करके, स्ट्रिंग "123456" के रूप में तर्क के साथ। यह अनुमान लगाना आसान है कि कार्यक्रम को प्रमाणीकरण की आवश्यकता है, लॉगिन के लिए l विकल्प जिम्मेदार है, और पासवर्ड विकल्प स्वयं पासवर्ड है। सादगी के लिए, आप शास्त्रीय तरीके से "पैरामीटर = मान" जोड़ी "विकल्प, तर्क" पर विचार कर सकते हैं।

वैसे, कॉमन्स-क्लि का उपयोग करते समय "=" चिह्न के साथ प्रवेश फॉर्म काफी स्वीकार्य है।

विकल्प बिना तर्क के हो सकते हैं या एक से अधिक तर्क हो सकते हैं। यदि विकल्प नाम में 1 अक्षर है, तो यह "-" से पहले है (चलो इसे एक साधारण "डैश" द्वारा कॉल करते हैं)। यदि विकल्प नाम में 2 या अधिक अक्षर हैं, तो आपको पासवर्ड विकल्प के साथ डैश को दोगुना करने की आवश्यकता है।

जिस शब्दावली को छांटा गया है, उससे आप सीधे कोड पर जा सकते हैं। तो यह सब विकल्पों के साथ शुरू होता है। एक विकल्प बनाएं:

Option option = new Option("l", "login", true, "Login"); 

इस मामले में, cosructor 4 पैरामीटर लेता है: विकल्प का संक्षिप्त रूप (एकल-अक्षर विकल्प), विकल्प का लंबा रूप, मापदंडों की उपस्थिति और इस विकल्प के पाठ विवरण का संकेत देने वाला एक ध्वज। हम एक विकल्प का केवल एक-अक्षर प्रतिनिधित्व या केवल एक विकल्प का एक विस्तारित प्रतिनिधित्व निर्दिष्ट कर सकते हैं, इनमें से प्रत्येक मामले में निर्माणकर्ता को 3 पैरामीटर लेने होंगे, लेकिन आप एक बहु-पत्र या एक-अक्षर विकल्प को निर्दिष्ट नहीं कर सकते, आपको कम से कम एक निर्दिष्ट करना होगा। फिर आपको यह निर्धारित करने की आवश्यकता है कि यह विकल्प तर्कों के साथ कैसे काम करेगा। कुछ इस तरह:

 option.setArgs(1); //     option.setOptionalArg(false);//      ,      ,        option.setArgName("login ");// ,           . 

ऐसा लगता है कि कोड पर टिप्पणियों से सब कुछ स्पष्ट होना चाहिए। अगर हमें तर्क (ध्वज विकल्प) के बिना एक विकल्प की आवश्यकता है, तो सेटआर्ग (0) सेट करें। एक विकल्प बनाने के बाद, इसे विकल्प ऑब्जेक्ट में जोड़ें।

 Options posixOptions = new Options(); posixOptions.addOption(option); 

अब आपको कमांड लाइन पार्सर बनाने और काम करने के लिए आवश्यक जानकारी प्रदान करने की आवश्यकता है:

 CommandLineParser cmdLinePosixParser = new PosixParser();//  Posix  CommandLine commandLine = cmdLinePosixParser.parse(posixOptions, commandLineArguments);//    

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

अब प्राप्त आदेशों को निष्पादित करना आवश्यक है, यह इस तरह किया जाता है:

 if (commandLine.hasOption(“l”)) { // ,     l,       ,        l String[] arguments = commandLine.getOptionValues(“l”);//    ,      System.out.println("We try to Login with: " + arguments[0]);//    … //   } 

जैसा कि आप देख सकते हैं, कॉमन्स-क्ली के साथ काम करना बहुत सरल है। इसके अलावा, यह पुस्तकालय कार्यक्रम के उपयोग पर मदद पाने का ध्यान रखेगा, पूरी तरह से नहीं, लेकिन बहुत सुविधा प्रदान करेगा:

 public static void printHelp( final Options options, final int printedRowWidth, final String header, final String footer, final int spacesBeforeOption, final int spacesBeforeOptionDescription, final boolean displayUsage, final OutputStream out) { final String commandLineSyntax = "java test.jar";//     final PrintWriter writer = new PrintWriter(out);//   help final HelpFormatter helpFormatter = new HelpFormatter();//     help` helpFormatter.printHelp( writer, printedRowWidth, commandLineSyntax, header, options, spacesBeforeOption, spacesBeforeOptionDescription, footer, displayUsage);//  writer.flush(); //  } 

सब कुछ स्पष्ट करने के लिए, मैं इस पद्धति को कॉल करने का एक उदाहरण दूंगा:

 printHelp( posixOptions, //     help 80, //    "Options", //    "-- HELP --", //     3, //      5, //       true, //     usage   System.out //    ); 

शायद "उपयोग स्ट्रिंग" शब्द को छोड़कर, यहां सब कुछ स्पष्ट है। मैं एक उदाहरण दूंगा जिसमें से यह स्पष्ट हो जाएगा कि इस पैरामीटर का उपयोग कैसे किया जाए। अगर सच है, तो आउटपुट कुछ इस तरह होगा:

उपयोग: जावा परीक्षण.जर [-एल] [-एच]

यदि गलत है, तो आउटपुट इस तरह होगा:

उपयोग: जावा परीक्षण

मुझे लगता है कि अंतर स्पष्ट है।

बाद वाले विकल्प के समूह हैं। उदाहरण के लिए, दो विकल्प हैं -a और -b, वे परस्पर अनन्य हैं, अर्थात, उन्हें एक ही समय में निर्दिष्ट नहीं किया जा सकता है। इस मामले के लिए, विकल्पों के समूह बनाए जाते हैं:

 OptionGroup optionGroup = new OptionGroup(); optionGroup.addOption(new Option("a", true, "A option"); optionGroup.addOption(new Option("b", true, "B option"); posixOptions.addOptionGroup(optionGroup); 

सब कुछ बहुत सरल है।

सामान्य तौर पर, पुस्तकालय ने उपयोग पर एक अच्छी छाप छोड़ी, लेकिन बहुत जल्दी यह याद किया जाने लगा। पुस्तकालय 1.2 का वर्तमान संस्करण, एक पूरी तरह से नए संस्करण 2.0 के विकास के साथ - वास्तव में, एपीआई संस्करण 2.0 के विवरण के अनुसार, हम यह कह सकते हैं कि इस संस्करण को क्लि लाइब्रेरीज़ के लिए अधिकांश आवश्यकताओं को पूरा करना चाहिए।

कॉमन्स-क्ली के पेशेवरों:

• उपयोग में आसानी
• विकल्प समूह
• लंबे और छोटे विकल्प संकेतन (-l, --login)
• निम्न प्रपत्र -ab के विकल्पों को पार्स करने की क्षमता, जब दो विकल्प होते हैं -a, -b

विपक्ष (अपनी जरूरतों से, और निश्चित रूप से वहाँ अधिक हैं):

• उप-क्षेत्र बनाने का कोई तरीका नहीं है (जैसे कि git में शाखा, स्थिति, आदि हैं) उनके विकल्पों के साथ कमांड)
• विकल्प तर्क के साथ बहुत सुविधाजनक काम नहीं है, अगर 1 से अधिक हैं

नतीजतन, एक साधारण सीएलआई के लिए - एक महान समाधान, विकल्प की तलाश में या संस्करण 2.0 के लिए प्रतीक्षा करने के लिए कुछ और गंभीर।

लेख में लिंक:

• कॉमन्स-CLI
• क्लिक्स के लिए पॉज़िक्स मानक

युपीडी। प्रॉम्प्ट पर, nord_ua ने Posix कमांड लाइन मानक का लिंक तय किया।
टाइपो को ठीक किया और कॉमन्स-क्ली का लिंक जोड़ा। धन्यवाद nik_lazarev और FractalizeR ।