這是我系列的第七篇文章，簡(jiǎn)要介紹了用于處理Java命令行參數(shù)的各種庫(kù)。 這篇文章回到了基于注釋的庫(kù)的覆蓋范圍，該庫(kù)似乎是在Java中可用于處理命令行參數(shù)的眾多可用庫(kù)中知名度最高和最受歡迎的庫(kù)之一： JCommander 。

JCommander的網(wǎng)頁(yè)上指出：“因?yàn)樯?#xff0c;無(wú)法解析命令行參數(shù)”，并且概述將JCommander引入為“一個(gè)很小的Java框架，使得解析命令行參數(shù)變得微不足道。” 本文中的代碼示例和執(zhí)行代碼的關(guān)聯(lián)屏幕快照均基于JCommander 1.72 （2017年6月）。 此處顯示的演示的完整代碼可在GitHub上找到 。

JCommander使用批注來(lái)實(shí)現(xiàn)命令行處理的“定義”階段。 下一個(gè)代碼清單片段中對(duì)此進(jìn)行了演示。

JCommander的“定義”階段

/*** Demonstrates use of JCommander for Java-based command-line processing.*/ public class Main {@Parameter(names={"-v","--verbose"},description="Enable verbose logging")private boolean verbose;@Parameter(names={"-f","--file"},description="Path and name of file to use",required=true)private String file;@Parameter(names={"-h", "--help"},description="Help/Usage",help=true)private boolean help;// . . .final JCommander commander= JCommander.newBuilder().programName("JCommander Demonstration").addObject(this).build();

剛剛顯示的代碼清單演示了如何使用JCommander的@Parameter批注通過(guò)類字段的批注來(lái)定義命令行選項(xiàng)。 這些示例演示了names說(shuō)明，以指示與單個(gè)選項(xiàng)關(guān)聯(lián)的多個(gè)選項(xiàng)標(biāo)志；提供description以提供每個(gè)選項(xiàng)的說(shuō)明； required=true以強(qiáng)制存在命令行參數(shù)， help=true以指示“幫助”。 ”或“使用”命令行參數(shù)（指示JCommander如果未提供必需的參數(shù)也不要拋出異常）。

通過(guò)用@Parameter注釋注釋的類屬性，可以將帶有注釋字段的類的實(shí)例用于創(chuàng)建JCommander類的實(shí)例。 在上面的代碼示例中，我利用了JCommander.Builder以獲得與使用構(gòu)建器相關(guān)的更大的流利性和其他優(yōu)勢(shì)。 特別是，帶有注釋的類字段的實(shí)例是通過(guò)addObject（Object）方法添加的。

通過(guò)對(duì)剛剛實(shí)例化的JCommander實(shí)例執(zhí)行parse（String…）方法的單行調(diào)用，可以完成JCommander命令行處理的“解析”階段。 下一個(gè)代碼清單對(duì)此進(jìn)行了演示。

使用JCommander進(jìn)行“解析”階段

commander.parse(arguments);

使用JCommander進(jìn)行命令行處理的“詢問(wèn)”階段涉及簡(jiǎn)單地訪問(wèn)傳遞給JCommander類實(shí)例化的實(shí)例的帶注釋的字段。 下一個(gè)代碼清單對(duì)此進(jìn)行了演示。

JCommander的“審訊”階段

if (help) {commander.usage(); } else {out.println("The file name provided is '" + file + "' and verbosity is set to " + verbose); }

最后一個(gè)代碼清單演示了確定--help或-h規(guī)范是否設(shè)置名稱為help的boolean屬性的能力。 由于它是一個(gè)簡(jiǎn)單的boolean ，因此可以在條件條件中使用，如果為true ，則可以顯示幫助/使用信息。 在未設(shè)置“ help”標(biāo)志的情況下，將訪問(wèn)與其他命令行選項(xiàng)關(guān)聯(lián)的值（“ verbose” / -v / --verbose和“ file” / -f / --file ）。

最新的代碼清單還演示了如何通過(guò)在JCommander類的實(shí)例上調(diào)用方法JCommander （）將用法信息寫入標(biāo)準(zhǔn)輸出。 值得注意的是ParameterException也有一個(gè)usage（）方法 。

下一系列屏幕快照演示了如何將JCommander與包含上述代碼段的簡(jiǎn)單應(yīng)用程序一起使用。 第一個(gè)圖像顯示了不帶任何參數(shù)運(yùn)行基于JCommander的應(yīng)用程序，并顯示了在這種情況下顯示的ParameterException ，因?yàn)槲粗付ū匦璧?-file / -f選項(xiàng)。

當(dāng)提供了預(yù)期的命令行參數(shù)時(shí)，下一個(gè)屏幕快照將演示“正常”執(zhí)行。

下一個(gè)屏幕快照演示了“幫助”選項(xiàng)的使用。 由于使用help=true進(jìn)行了注釋，因此缺少必需的“文件”命令行參數(shù)不會(huì)導(dǎo)致異常，并且自動(dòng)生成的幫助/使用信息將寫入標(biāo)準(zhǔn)輸出。

JCommander提供了我非常喜歡的用于開發(fā)和學(xué)習(xí)JCommander的功能。 可以通過(guò)在JCommandBuilder上調(diào)用verbose（int）方法來(lái)指定JCommander解析的詳細(xì) 程度 。

增加JCommander的詳細(xì)程度

final JCommander commander= JCommander.newBuilder().programName("JCommander Demonstration").addObject(this).verbose(1).build();

隨著冗長(zhǎng)程度的提高，可以發(fā)現(xiàn)對(duì)JCommander正在執(zhí)行的與命令行處理有關(guān)的更多信息，并在以下兩個(gè)屏幕快照中得以證明。

在選擇框架或庫(kù)來(lái)幫助Java進(jìn)行命令行解析時(shí)，需要考慮以下JCommander的其他特征。

• JCommander是開源的，并獲得了Apache License 2.0的許可 。
• jcommander-1.72.jar大小約為68 KB，沒(méi)有第三方庫(kù)編譯依賴項(xiàng)。
• JCommander文檔提供了將JCommander與Kotlin一起使用以及將JCommander與Groovy 一起使用的示例 。
• JCommander仍然受到TestNG創(chuàng)作者Cedric Beust的積極支持， 其網(wǎng)頁(yè)反映了其現(xiàn)代/當(dāng)前的支持。

其他參考

• 指揮官
• Maven存儲(chǔ)庫(kù)上的JCommander
• GitHub上的JCommander源
• JCommander API （Javadoc）
• 使用JCommander的復(fù)雜行命令語(yǔ)法
• JCommander –輕松解析命令行參數(shù)
• 使用JCommander輕松進(jìn)行命令行界面編碼
• Args4j vs JCommander用于解析命令行參數(shù)
• 使用JCommander和Spring的Java命令行標(biāo)志
• JCommander與args4j

翻譯自: https://www.javacodegeeks.com/2017/07/java-command-line-interfaces-part-7-jcommander.html

總結(jié)

以上是生活随笔為你收集整理的Java命令行界面（第7部分）：JCommander的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。