快速入门

要了解 Spring Shell 提供的功能，我们可以编写一个简单的“Hello World” shell 应用程序，该应用程序带有一个简单的参数。

Spring Shell 基于 Spring Boot 3.3.4 和 Spring Framework 6.1.13，因此需要 JDK 17。

创建项目

在本教程中，我们将使用 start.spring.io 创建一个简单的 Spring Boot 应用程序，您可以在其中选择 Spring Shell 依赖项。此最小应用程序仅依赖于 spring-boot-starter 和 spring-shell-starter。

start.spring.io 上的 Spring Shell 版本通常是最新版本。

使用 maven，您应该拥有类似以下内容：

<properties>
    <spring-shell.version>3.3.3</spring-shell.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.shell</groupId>
        <artifactId>spring-shell-starter</artifactId>
    </dependency>
</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.shell</groupId>
            <artifactId>spring-shell-dependencies</artifactId>
            <version>${spring-shell.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

使用 gradle，您应该拥有类似以下内容：

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    implementation 'org.springframework.shell:spring-shell-starter'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

dependencyManagement {
    imports {
        mavenBom "org.springframework.shell:spring-shell-dependencies:3.3.3"
    }
}

3.2.x 之前的版本默认启用所有运行器，从 3.3.x 开始，默认仅启用 NonInteractiveShellRunner。这意味着您需要启用 InteractiveShellRunner 才能获得 REPL。

spring:
  shell:
    interactive:
      enabled: true

由于存在此依赖项，Spring Shell 会启动 REPL（读取-评估-打印-循环），因此您需要在整个教程中构建时跳过测试（-DskipTests）或删除由 start.spring.io 生成的示例集成测试。如果您不删除它，集成测试将创建 Spring ApplicationContext，并且根据您的构建工具，将停留在 eval 循环中或因 NPE 而崩溃。

编译完成后，可以通过交互模式运行

$ $JAVA_HOME/bin/java -jar demo-0.0.1-SNAPSHOT.jar

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::       (v3.3.4)

2022-09-13T18:42:12.818+01:00  INFO 12644 --- [           main] com.example.demo.DemoApplication
: Starting DemoApplication using Java 17.0.4 on ...
2022-09-13T18:42:12.821+01:00  INFO 12644 --- [           main] com.example.demo.DemoApplication
: No active profile set, falling back to 1 default profile: "default"
2022-09-13T18:42:13.606+01:00  INFO 12644 --- [           main] com.example.demo.DemoApplication
: Started DemoApplication in 1.145 seconds (process running for 1.578)
shell:>help
AVAILABLE COMMANDS

Built-In Commands
       help: Display help about available commands
       stacktrace: Display the full stacktrace of the last error.
       clear: Clear the shell screen.
       quit, exit: Exit the shell.
       history: Display or save the history of previously run commands
       version: Show version info
       script: Read and execute commands from a file.

或非交互模式

$JAVA_HOME/bin/java -jar demo-0.0.1-SNAPSHOT.jar help

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::       (v3.3.4)

2022-09-13T18:42:12.818+01:00  INFO 12644 --- [           main] com.example.demo.DemoApplication
: Starting DemoApplication using Java 17.0.4 on ...
2022-09-13T18:42:12.821+01:00  INFO 12644 --- [           main] com.example.demo.DemoApplication
: No active profile set, falling back to 1 default profile: "default"
2022-09-13T18:42:13.606+01:00  INFO 12644 --- [           main] com.example.demo.DemoApplication
: Started DemoApplication in 1.145 seconds (process running for 1.578)
AVAILABLE COMMANDS

Built-In Commands
       help: Display help about available commands
       stacktrace: Display the full stacktrace of the last error.
       clear: Clear the shell screen.
       quit, exit: Exit the shell.
       history: Display or save the history of previously run commands
       version: Show version info
       script: Read and execute commands from a file.

查看日志记录，使日志记录更好地适用于 shell 应用程序。

您的第一个命令

现在我们可以添加第一个命令。为此，创建一个新类（命名为任何您想要的名称），并使用 @ShellComponent 对其进行注释，@ShellComponent 是 @Component 的一个变体，用于限制扫描候选命令的类集。

然后，我们可以创建一个 helloWorld 方法，该方法将 String 作为参数并将其与“Hello world”一起返回。添加 @ShellMethod，并可选地使用 key 参数更改命令名称。您可以使用 @ShellOption 定义参数的默认值（如果在运行命令时未提供）。

import org.springframework.shell.standard.ShellComponent;
import org.springframework.shell.standard.ShellMethod;
import org.springframework.shell.standard.ShellOption;

@ShellComponent
public class MyCommands {

	@ShellMethod(key = "hello-world")
	public String helloWorld(
		@ShellOption(defaultValue = "spring") String arg
	) {
		return "Hello world " + arg;
	}
}

新的 hello-world 命令对 help 可见

My Commands
       hello-world:

您可以运行它

shell:>hello-world
Hello world spring

shell:>hello-world --arg boot
Hello world boot

本文档的其余部分将更深入地探讨整个 Spring Shell 编程模型。