java - 使用 Picocli,我如何需要一个位置参数,然后是可选参数,具体取决于位置参数的值
问题描述
我有一种情况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
创建单独的命令类并将其注册为父命令的子命令来执行此操作。如果您的子命令有很多选项,您可能希望为它创建一个单独的类。
创建子命令后,您需要调用用户指定的子命令的逻辑。您可以使用该CommandLine.parseArgs
方法手动执行此操作,但这需要大量工作。我建议改用该CommandLine.execute
方法。
该execute
方法将解析用户输入,处理--help
和--version
请求,处理无效的用户输入,最后(如果用户输入有效)调用用户指定的子命令的业务逻辑。它还将返回一个退出代码。
该execute
方法要求子命令是带@Command
注释的方法或实现或的带@Command
注释的类。Runnable
Callable
下面是一个基于您的示例代码的示例,作为子命令实现。
@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...
}
}
推荐阅读
- python - 在 Python 中映射 json 中的 forsquare 数据
- php - 如何在 spatie/laravel-permission 中使用 UUID
- php - PHP检查数组中的多个值是否全部为正或全部为负或部分
- macos - 更改mac中正在运行的进程的环境变量
- android - 尝试使用 HC-05 板(连接到 Arduino)了解蓝牙连接上的数据传输行为(滞后)
- java - 可选的
无法转换为 Int(用于 GUI 进度条) - jquery - 如何检查元素的值是否已更改?
- php - GA php-server 获取特殊页面浏览量
- reactjs - 在页面重新加载之间直接访问 redux 存储以访问和保持状态是一种不好的做法吗
- c# - OnTextChanged 在必需的属性验证后不会触发