如何为Spring Boot Shell设置默认命令及修复--help异常

一、设置默认命令（直接执行java -jar app.jar ".\src\main\java\"） #

提供两种可行方案：

方案1：修改Shell命令的key为空字符串 #

直接给目标命令设置空key，当未指定命令时自动触发该方法：

修改ShellCommands.java中的@ShellMethod注解：

@ShellMethod(key = "", value = "计算代码认知复杂度指标")
public void calculateCognitiveMetrics(
    final @ShellOption(defaultValue = "src/main/java") String directoryPath,
    final @ShellOption(defaultValue = "", value = "--html-report") String htmlReport,
    final @ShellOption(defaultValue = "", value = "--csv-report") String csvReport,
    final @ShellOption(defaultValue = "", value = "--json-report") String jsonReport
) throws IOException {
    // 原有业务逻辑保持不变
}

修改后执行java -jar app.jar ".\src\main\java\"，Spring Shell会自动将目录参数传递给该默认方法。

方案2：通过ApplicationRunner手动触发命令 #

若需保留原命令key，可在启动类中处理参数，判断是否调用目标方法：

修改CognitiveAnalysisApplication.java：

@SpringBootApplication
public class CognitiveAnalysisApplication implements ApplicationRunner {

    @Autowired
    private ShellCommands shellCommands;

    public static void main(final String[] args) {
        SpringApplication.run(CognitiveAnalysisApplication.class, args);
    }

    @Override
    public void run(final ApplicationArguments args) throws Exception {
        List<String> nonOptionArgs = args.getNonOptionArgs();
        // 判断是否仅传入目录参数（无明确命令）
        if (!nonOptionArgs.isEmpty() && !nonOptionArgs.get(0).startsWith("--")) {
            String directoryPath = nonOptionArgs.get(0);
            // 提取可选参数值
            Map<String, String> optionMap = args.getOptionNames().stream()
                .collect(Collectors.toMap(
                    name -> name,
                    name -> args.getOptionValues(name).get(0)
                ));
            // 调用目标方法
            shellCommands.calculateCognitiveMetrics(
                directoryPath,
                optionMap.getOrDefault("html-report", ""),
                optionMap.getOrDefault("csv-report", ""),
                optionMap.getOrDefault("json-report", "")
            );
        }
    }
}

该方式灵活性更高，适合需要保留原命令入口的场景。

二、修复--help命令报错问题 #

出现CommandNotFound错误，是因为Spring Shell内置帮助命令未被正确识别，可按以下步骤解决：

1. 确认依赖与自动配置有效性 #

检查pom.xml（或build.gradle）中Spring Shell依赖是否正确引入，确保@SpringBootApplication能扫描到Shell相关配置。Spring Boot 3.x的典型依赖如下：

<dependency>
    <groupId>org.springframework.shell</groupId>
    <artifactId>spring-shell-starter</artifactId>
    <version>3.2.0</version> <!-- 使用对应项目版本 -->
</dependency>

2. 禁用交互式模式（非交互式场景） #

若应用为非交互式运行（仅通过命令行参数执行，无需进入Shell交互界面），在application.properties中添加配置：

spring.shell.interactive.enabled=false

此配置会让Spring Shell优先处理命令行参数，包括内置的--help命令。

3. 手动注册帮助命令（兜底方案） #

若上述方法无效，可手动注册内置帮助命令：
创建配置类ShellConfig.java：

@Configuration
public class ShellConfig {

    @Bean
    public HelpCommand helpCommand(CommandCatalog commandCatalog, CommandRegistrationResolver resolver) {
        return new HelpCommand(commandCatalog, resolver);
    }
}

注册后--help命令会被正确识别，执行后将显示所有可用命令的帮助信息。

验证 #

1. 测试默认命令：执行java -jar app.jar ".\src\main\java\"，应直接触发代码指标计算逻辑。
2. 测试帮助命令：执行java -jar app.jar --help，应显示所有命令的帮助文档，包括calculate-cognitive-metrics命令的参数说明。

内容的提问来源于stack exchange，提问作者floriank