命令注册

定义命令注册是介绍命令及其选项和参数结构的第一步。这与之后发生的事情（例如解析命令行输入和运行实际目标代码）是松散解耦的。本质上，它定义了向用户展示的命令 API。

命令

在 spring-shell 结构中，命令被定义为一个命令数组。这会产生类似于以下示例的结构

command1 sub1
command2 sub1 subsub1
command2 sub2 subsub1
command2 sub2 subsub2

如果定义了子命令，我们目前不支持将命令映射到显式父级。例如，command1 sub1 和 command1 sub1 subsub1 不能同时注册。

交互模式

Spring Shell 设计用于两种模式：交互式（本质上是一个 REPL，您可以在一系列命令中拥有一个活动的 shell 实例）和非交互式（命令从命令行逐个执行）。

这两种模式的区别主要在于每种模式下可以执行的操作的限制。例如，如果 shell 不再活动，则显示命令的先前堆栈跟踪是不可行的。通常，shell 是否仍然活动决定了可用信息的多少。

此外，处于活动的 REPL 会话中可能会提供有关用户在活动会话中执行操作的更多信息。

选项

选项可以定义为长格式和短格式，前缀分别是 -- 和 -。以下示例展示了长格式和短格式选项

CommandRegistration.builder()
	.withOption()
		.longNames("myopt")
		.and()
	.build();

CommandRegistration.builder()
	.withOption()
		.shortNames('s')
		.and()
	.build();

目标

目标定义了命令的执行对象。它可以是 POJO 中的方法、一个 Consumer 或一个 Function。

方法

在现有 POJO 中使用 Method 是定义目标的一种方式。考虑以下类

public static class CommandPojo {

	String command(String arg) {
		return arg;
	}
}

给定前面列表中所示的现有类，您可以注册其方法

CommandPojo pojo = new CommandPojo();
CommandRegistration.builder()
	.command("command")
	.withTarget()
		.method(pojo, "command")
		.and()
	.withOption()
		.longNames("arg")
		.and()
	.build();

Function

使用 Function 作为目标为处理命令执行中的情况提供了很大的灵活性，因为您可以使用提供给 Function 的 CommandContext 手动处理许多事情。然后，Function 的返回类型将作为结果打印到 shell 中。考虑以下示例

CommandRegistration.builder()
	.command("command")
	.withTarget()
		.function(ctx -> {
			String arg = ctx.getOptionValue("arg");
			return String.format("hi, arg value is '%s'", arg);
		})
		.and()
	.withOption()
		.longNames("arg")
		.and()
	.build();

Consumer

使用 Consumer 与使用 Function 基本相同，不同之处在于没有返回类型。如果需要向 shell 打印内容，可以从上下文中获取 Terminal 的引用并通过它进行打印。考虑以下示例

CommandRegistration.builder()
	.command("command")
	.withTarget()
		.consumer(ctx -> {
			String arg = ctx.getOptionValue("arg");
			ctx.getTerminal().writer()
				.println(String.format("hi, arg value is '%s'", arg));
		})
	.and()
	.withOption()
		.longNames("arg")
		.and()
	.build();