开始使用

ChatGPT-4o-mini 中英对照 Getting Started

要了解 Spring Shell 的功能，我们可以编写一个简单的 hello world shell 应用程序，该应用程序具有一个简单的参数。

important

Spring Shell 基于 Spring Boot 3.4.0 和 Spring Framework 6.2.0，因此需要 JDK 17。

创建项目

为了本教程的目的，我们通过使用 start.spring.io 创建一个简单的 Spring Boot 应用程序，在那里你可以选择 Spring Shell 依赖。这个最小的应用程序仅依赖于 spring-boot-starter 和 spring-shell-starter。

备注

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

使用 maven，你应该有如下内容：

<properties>
    <spring-shell.version>3.4.0</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>

xml

使用 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.4.0"
    }
}

groovy

important

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

spring:
  shell:
    interactive:
      enabled: true

yaml

警告

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

一旦编译完成，可以在交互模式下运行：

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

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

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.

text

或者在非交互模式下：

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

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

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.

text

提示

查看 Logging，使日志记录在 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;
	}
}

java

新的 hello-world 命令在 help 中可见：

My Commands
       hello-world:

text

你可以运行它：

shell:>hello-world
Hello world spring

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

text

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