附录 A：技术介绍 (Appendix A: Techical Introduction) | Spring Shellversion 3.0.10中文文档|Spring官方文档|SpringBoot 教程|Spring中文网

附录 A：技术介绍

本附录包含面向开发人员和其他希望详细了解 Spring Shell 如何作在内部工作，以及它的设计决策是什么。spring-doc.cadn.net.cn

A.1. 命令注册

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

A.1.1. 命令

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

command1 sub1
command2 sub1 subsub1
command2 sub2 subsub1
command2 sub2 subsub2

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

A.1.2. 交互模式

Spring Shell 被设计为在两种模式下工作：交互式（本质上是是一个REPL其中，您在一系列命令中有一个活动的 shell 实例），并且非交互式（命令从命令行逐个执行）。spring-doc.cadn.net.cn

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

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

A.1.3. 选项

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

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

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

A.1.4. 目标

目标定义命令的执行目标。它可以是 POJO 中的一个方法，一个Consumer或Function.spring-doc.cadn.net.cn

方法

使用Method是定义目标的一种方法。请考虑以下类：spring-doc.cadn.net.cn

public static class CommandPojo {

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

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

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

功能

使用Function作为 Target 提供了很大的灵活性来处理发生在命令执行中，因为您可以使用一个CommandContextgiven给一个Function.来自Function是然后是打印到 shell 中的内容。请考虑以下示例：spring-doc.cadn.net.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();

消费者

使用Consumer与使用Function，区别在于没有 return 类型。如果你需要将某些东西打印到 shell 中，您可以获取对Terminal从上下文中打印一些东西通过它。请考虑以下示例：spring-doc.cadn.net.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();

A.2. 命令解析器

在执行命令之前，我们需要解析命令和用户可能提供的任何选项。解析介于 Command Registration 和 Command Execution 之间。spring-doc.cadn.net.cn

A.3. 命令执行

当命令解析完成其工作并解决命令注册问题时，命令执行执行运行代码的艰苦工作。spring-doc.cadn.net.cn

A.4. 命令上下文

这CommandContextinterface 允许访问当前正在运行的上下文。您可以使用它来访问选项：spring-doc.cadn.net.cn

String arg = ctx.getOptionValue("arg");

如果你需要将某些东西打印到 shell 中，你可以获取一个Terminal并使用它的 writer 打印一些东西：spring-doc.cadn.net.cn

ctx.getTerminal().writer().println("hi");

A.5. 命令目录

这CommandCataloginterface 定义命令注册在一个 shell 应用程序。可以动态注册和取消注册 commands，为可能的用例提供了灵活性命令来来去去，具体取决于 shell 的状态。请考虑以下示例：spring-doc.cadn.net.cn

CommandRegistration registration = CommandRegistration.builder().build();
catalog.register(registration);

A.5.1. 命令解析器

您可以实现CommandResolver接口并定义一个 Bean 以动态解析从命令名称到其CommandRegistration实例。考虑以下示例：spring-doc.cadn.net.cn

static class CustomCommandResolver implements CommandResolver {
	List<CommandRegistration> registrations = new ArrayList<>();

	CustomCommandResolver() {
		CommandRegistration resolved = CommandRegistration.builder()
			.command("resolve command")
			.build();
		registrations.add(resolved);
	}

	@Override
	public List<CommandRegistration> resolve() {
		return registrations;
	}
}

当前CommandResolver是每次解析命令时都会使用它。因此，如果命令解析调用需要很长时间，我们建议不要使用它，因为它会使 shell 感觉迟钝。

A.5.2. 命令目录定制器

您可以使用CommandCatalogCustomizerinterface 自定义CommandCatalog. 它的主要用途是修改目录。此外，在spring-shellauto-configuration，则 interface 用于注册现有的CommandRegistrationbean 导入到目录中。请考虑以下示例：spring-doc.cadn.net.cn

static class CustomCommandCatalogCustomizer implements CommandCatalogCustomizer {

