此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Shell 3.3.3！spring-doc.cn

命令注册

定义命令注册是介绍命令结构及其选项的第一步和参数。这与后面发生的事情松散地解耦，例如解析命令行输入和运行实际目标代码。从本质上讲，它是向用户显示的命令 API 的定义。spring-doc.cn

命令

结构中的命令定义为命令数组。这将产生一个结构，类似于以下示例：spring-shellspring-doc.cn

command1 sub1
command2 sub1 subsub1
command2 sub2 subsub1
command2 sub2 subsub2

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

交互模式

Spring Shell 被设计为在两种模式下工作：交互式（本质上是是您在一系列命令中拥有活动 shell 实例的位置）和非交互式（命令从命令行逐个执行）。REPLspring-doc.cn

这些模式之间的差异主要在于对可以执行的操作的限制在每种模式下。例如，显示以前的 stacktrace 是不可行的如果 shell 不再处于活动状态，则命令的命令。通常，shell 是否仍处于活动状态指示可用信息。spring-doc.cn

此外，处于活动会话中可能会提供有关用户所经历的更多信息在活动会话中执行。REPLspring-doc.cn

选项

选项可以定义为 long 和 short，其中前缀分别为和。以下示例显示了 long 和 short 选项：---spring-doc.cn

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

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

目标

目标定义命令的执行目标。它可以是 POJO 中的一个方法， a 或 .ConsumerFunctionspring-doc.cn

方法

在现有 POJO 中使用 a 是定义目标的一种方法。请考虑以下类：Methodspring-doc.cn

public static class CommandPojo {

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

给定前面清单中显示的现有类，然后你可以注册它的方法：spring-doc.cn

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

功能

使用 a 作为目标可以灵活地处理发生在命令执行中，因为您可以使用 a 给定为 a .的返回类型为然后是打印到 shell 中的内容。请考虑以下示例：FunctionCommandContextFunctionFunctionspring-doc.cn

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();

消费者

使用 a 与使用基本相同，区别在于没有 return 类型。如果你需要将某些东西打印到 shell 中，您可以从上下文中获取对 a 的引用并打印一些内容通过它。请考虑以下示例：ConsumerFunctionTerminalspring-doc.cn

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();