Arity 定义了选项解析需要多少参数。

与arity设置相比和使用存在局限性。这些在注释中提到 以下示例。legacy annotationannotationprogrammatic
与arity设置相比和使用存在局限性。这些在注释中提到 以下示例。legacy annotationannotationprogrammatic

  • Programmatic

  • Annotation

  • Legacy Annotation

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.可选Arity
价值 最小值/最大值

零

0 / 0

ZERO_OR_ONE

0 / 1

EXACTLY_ONE

1 / 1

ZERO_OR_MORE

0 / 整数 MAX

ONE_OR_MORE

1 / 整数 MAX
legacy annotation不支持定义最小 arity。
legacy annotation不支持定义最小 arity。

  • Programmatic

  • Annotation

  • Legacy Annotation

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 不匹配。

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.