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

2024-05-19 • 问答

在这种情况下，我需要具有三个强制性参数（field1，field2和field3。然后，我希望用户输入command name（强制性，值可以是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());

        }
    }
}

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

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

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

execute方法要求子命令是实现@Command或@Command的带有Runnable注释的方法或带有Callable注释的类。

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

@Command(name = "cli",mixinStandardHelpOptions = true,version = "1.0")
public class Cli {
    @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 static void main(String[] args) {
        int exitCode = new CommandLine(new Cli()).execute(args);
        System.exit(exitCode);
    }
}

@Command(name = "create",description = "create ...",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",version = "1.0")
class ListObjects implements Runnable {
    @Option(names = {"-x",description = "...")
    int x;

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

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

jxdlzz 回答：使用Picocli，我如何需要位置参数，然后根据位置参数的值要求可选参数

大家都在问