Spring Shell 有一个内置命令,但并非所有人都喜欢获得命令帮助 从它,因为您总是需要使用目标命令的参数来调用它。它 在许多 CLI 框架中很常见,每个命令都有选项 --help-h 来打印命令 help。help

默认功能是每个命令都将被修改为具有选项 --help-h,如果给定命令中存在这些选项,则会自动 将命令执行短路到现有命令中,而不管 键入了哪些其他命令行选项。help

以下示例显示了其默认设置。

@Bean
CommandRegistration commandRegistration() {
	return CommandRegistration.builder()
		.command("mycommand")
		.withHelpOptions()
			.enabled(true)
			.longNames("help")
			.shortNames('h')
			.command("help")
			.and()
		.build();
}

可以通过配置选项更改默认行为。

spring:
  shell:
    help:
      enabled: true
      long-names: help
      short-names: h
      command: help
以编程方式或通过注释定义的命令将自动添加 帮助选项。使用注释模型,您只能全局关闭,以编程方式关闭 model 提供了修改每个命令设置的选项。
以编程方式或通过注释定义的命令将自动添加 帮助选项。使用注释模型,您只能全局关闭,以编程方式关闭 model 提供了修改每个命令设置的选项。