该版本仍在开发中,尚未被视为稳定。最新稳定版本请使用Spring Shell 3.4.1spring-doc.cadn.net.cn

遗产注释

使用标准API时,豆子上的方法会被转换为可执行命令,前提是:spring-doc.cadn.net.cn

@ShellComponent是一个本身被元注释为@Component.因此, 你可以在过滤机制的同时使用它来申报豆子(例如,使用@ComponentScan).spring-doc.cadn.net.cn

你可以通过使用注释的属性。spring-doc.cadn.net.cn

@ShellComponent
static class MyCommands {

	@ShellMethod
	public void mycommand() {
	}
}

唯一需要的属性@ShellMethod注释是其属性,应当具有 简短的一句话,描述指挥部的工作内容。这让用户能够 在不必离开壳体的情况下,持续获得指令的帮助(见帮助)。spring-doc.cadn.net.cn

你的指挥描述应简短——不超过一两句话。为了更好 一致性,应该以大写字母开头,以句号结尾。

默认情况下,你不需要指定命令的密钥(即应使用的词) 在壳中调用它)。方法的名称被用作命令键,将 camelCase 名称转换为 虚线、GNU风格的名称(例如,sayHello()成为打个招呼).spring-doc.cadn.net.cn

不过,你可以通过使用钥匙注释属性:spring-doc.cadn.net.cn

@ShellMethod(value = "Add numbers.", key = "sum")
public int add(int a, int b) {
	return a + b;
}
钥匙属性接受多个值。 如果你为一个方法设置多个键,命令会用这些不同的别名注册。
命令键几乎可以包含任何字符,包括空格。不过在想名字的时候, 请记住,用户通常很欣赏一致性。也就是说,你应该避免将虚线名称与 名称间隔和其他不一致之处。