java - Java CLI 解析器

Question

我知道这个问题已经被问过了，但我正在寻找具有特定功能的 Java cli 解析器。我希望它能够定义命令行树，从而使用子命令（以及不止一个级别的深度）。因此，在获得选项之前，我可以拥有 3-4 级命令。并且这些子命令是互斥的。谢谢

Answer 1

可以用JCommander完成。每个JCommander对象本质上都是一个具有任意数量的参数和/或任意数量的嵌套子命令的命令，其中顶部JCommander对象是根命令。命令参数始终特定于为其声明的命令，并且不会干扰其他命令的参数。添加子命令的界面不是很直观但是可以（见addCommandmethod()）

这是一个概念验证测试类：

public class Test{

@Test
public void nestedSubCommandTest() {
    GeneralOptions generalOpts = new GeneralOptions();
    JCommander jc = new JCommander(generalOpts);

    Command command = new Command();
    JCommander jc_command = addCommand(jc, "command", command);

    SubCommand1 subcommand1 = new SubCommand1();
    JCommander jc_subcommand1 = addCommand(jc_command, "subcommand1",
            subcommand1);

    SubCommand2 subcommand2 = new SubCommand2();
    JCommander jc_subcommand2 = addCommand(jc_subcommand1, "subcommand2",
            subcommand2);

    SubCommand3 subcommand3 = new SubCommand3();
    addCommand(jc_subcommand2, "subcommand3", subcommand3);

    jc.parse("--general-opt", 
        "command", "--opt", 
        "subcommand1",
        "subcommand2", "--sub-opt2", 
        "subcommand3", "--sub-opt3");

    assertTrue(generalOpts.opt);// --general-opt was set
    assertTrue(command.opt);// command --opt was set
    assertFalse(subcommand1.opt);// subcommand1 --sub-opt1 was not set
    assertTrue(subcommand2.opt);// subcommand2 --sub-opt2 was set
    assertTrue(subcommand3.opt);// subcommand3 --sub-opt3 was set
}

private static JCommander addCommand(JCommander parentCommand,
        String commandName, Object commandObject) {
    parentCommand.addCommand(commandName, commandObject);
    return parentCommand.getCommands().get(commandName);
}

public static class GeneralOptions {
    @Parameter(names = "--general-opt")
    public boolean opt;
}

@Parameters
public static class Command {
    @Parameter(names = "--opt")
    public boolean opt;
}

@Parameters
public static class SubCommand1 {
    @Parameter(names = "--sub-opt1")
    public boolean opt;
}

@Parameters
public static class SubCommand2 {
    @Parameter(names = "--sub-opt2")
    public boolean opt;
}

@Parameters
public static class SubCommand3 {
    @Parameter(names = "--sub-opt3")
    public boolean opt;
}
}

编辑： 如何重用命令。

解决方案1，使用继承：

  public class CommonArgs{
    @Parameter(names="--common-opt")
    public boolean isCommonOpt;
  }

  @Parameters(description = "my command 1")
  public class MyCommand1 extends CommonArgs{}

  @Parameters(description = "my command 2")
  public class MyCommand2 extends CommonArgs{}

我认为这个用法和行为很明显。一个缺点是您只能从一个类扩展，这可能会限制将来的可重用性。

解决方案 2，使用组合模式（请参阅此处的文档）：

  public class CommonArgs{
    @Parameter(names="--common-opt")
    public boolean isCommonOpt;
  }

  @Parameters(description = "my command 1")
  public class MyCommand1{
    @ParametersDelegate
    public CommonArgs commonArgs = new CommonArgs();
  }

  @Parameters(description = "my command 2")
  public class MyCommand2{
    @ParametersDelegate
    public CommonArgs commonArgs = new CommonArgs();
  }

在这里，嵌套commonArgs类的参数将被视为命令类的直接参数。您可以根据需要添加任意数量的委托，甚至可以将委托嵌套在其他委托中等等。要在解析后获取委托选项的值，只需 domyCommand1.commonArgs.isCommonOpt等。

Answer 2

picocli支持任意深度的嵌套子命令。

CommandLine commandLine = new CommandLine(new MainCommand())
        .addSubcommand("cmd1", new ChildCommand1()) // 1st level
        .addSubcommand("cmd2", new ChildCommand2())
        .addSubcommand("cmd3", new CommandLine(new ChildCommand3()) // 2nd level
                .addSubcommand("cmd3sub1", new GrandChild3Command1())
                .addSubcommand("cmd3sub2", new GrandChild3Command2())
                .addSubcommand("cmd3sub3", new CommandLine(new GrandChild3Command3()) // 3rd
                        .addSubcommand("cmd3sub3sub1", new GreatGrandChild3Command3_1())
                        .addSubcommand("cmd3sub3sub2", new GreatGrandChild3Command3_2())
                                // etc
                )
        );

您可能还喜欢它对 ANSI 样式和颜色的使用帮助。

请注意，除了选项和位置参数之外，用法帮助还列出了已注册的子命令。

使用帮助很容易通过注释进行定制。

• 基于注释的
• git 风格的子命令
• 嵌套子命令
• 强类型选项参数
• 强类型位置参数
• 可定制的类型转换
• 多值期权
• 一个字段消耗多少参数的直观模型
• 流畅的 API
• POSIX 风格的集群空头期权
• GNU 风格的长选项
• 允许任何选项前缀
• 使用帮助中的 ANSI 颜色
• 可定制的使用帮助
• 单一源文件：包含作为源，以使您的应用程序保持一个 jar

Answer 3

如果您的命令表达式很复杂，那么您可以考虑定义语法，编写其 BNF 并使用JavaCC或AntLR等库来创建自己的解析器。

Answer 4

我认为将这个多级命令拆分成几个 CLI 工具会更好。

代替：
program cmd sub-cmd sub-sub-cmd -option1 argument -option2 argument

在程序名称后附加一或两级：
program-cmd-sub-cmd sub-sub-cmd -option1 argument -option2 argument

真实单词示例：
svn-add -q -N foo.c

您可以将所有必需的类保存在单个 JAR 中（并尽可能多地重用它们），只需添加几个“主要”入口点。对于基本的 CLI 解析，我还推荐JCommander.