字符串输入组件要求用户提供简单的文本输入,可以选择屏蔽值 如果内容包含敏感内容。以下列表显示了一个示例:Spring中文文档

@ShellComponent
public class ComponentCommands extends AbstractShellComponent {

	@ShellMethod(key = "component string", value = "String input", group = "Components")
	public String stringInput(boolean mask) {
		StringInput component = new StringInput(getTerminal(), "Enter value", "myvalue");
		component.setResourceLoader(getResourceLoader());
		component.setTemplateExecutor(getTemplateExecutor());
		if (mask) {
			component.setMaskCharacter('*');
		}
		StringInputContext context = component.run(StringInputContext.empty());
		return "Got value " + context.getResultValue();
	}
}

以下截屏视频显示了字符串输入组件的典型输出:Spring中文文档

上下文对象为 。下表列出了其上下文变量:StringInputContextSpring中文文档

表 1.StringInputContext 模板变量
钥匙 描述

defaultValueSpring中文文档

默认值(如果已设置)。否则为 null。Spring中文文档

maskedInputSpring中文文档

屏蔽输入值Spring中文文档

maskedResultValueSpring中文文档

屏蔽结果值Spring中文文档

maskCharacterSpring中文文档

掩码字符(如果已设置)。否则为 null。Spring中文文档

hasMaskCharacterSpring中文文档

true如果设置了掩码字符。否则为 false。Spring中文文档

modelSpring中文文档

父上下文变量(请参阅 TextComponentContext 模板变量)。Spring中文文档