Spring Shell可选参数使用异常及构建、启动问题求助

问题1：help greet不显示命令选项 #

现象 #

执行help greet后，OPTIONS区域为空：

shell:>help greet
NAME
       greet - This command is used to greet a user

SYNOPSIS
       greet 

OPTIONS

原因 #

@ShellOption注解的value属性配置错误。当前代码中直接将选项前缀（-name）作为value值，而Spring Shell要求value填写不带前缀的选项名，短选项需通过shortNames属性指定。这种错误配置导致Shell无法识别参数选项，自然不会在help中展示。

解决方案 #

修正@ShellOption的配置，将选项名与短选项分开定义：

@ShellComponent
public class CommandDemo {

    @ShellMethod(value = "This command is used to greet a user")
    public void greet(
            @ShellOption(value = "name", shortNames = 'n', help = "Give the name to greet", defaultValue = "User") String name,
            @ShellOption(value = "city", shortNames = 'c', help = "Give the city name you are from", required = false) String city
            ) {
        String message = "Hello "+name;
        if(city!=null && !city.isEmpty()) {
            message+=", I'm from "+city;
        }
        System.out.println(message);
    }
}

• value：填写长选项名（如name），对应命令中的--name
• shortNames：填写单个字符（如'n'），对应命令中的-n
• 对city参数添加required = false，明确标记为非必填（否则未传参时会报错）

问题2：执行greet -name john输出Hello null #

现象 #

执行命令后得到意外结果：

shell:>greet -name john
Hello null

原因 #

1. 选项配置错误：@ShellOption(value = "-name")的写法导致Shell无法正确绑定参数值，name参数未获取到输入的john。
2. city参数未标记为非必填且无默认值，理论上未传参时应报错，但因配置混乱，Shell错误地将john绑定到city参数，而name参数因绑定失败取到null（覆盖了默认值）。

解决方案 #

采用问题1中的修正代码，同时确保命令调用格式正确：

• 使用长选项：greet --name john
• 或使用短选项：greet -n john

问题3：mvn clean package测试阶段卡住 #

原因 #

默认生成的SpringShellExampleApplicationTests使用了普通的@SpringBootTest注解，会启动完整的Spring Shell交互环境，而测试用例未处理交互输入，导致进程卡住等待用户输入。

解决方案 #

修改测试类，禁用Web环境并使用Spring Shell专用的测试注解：

import org.junit.jupiter.api.Test;
import org.springframework.shell.test.ShellTest;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;

@ShellTest
@SpringBootTest(webEnvironment = WebEnvironment.NONE)
class SpringShellExampleApplicationTests {

    @Test
    void contextLoads() {
    }

}

• @ShellTest：Spring Shell专用测试注解，避免启动交互环境
• webEnvironment = WebEnvironment.NONE：禁用Web环境，加快测试启动速度

无需删除测试类，修改后即可正常完成构建。

问题4：执行java -jar ... --debug报错No command found for '--debug' #

现象 #

启动命令报错：

No command found for '--debug'
org.springframework.shell.CommandNotFound: No command found for '--debug'
        at org.springframework.shell.Shell.evaluate(Shell.java:231)
        ...

原因 #

Spring Shell会将-jar后的所有参数默认识别为Shell命令，而--debug是Spring Boot的参数，需要明确告知应用将其交给Spring Boot处理，而非Shell。

解决方案 #

使用--分隔Spring Boot参数与Shell命令参数，正确写法：

java -jar spring-shell-example-0.0.1-SNAPSHOT.jar -- --debug

• --之前的参数：JVM或Spring Boot参数
• --之后的参数：Spring Shell命令（若有）

如果是传递JVM级别的调试参数（如开启远程调试），则需将参数放在-jar之前：

java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -jar spring-shell-example-0.0.1-SNAPSHOT.jar

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