阿尔蒂

Arity 定义了选项解析需要多少个参数。spring-doc.cn

与 arity 设置相比和使用存在限制。这些在下面是示例。legacy annotationannotationprogrammatic

Programmaticspring-doc.cn
Annotationspring-doc.cn
Legacy Annotationspring-doc.cn

CommandRegistration zeroOrOne() {
	return CommandRegistration.builder()
		.command("example")
		.withOption()
			.longNames("arg")
			.arity(OptionArity.ZERO_OR_ONE)
			.and()
		.build();
}

@Command(command = "example")
String zeroOrOne(
	@Option(arity = OptionArity.ZERO_OR_ONE) String arg)
{
	return String.format("Hi '%s'", arg);
}

@ShellMethod(key = "example")
String zeroOrOne(
	@ShellOption(arity = 1) String arg)
{
	return String.format("Hi '%s'", arg);
}

表 1.OptionArity
值	最小/最大
零spring-doc.cn	0 / 0spring-doc.cn
ZERO_OR_ONEspring-doc.cn	0 / 1spring-doc.cn
EXACTLY_ONEspring-doc.cn	1 / 1spring-doc.cn
ZERO_OR_MOREspring-doc.cn	0 / 整数最大值spring-doc.cn
ONE_OR_MOREspring-doc.cn	1 / 整数 MAXspring-doc.cn

legacy annotation不支持定义最小 ARITY。

Programmaticspring-doc.cn
Annotationspring-doc.cn
Legacy Annotationspring-doc.cn

CommandRegistration zeroOrOneWithMinMax() {
	return CommandRegistration.builder()
		.command("example")
		.withOption()
			.longNames("arg")
			.arity(0, 1)
			.and()
		.build();
}

@Command(command = "example")
String zeroOrOneWithMinMax(
	@Option(arityMin = 0, arityMax = 1) String arg)
{
	return String.format("Hi '%s'", arg);
}

@ShellMethod(key = "example")
String zeroOrOneWithMinMax(
	@ShellOption(arity = 1) String arg)
{
	return String.format("Hi '%s'", arg);
}

在下面的示例中，我们有选项 arg1，它被定义为类型 String[]。阿尔蒂定义它至少需要 1 个参数，而不是超过 2 个参数。如下所示引发特殊异常 TooManyArgumentsOptionException 和 NotEnoughArgumentsOptionException 以指示 arity 不匹配。spring-doc.cn

shell:>e2e reg arity-errors --arg1
Not enough arguments --arg1 requires at least 1.

shell:>e2e reg arity-errors --arg1 one
Hello [one]

shell:>e2e reg arity-errors --arg1 one two
Hello [one, two]

shell:>e2e reg arity-errors --arg1 one two three
Too many arguments --arg1 requires at most 2.