	@Override
	public void customize(CommandCatalog commandCatalog) {
		CommandRegistration registration = CommandRegistration.builder()
			.command("resolve command")
			.build();
		commandCatalog.register(registration);
	}
}

您可以创建一个CommandCatalogCustomizer作为 bean，而 Spring Shell 会处理其余部分。spring-doc.cadn.net.cn

A.6. 主题

主题设置中的样式是通过使用 AttributedString 从JLine. 不幸的是，样式JLine大部分是无记录的，但我们尝试通过它的一些功能在这里。spring-doc.cadn.net.cn

在JLine样式规范是具有特殊格式的字符串。可以给出 spec 如果用逗号分隔，则多次。规范将为 foreground、background 或其模式。特殊格式<spec>:=<spec>允许如果前者由于某种原因无效，则在后一个规范中定义一个默认值。spring-doc.cadn.net.cn

如果 spec 包含冒号，则其前部分表示前景或背景和可能的值为foreground,fg,f,background,bg,b,foreground-rgb,fg-rgb,f-rgb,background-rgb,bg-rgb或b-rgb.没有 rbg 的 color 值是允许颜色的名称black,red,green,yellow,blue,magenta,cyan或white.颜色有其简短的格式k,r,g,y,b,m,c和w分别。如果 color 以!或bright-，则亮度模式会自动应用的。前缀 with 将从 JLine 内部 bsd 颜色表中解析。~spring-doc.cadn.net.cn

如果 rgb 格式为预期，并且前缀为x或正常使用十六进制格式。#spring-doc.cadn.net.cn

fg-red
fg-r
fg-rgb:red
fg-rgb:xff3333
fg-rgb:#ff3333

如果 spec 包含特殊名称default,bold,faint,italic,underline,blink,inverse,inverse-neg,inverseneg,conceal,crossed-out,crossedout或hidden样式会使用现有颜色进行相应更改。spring-doc.cadn.net.cn

bold
bold,fg:red

如果 spec 是一个或多个用分号分隔的数字，则 format 是 ansi 的纯部分 ASCII 代码。spring-doc.cadn.net.cn

31
31;1

解析以 dot 开头的 spec 的 JLine 特殊映射格式不能是使用，因为我们还没有将它们映射到 Spring Shell 样式名称中。

A.7. 搜索算法

SearchMatch是将文本与模式匹配的界面。火柴结果位于返回值中SearchMatchResult.比赛结果包含有关对战位置和对战总分的信息。spring-doc.cadn.net.cn

FZF 的。spring-doc.cadn.net.cn

A.7.1. 实现

FuzzyMatchV2搜索spring-doc.cadn.net.cn

fzf FuzzyMatchV2Search 算法的端口。进行快速模糊搜索，效果很好快速找到路径。spring-doc.cadn.net.cn

ExactMatchNaive （精确匹配幼稚）spring-doc.cadn.net.cn

fzf ExactMatchNaive 算法的端口。简单精确匹配效果更准确如果您知道要搜索什么。spring-doc.cadn.net.cn

A.7.2. 搜索匹配

算法和默认语法隐藏在包保护的类中因为我们不想完全打开这些，直到我们知道 API 可以正常使用以获得更长的支持。您需要构造SearchMatch通过其内置构建器。spring-doc.cadn.net.cn

SearchMatch searchMatch = SearchMatch.builder()
	.caseSensitive(false)
	.normalize(false)
	.forward(true)
	.build();

可以配置区分大小写，搜索方向发生，或者是否应该在搜索发生之前对文本进行规范化。正常化当不同的语言对同一类型有轻微的变体时，很方便字符。spring-doc.cadn.net.cn

根据中显示的搜索语法选择搜索算法下表。spring-doc.cadn.net.cn

表 16.搜索语法
令牌	比赛类型	描述
`hell`spring-doc.cadn.net.cn	模糊匹配spring-doc.cadn.net.cn	匹配的项`hello`spring-doc.cadn.net.cn
`'stuff`spring-doc.cadn.net.cn	精确匹配spring-doc.cadn.net.cn	包含`stuff`spring-doc.cadn.net.cn

A.7.3. 示例

SearchMatch searchMatch = SearchMatch.builder()
	.caseSensitive(false)
	.normalize(false)
	.forward(true)
	.build();

SearchMatchResult result = searchMatch.match("foo bar baz", "fbb");

result.getStart();
// 0 - start position inclusive
result.getEnd();
// 9 - end position exclusive
result.getPositions();
// 0,4,8 - positions, inclusive
result.getScore();
// 112 - score
result.getAlgorithm();
// FuzzyMatchV2SearchMatchAlgorithm - resolved algo