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

JCommander的網頁上指出：“因為生命太短，無法解析命令行參數”，并且概述將JCommander引入為“一個很小的Java框架，使得解析命令行參數變得微不足道。” 本文中的代碼示例和執行代碼的關聯屏幕快照均基于JCommander 1.72 （2017年6月）。 此處顯示的演示的完整代碼可在GitHub上找到 。

JCommander使用批注來實現命令行處理的“定義”階段。 下一個代碼清單片段中對此進行了演示。

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批注通過類字段的批注來定義命令行選項。 這些示例演示了names說明，以指示與單個選項關聯的多個選項標志；提供description以提供每個選項的說明； required=true以強制存在命令行參數， help=true以指示“幫助”。 ”或“使用”命令行參數（指示JCommander如果未提供必需的參數也不要拋出異常）。

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

通過對剛剛實例化的JCommander實例執行parse（String…）方法的單行調用，可以完成JCommander命令行處理的“解析”階段。 下一個代碼清單對此進行了演示。

使用JCommander進行“解析”階段

commander.parse(arguments);

使用JCommander進行命令行處理的“詢問”階段涉及簡單地訪問傳遞給JCommander類實例化的實例的帶注釋的字段。 下一個代碼清單對此進行了演示。

JCommander的“審訊”階段

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

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

最新的代碼清單還演示了如何通過在JCommander類的實例上調用方法JCommander （）將用法信息寫入標準輸出。 值得注意的是ParameterException也有一個usage（）方法 。

下一系列屏幕快照演示了如何將JCommander與包含上述代碼段的簡單應用程序一起使用。 第一個圖像顯示了不帶任何參數運行基于JCommander的應用程序，并顯示了在這種情況下顯示的ParameterException ，因為未指定必需的--file / -f選項。

當提供了預期的命令行參數時，下一個屏幕快照將演示“正常”執行。

下一個屏幕快照演示了“幫助”選項的使用。 由于使用help=true進行了注釋，因此缺少必需的“文件”命令行參數不會導致異常，并且自動生成的幫助/使用信息將寫入標準輸出。

JCommander提供了我非常喜歡的用于開發和學習JCommander的功能。 可以通過在JCommandBuilder上調用verbose（int）方法來指定JCommander解析的詳細 程度 。

增加JCommander的詳細程度

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

隨著冗長程度的提高，可以發現對JCommander正在執行的與命令行處理有關的更多信息，并在以下兩個屏幕快照中得以證明。

在選擇框架或庫來幫助Java進行命令行解析時，需要考慮以下JCommander的其他特征。

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

其他參考

• 指揮官
• Maven存儲庫上的JCommander
• GitHub上的JCommander源
• JCommander API （Javadoc）
• 使用JCommander的復雜行命令語法
• JCommander –輕松解析命令行參數
• 使用JCommander輕松進行命令行界面編碼
• Args4j vs JCommander用于解析命令行參數
• 使用JCommander和Spring的Java命令行標志
• JCommander與args4j

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

總結

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

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。