讓用戶用命令行選項(xiàng)調(diào)整你的 Java 應(yīng)用程序運(yùn)行方式。
通常向終端中輸入命令時(shí)，無(wú)論是啟動(dòng) GUI 應(yīng)用程序還是僅啟動(dòng)終端應(yīng)用程序，都可以使用 命令行選項(xiàng)options or switches or flags (以下簡(jiǎn)稱選項(xiàng))來(lái)修改應(yīng)用程序的運(yùn)行方式。這是 POSIX 規(guī)范 設(shè)定的標(biāo)準(zhǔn)，因此能夠檢測(cè)和解析選項(xiàng)對(duì) Java 程序員而言是很有用的技能。
Java 中有若干種解析選項(xiàng)的方法，其中我最喜歡用的是 Apache Commons CLI 庫(kù)，簡(jiǎn)稱 commons-cli。
安裝 commons-cli
如果你使用類似 Maven 之類的項(xiàng)目管理系統(tǒng)以及集成開(kāi)發(fā)環(huán)境Integrated Development Environment(簡(jiǎn)稱 IDE)，可以在項(xiàng)目屬性(比如 pom.xml 配置文件或者 Eclipse 和 NetBeans 的配置選項(xiàng)卡)中安裝 Apache Commons CLI 庫(kù)。
而如果你采用手動(dòng)方式管理庫(kù)，則可以從 Apache 網(wǎng)站下載 該庫(kù)的最新版本。下載到本地的是幾個(gè)捆綁在一起的 JAR 文件，你只需要其中的一個(gè)文件 commons-cli-X.Y.jar(其中 X 和 Y 代指最新版本號(hào))。把這個(gè) JAR 文件或手動(dòng)或使用 IDE 添加到項(xiàng)目，就可以在代碼中使用了。
將庫(kù)導(dǎo)入至 Java 代碼
在使用 commons-cli 庫(kù)之前，必須首先導(dǎo)入它。對(duì)于本次選項(xiàng)解析的簡(jiǎn)單示例而言，可以先在 Main.java 文件中簡(jiǎn)單寫入以下標(biāo)準(zhǔn)代碼：
- package com.opensource.myoptparser;
- import org.apache.commons.cli.*;
- public class Main {
- public static void main(String[] args) {
- // code
- }
- }
至此在 Java 中解析選項(xiàng)的準(zhǔn)備工作已經(jīng)做好了。
在 Java 中定義布爾選項(xiàng)
要實(shí)現(xiàn)解析選項(xiàng)，首先要定義應(yīng)用程序可接收的有效選項(xiàng)。使用 Option(注意是單數(shù))類來(lái)創(chuàng)建選項(xiàng)對(duì)象，使用 Options(注意是復(fù)數(shù))類來(lái)追蹤項(xiàng)目中創(chuàng)建的所有選項(xiàng)。
首先為選項(xiàng)創(chuàng)建一個(gè)組，按照慣例命名為 options：
- //code
- Options options = new Options();
接下來(lái)，通過(guò)列出短選項(xiàng)(即選項(xiàng)名簡(jiǎn)寫)、長(zhǎng)選項(xiàng)(即全寫)、默認(rèn)布爾值(LCTT 譯注：設(shè)置是否需要選項(xiàng)參數(shù)，指定為 false 時(shí)此選項(xiàng)不帶參，即為布爾選項(xiàng))和幫助信息來(lái)定義選項(xiàng)，然后設(shè)置該選項(xiàng)是否為必需項(xiàng)(LCTT 譯注：下方創(chuàng)建 alpha 對(duì)象的代碼中未手動(dòng)設(shè)置此項(xiàng))，最后將該選項(xiàng)添加到包含所有選項(xiàng)的 options 組對(duì)象中。在下面幾行代碼中，我只創(chuàng)建了一個(gè)選項(xiàng)，命名為 alpha：
- //define options
- Option alpha = new Option("a", "alpha", false, "Activate feature alpha");
- options.addOption(alpha);
在 Java 中定義帶參選項(xiàng)
有時(shí)用戶需要通過(guò)選項(xiàng)提供 true 或 false 以外的信息，比如給出配置文件、輸入文件或諸如日期、顏色這樣的設(shè)置項(xiàng)值。這種情況可以使用 builder 方法，根據(jù)選項(xiàng)名簡(jiǎn)寫為其創(chuàng)建屬性(例如，-c 是短選項(xiàng)，--config 是長(zhǎng)選項(xiàng))。完成定義后，再將定義好的選項(xiàng)添加到 options 組中：
- Option config = Option.builder("c").longOpt("config")
- .argName("config")
- .hasArg()
- .required(true)
- .desc("set config file").build();
- options.addOption(config);
builder 函數(shù)可以用來(lái)設(shè)置短選項(xiàng)、長(zhǎng)選項(xiàng)、是否為必需項(xiàng)(本段代碼中必需項(xiàng)設(shè)置為 true，也就意味著用戶啟動(dòng)程序時(shí)必須提供此選項(xiàng)，否則應(yīng)用程序無(wú)法運(yùn)行)、幫助信息等。
使用 Java 解析選項(xiàng)
定義并添加所有可能用到的選項(xiàng)后，需要對(duì)用戶提供的參數(shù)進(jìn)行迭代處理，檢測(cè)是否有參數(shù)同預(yù)設(shè)的有效短選項(xiàng)列表中的內(nèi)容相匹配。為此要?jiǎng)?chuàng)建命令行 CommandLine 本身的一個(gè)實(shí)例，其中包含用戶提供的所有參數(shù)(包含有效選項(xiàng)和無(wú)效選項(xiàng))。為了處理這些參數(shù)，還要?jiǎng)?chuàng)建一個(gè) CommandLineParser 對(duì)象，我在代碼中將其命名為 parser。最后，還可以創(chuàng)建一個(gè) HelpFormatter 對(duì)象(我將其命名為 helper)，當(dāng)參數(shù)中缺少某些必需項(xiàng)或者用戶使用 --help 或 -h 選項(xiàng)時(shí)，此對(duì)象可以自動(dòng)向用戶提供一些有用的信息。
- // define parser
- CommandLine cmd;
- CommandLineParser parser = new BasicParser();
- HelpFormatter helper = new HelpFormatter();
最后，添加一些條件判斷來(lái)分析用戶提供的選項(xiàng)，我們假設(shè)這些選項(xiàng)已經(jīng)作為命令行輸入被獲取并存儲(chǔ)在 cmd 變量中。這個(gè)示例應(yīng)用程序有兩種不同類型的選項(xiàng)，但對(duì)這兩種類型都可以使用 .hasOption 方法加上短選項(xiàng)名稱來(lái)檢測(cè)選項(xiàng)是否存在。檢測(cè)到一個(gè)存在的選項(xiàng)后，就可以對(duì)數(shù)據(jù)做進(jìn)一步操作了。
- try {
- cmd = parser.parse(options, args);
- if(cmd.hasOption("a")) {
- System.out.println("Alpha activated");
- }
- if (cmd.hasOption("c")) {
- String opt_config = cmd.getOptionValue("config");
- System.out.println("Config set to " + opt_config);
- }
- } catch (ParseException e) {
- System.out.println(e.getMessage());
- helper.printHelp("Usage:", options);
- System.exit(0);
- }
解析過(guò)程有可能會(huì)產(chǎn)生錯(cuò)誤，因?yàn)橛袝r(shí)可能缺少某些必需項(xiàng)如本例中的 -c 或 --config 選項(xiàng)。這時(shí)程序會(huì)打印一條幫助信息，并立即結(jié)束運(yùn)行。考慮到此錯(cuò)誤(Java 術(shù)語(yǔ)中稱為異常)，在 main 方法的開(kāi)頭要添加語(yǔ)句聲明可能的異常：
- public static void main(String[] args) throws ParseException {
示例程序至此就大功告成了。
測(cè)試代碼
你可以通過(guò)調(diào)整傳遞給代碼的默認(rèn)參數(shù)來(lái)在 IDE 中測(cè)試應(yīng)用程序，或者創(chuàng)建一個(gè) JAR 文件并在終端運(yùn)行測(cè)試。這個(gè)過(guò)程可能會(huì)因 IDE 的不同而不同。具體請(qǐng)參閱相應(yīng)的 IDE 文檔，以及我寫過(guò)的關(guān)于如何創(chuàng)建 JAR 文件的文章，或者參考 Daniel Oh 的關(guān)于如何使用 Maven 執(zhí)行同樣操作的文章。
首先，省略必需項(xiàng) -c 或 --config 選項(xiàng)，檢測(cè)解析器的異常處理：
- $ java -jar dist/myapp.jar
- Missing required option: c
- usage: Usage:
- -a,--alpha Activate feature alpha
- -c,--config <config> Set config file
然后提供輸入選項(xiàng)再進(jìn)行測(cè)試：
- java -jar dist/myantapp.jar --config foo -a
- Alpha activated
- Config set to foo
選項(xiàng)解析
為用戶提供選項(xiàng)功能對(duì)任何應(yīng)用程序來(lái)說(shuō)都是很重要的。有了 Java 和 Apache Commons，要實(shí)現(xiàn)這個(gè)功能并不難。
以下是完整的演示代碼，供讀者參考：
- package com.opensource.myapp;
- import org.apache.commons.cli.*;
- public class Main {
- /**
- * @param args the command line arguments
- * @throws org.apache.commons.cli.ParseException
- */
- public static void main(String[] args) throws ParseException {
- // define options
- Options options = new Options();
- Option alpha = new Option("a", "alpha", false, "Activate feature alpha");
- options.addOption(alpha);
- Option config = Option.builder("c").longOpt("config")
- .argName("config")
- .hasArg()
- .required(true)
- .desc("Set config file").build();
- options.addOption(config);
- // define parser
- CommandLine cmd;
- CommandLineParser parser = new BasicParser();
- HelpFormatter helper = new HelpFormatter();
- try {
- cmd = parser.parse(options, args);
- if(cmd.hasOption("a")) {
- System.out.println("Alpha activated");
- }
- if (cmd.hasOption("c")) {
- String opt_config = cmd.getOptionValue("config");
- System.out.println("Config set to " + opt_config);
- }
- } catch (ParseException e) {
- System.out.println(e.getMessage());
- helper.printHelp("Usage:", options);
- System.exit(0);
- }
- }
- }
使用 Java 和選項(xiàng)
選項(xiàng)使用戶可以調(diào)整命令的工作方式。使用 Java 時(shí)解析選項(xiàng)的方法有很多，其中之一的 commons-cli 是一個(gè)強(qiáng)大而靈活的開(kāi)源解決方案。記得在你的下一個(gè) Java 項(xiàng)目中嘗試一下哦。
原文地址：https://linux.cn/article-13699-1.html
