位置参数
位置信息主要与命令目标方法相关
CommandRegistration.builder()
.withOption()
.longNames("arg1")
.position(0)
.and()
.build();
使用位置参数时请谨慎,很快就会让人混淆它们映射到哪个选项。 |
通常,当参数在命令行中定义时(无论是长选项还是短选项),它们会映射到一个选项。通常来说,有选项(options)、选项参数(option arguments)和参数(arguments),其中后者是那些没有映射到任何特定选项的参数。
未识别的参数可以有一个次要映射逻辑,其中位置信息很重要。通过选项位置,您实际上是在告诉命令解析如何解释原始的、不明确的普通参数。
让我们看看当我们不定义位置时会发生什么。
CommandRegistration.builder()
.command("arity-strings-1")
.withOption()
.longNames("arg1")
.required()
.type(String[].class)
.arity(0, 2)
.and()
.withTarget()
.function(ctx -> {
String[] arg1 = ctx.getOptionValue("arg1");
return "Hello " + Arrays.asList(arg1);
})
.and()
.build();
选项 arg1 是必需的,并且没有关于如何处理参数 one
的信息,导致缺少选项的错误。
shell:>arity-strings-1 one
Missing mandatory option --arg1.
现在让我们定义位置 0
。
CommandRegistration.builder()
.command("arity-strings-2")
.withOption()
.longNames("arg1")
.required()
.type(String[].class)
.arity(0, 2)
.position(0)
.and()
.withTarget()
.function(ctx -> {
String[] arg1 = ctx.getOptionValue("arg1");
return "Hello " + Arrays.asList(arg1);
})
.and()
.build();
参数会被处理,直到我们得到最多 2 个参数。
shell:>arity-strings-2 one
Hello [one]
shell:>arity-strings-2 one two
Hello [one, two]
shell:>arity-strings-2 one two three
Hello [one, two]