9. 定制

本节介绍如何自定义 shell。spring-doc.cn

9.1. 主题

当前的终端实现功能丰富,通常可以显示 其他只是纯文本的东西。例如,可以将文本的样式设置为粗体或具有不同的颜色。终端能够 显示 Unicode 表中的各种字符,例如 emoji,这些字符通常是 用于使 shell 输出更漂亮。spring-doc.cn

Spring Shell 通过其主题框架支持这些,该框架包含两个部分, 首先,样式可用于更改文本类型,其次,数字如何 显示一些字符。然后将这两者组合在一起作为一个主题spring-doc.cn

有关主题内部的更多信息,请参阅 主题。spring-doc.cn

默认主题已命名,但可以使用 property 进行更改。其他名为 uses 的内置主题 没有颜色的样式,并尽量不使用任何特殊数字。defaultspring.shell.theme.namedump

通过覆盖设置来修改现有样式。spring-doc.cn

static class MyStyleSettings extends StyleSettings {

	@Override
	public String highlight() {
		return super.highlight();
	}
}

通过覆盖设置来修改现有图窗。spring-doc.cn

static class MyFigureSettings extends FigureSettings {

	@Override
	public String error() {
		return super.error();
	}
}

要创建新主题,请创建 并提供您自己的样式数字实现。ThemeSettingsspring-doc.cn

static class MyThemeSettings extends ThemeSettings {

	@Override
	public StyleSettings styles() {
		return new MyStyleSettings();
	}

	@Override
	public FigureSettings figures() {
		return new MyFigureSettings();
	}
}

注册一个新的 Bean,您可以在其中返回自定义名称和主题名称。ThemeThemeSettingsspring-doc.cn

@Configuration
static class CustomThemeConfig {

	@Bean
	Theme myTheme() {
		return new Theme() {
			@Override
			public String getName() {
				return "mytheme";
			}

			@Override
			public ThemeSettings getSettings() {
				return new MyThemeSettings();
			}
		};
	}
}

如果要创建 JLine 样式的字符串,如果需要,还可以进行 主题人物更漂亮。ThemeResolverspring-doc.cn

@Autowired
private ThemeResolver resolver;

void resolve() {
	String resolvedStyle = resolver.resolveStyleTag(StyleSettings.TAG_TITLE);
	// bold,fg:bright-white

	AttributedStyle style = resolver.resolveStyle(resolvedStyle);
	// jline attributed style from expression above

	String resolvedFigure = resolver.resolveFigureTag(FigureSettings.TAG_ERROR);
	// character i.e. U+2716 Heavy Multiplication X Emoji, cross
}