此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Shell 3.3.3！spring-doc.cn

开始

要查看 Spring Shell 必须提供什么，我们可以编写一个具有简单参数的简单 hello world shell 应用程序。spring-doc.cn

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

创建项目

在本教程中，我们通过以下方式创建一个简单的 Spring Boot 应用程序 using start.spring.io 您可以在其中选择 Spring Shell 依赖项。 这个最小的应用程序仅依赖于 和 。spring-boot-starterspring-shell-starterspring-doc.cn

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

使用 maven，您应该拥有如下内容：spring-doc.cn

<properties>
    <spring-shell.version>3.3.4-SNAPSHOT</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，您需要拥有如下内容：spring-doc.cn

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.4-SNAPSHOT"
    }
}
默认情况下，最高版本已启用所有运行器，默认情况下，仅启用从 开始。这意味着您需要启用才能获取 REPL。3.2.x3.3.xNonInteractiveShellRunnerInteractiveShellRunner 
spring:
  shell:
    interactive:
      enabled: true
鉴于 Spring Shell 启动 REPL （Read-Eval-Print-Loop），因为这个 依赖项，您需要在构建时跳过测试 （） 在本教程中，或者删除生成的示例集成测试 由 start.spring.io。如果不删除它，集成测试将创建 Spring 的 Spring 版本，并且根据您的构建工具，它会一直卡在 eval 循环或崩溃并显示 NPE。-DskipTestsApplicationContext

编译后，它可以在交互模式下运行：spring-doc.cn

$ $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.

或者在非交互模式下：spring-doc.cn

$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.
查看 Logging 使日志记录正常工作 使用 shell 应用程序更好。

您的第一个命令

现在我们可以添加第一个命令。为此，请创建一个新类（名称随你所愿）并 注释它 它是用于限制的变体 扫描 candidate 命令的类集。@ShellComponent@Componentspring-doc.cn

然后我们可以创建一个方法，将 返回 “Hello world” 的函数。添加和（可选）更改命令名称 using 参数。可用于定义参数默认值 如果在运行命令时未给出。helloWorldString@ShellMethodkey@ShellOptionspring-doc.cn

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 命令对帮助可见：spring-doc.cn

My Commands
       hello-world:

你可以运行它：spring-doc.cn

shell:>hello-world
Hello world spring

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

本文档的其余部分将更深入地研究整个 Spring Shell 编程模型。spring-doc.cn