java - 使用 Picocli，如何需要位置参数，然后根据位置参数的值需要可选参数

Question

我遇到的情况是，我需要三个强制参数(field1、field2 和 field3。然后我希望用户输入a 命令名称(必填，值可以是create、list等)。命令名称必须输入，并且必须是单数(仅可以输入其中之一)。

有些命令有参数，有些则没有。我该如何处理？

我尝试了以下操作，但出现错误:

ArgGroup has no options or positional parameters, and no subgroups

public class CliParserArgs {
    @Option(names = {"--field1"}, required = true)
    private String field1;

    @Option(names = {"--field2"}, required = true)
    String field2;

    @Option(names={"--field3"}, required = true)
    String field3;

    @Option(names = {"-h", "--help"}, usageHelp = true) boolean help;

    class Create {
        private final String val;
        public Create(final String val) {
            this.val = val;
        }
    }

    class ListObjects {
        private final String val;
        public ListObjects(final String val) {
            this.val = val;
        }
    }

    @ArgGroup(heading = "Command", exclusive = true, multiplicity = "1")
    Create create;
    ListObjects listObjects;

    public static void main(String[] args) {
        CliParserArgs cliParserArgs = new CliParserArgs();
        CommandLine cmd = new CommandLine(cliParserArgs);
        CommandLine.ParseResult parseResult = cmd.parseArgs(args);
        System.err.println("parse results: " + parseResult.matchedArgs().toString());

        try {
        if (cmd.isUsageHelpRequested()) {
            cmd.usage(System.out);
        }
        } catch (CommandLine.ParameterException e) {
            System.err.println("error: " + e.getMessage());
            System.err.println(e.getStackTrace());

        }
    }
}

Answer 1

听起来您想使用 subcommands 创建一个命令。您可以在 picocli 中通过标记 method 来执行此操作使用 @Command 注释或创建单独的命令类和 registering it as a subcommand你的 parent 的命令。如果您的子命令有很多选项，您可能需要为其创建一个单独的类。

创建子命令后，您想要调用用户指定的子命令的逻辑。您可以使用 CommandLine.parseArgs 方法手动执行此操作，但这是 lot of work 。我建议使用CommandLine.execute method相反。

execute 方法将解析用户输入，处理 --help 和 --version 请求，处理无效的用户输入，最后(如果用户输入有效)调用用户指定的子命令的业务逻辑。它还将返回退出代码。

execute 方法要求子命令是 @Command 注释的方法或实现 的 @Command 注释的类可运行或可调用。

下面是基于您的示例代码的示例，作为子命令实现。

@Command(name = "cli", version = "1.0",
    mixinStandardHelpOptions = true,
    subcommands = {Create.class, ListObjects.class})
public class Cli implements Runnable {
    @Option(names = {"--field1"}, required = true)
    private String field1;

    @Option(names = {"--field2"}, required = true)
    String field2;

    @Option(names={"--field3"}, required = true)
    String field3;

    // not needed because we have mixinStandardHelpOptions=true
    //@Option(names = {"-h", "--help"}, usageHelp = true) boolean help;

    public void run() {
        // business logic of the top-level cmd here
        System.out.println("hi, field1="+field1);
    }

    public static void main(String[] args) {
        int exitCode = new CommandLine(new Cli()).execute(args);
        System.exit(exitCode);
    }
}

@Command(name = "create", description = "create ...",
        mixinStandardHelpOptions = true, version = "1.0")
class Create implements Callable<Integer> {
    @Option(names = {"-x", "--times"}, description = "...")
    int x;

    @Override
    public Integer call() {
        // business logic for "create" here...
        return ok ? 0 : 1; // exit code support
    }
}

@Command(name = "list", description = "create ...",
        mixinStandardHelpOptions = true, version = "1.0")
class ListObjects implements Runnable {
    @Option(names = {"-x", "--times"}, description = "...")
    int x;

    @Override
    public void run() {
        // business logic for "list" here...
    }
}