JCommander入門指南：如何實現命令行參數解析

一、什麼是JCommander？

JCommander是一個包含在Java中的命令行解析器。在編寫應用程序時，JCommander可以幫助您快速、輕鬆地解析命令行參數。它支持選項和參數，以及必需和可選值，還可以注釋解析器以提高可讀性。

二、如何安裝JCommander？

要使用JCommander，您需要在項目的Maven pom.xml中添加以下依賴項：

<dependency>
    <groupId>com.beust</groupId>
    <artifactId>jcommander</artifactId>
    <version>1.71</version>
</dependency>

然後，您可以使用以下命令將依賴項添加到您的項目中：

mvn install

三、如何在應用程序中使用JCommander？

以下是一個示例應用程序，它使用JCommander解析命令行參數：

import com.beust.jcommander.JCommander;
import com.beust.jcommander.Parameter;

public class MyApp {
    @Parameter(names = { "-log", "-verbose" }, description = "Level of verbosity")
    private Integer verbose = 1;

    @Parameter(names = "-groups", description = "Comma-separated list of group names to be run")
    private String groups;

    @Parameter(names = "-debug", description = "Debug mode")
    private boolean debug = false;

    public static void main(String... argv) {
        MyApp myApp = new MyApp();
        JCommander.newBuilder()
            .addObject(myApp)
            .build()
            .parse(argv);
        myApp.run();
    }

    public void run() {
        System.out.println("Verbose: " + verbose);
        System.out.println("Groups: " + groups);
        System.out.println("Debug: " + debug);
    }
}

在這個示例中，我們定義了三個參數：verbose、groups和debug。@Parameter注釋用於定義參數的名稱和描述。在main()方法中，我們創建了一個MyApp實例，並使用JCommander解析命令行參數。最後，我們調用MyApp的run()方法列印參數值。

在命令行中，我們可以使用以下方式傳遞參數：

java MyApp -log 2 -groups unit1,unit2 -debug

運行結果如下：

Verbose: 2
Groups: unit1,unit2
Debug: true

四、JCommander支持的參數類型

JCommander支持各種參數類型，包括字元串、整數、長整數、短整數、布爾值、浮點數等等。例如，下面的代碼片段展示了如何在JCommander中定義一個布爾標誌，並將其轉換為Java中的布爾值：

@Parameter(names = { "-debug" }, description = "Debug mode")
private boolean debug = false;

public void run() {
    if (debug) {
        // do something in debug mode
    }
}

在命令行中可以這樣傳遞參數：

java MyApp -debug

五、處理多值參數

除了單個字元串，我們還可以定義列表、數組和集合。例如，以下代碼展示了如何在JCommander中定義一個字元串列表：

@Parameter(names = { "-hosts" }, description = "Comma-separated list of hostnames")
private List<String> hosts;

在命令行中我們可以這樣傳遞參數：

java MyApp -hosts host1,host2,host3

然後，您可以使用hosts變數來執行操作。

六、定義參數組

如果有一組參數共享同樣的含義，我們可以使用參數組。以下示例展示了如何在JCommander中定義參數組：

@Parameters(commandDescription = "Connect command")
public class ConnectCommand {
  @Parameter(names = { "-hostname" }, description = "The hostname to connect to")
  public String hostname;

  @Parameter(names = { "-port" }, description = "The port number to connect to")
  public int port;
}

@Parameters(commandDescription = "Disconnect command")
public class DisconnectCommand {
  @Parameter(names = "-force", description = "Forcibly disconnect")
  public boolean force = false;
}

public static void main(String[] args) throws Exception {
  JCommander jc = new JCommander();
  ConnectCommand connect = new ConnectCommand();
  jc.addCommand("connect", connect);
  DisconnectCommand disconnect = new DisconnectCommand();
  jc.addCommand("disconnect", disconnect);
  jc.parse(args);

  if (jc.getParsedCommand() == null) {
      // no command specified
      return;
  }

  switch (jc.getParsedCommand()) {
  case "connect":
      // do something with connect command
      break;
  case "disconnect":
      // do something with disconnect command
      break;
  }
}

在這個示例中，我們定義了兩個參數組：ConnectCommand和DisconnectCommand。在main()方法中，我們將這兩個參數組添加到JCommander中，並根據用戶選擇的命令執行相應操作。

七、自定義類型轉換器

如果您需要解析自定義類型的參數，您可以編寫自己的類型轉換器。以下是一個示例類型轉換器，它將由逗號分隔的字元串轉換為Person對象：

public class PersonConverter implements IStringConverter<Person> {
  public Person convert(String value) {
    String[] parts = value.split(",");
    String firstName = parts[0];
    String lastName = parts[1];
    return new Person(firstName, lastName);
  }
}

然後，我們可以在@Parameter注釋中使用此類型轉換器：

@Parameter(names = { "-person" }, description = "Person object (format: firstName,lastName)", converter = PersonConverter.class)
private Person person;

在命令行中傳遞參數：

java MyApp -person John,Doe

八、注釋解析器

最後，您可以增加@Description注釋來提高可讀性，使您的命令行參數更易於理解。以下是一個示例：

@Parameters(commandDescription = "Run command")
public class RunCommand {
  @Parameter(names = { "-file" }, description = "File to run")
  @Description("The path to the file that should run")
  public String filepath;
}

在這個示例中，我們使用@Description注釋來提供更詳細的說明，幫助用戶更好地了解我們的命令行參數。

九、總結

在本指南中，我們介紹了JCommander命令行參數解析器的基本功能。JCommander可以幫助開發人員更輕鬆地與用戶交互，並提供各種各樣的參數類型、參數組和類型轉換器等功能。通過這項技術，開發人員可以編寫更具可讀性和易維護性的命令行應用程序。