Spring Boot CLI

1. 安装 CLI

Spring Boot CLI（命令行界面）可以使用 SDKMAN 手动安装！（SDK 管理器）或使用 Homebrew 或 MacPorts（如果您是 OSX 用户）。 有关全面的安装说明，请参阅“入门”部分中的 getting-started.html。spring-doc.cn

2. 使用 CLI

安装 CLI 后，您可以通过在命令行中键入并按 Enter 来运行它。 如果在没有任何参数的情况下运行，则会显示一个帮助屏幕，如下所示：springspringspring-doc.cn

$ spring
usage: spring [--help] [--version]
       <command> [<args>]

Available commands are:

  run [options] <files> [--] [args]
    Run a spring groovy script

  _... more command help is shown here_

您可以键入以获取有关任何受支持命令的更多详细信息，如以下示例所示：spring helpspring-doc.cn

$ spring help run
spring run - Run a spring groovy script

usage: spring run [options] <files> [--] [args]

Option                     Description
------                     -----------
--autoconfigure [Boolean]  Add autoconfigure compiler
                             transformations (default: true)
--classpath, -cp           Additional classpath entries
--no-guess-dependencies    Do not attempt to guess dependencies
--no-guess-imports         Do not attempt to guess imports
-q, --quiet                Quiet logging
-v, --verbose              Verbose logging of dependency
                             resolution
--watch                    Watch the specified file for changes

该命令提供了一种快速方法来检查您正在使用的 Spring Boot 版本，如下所示：versionspring-doc.cn

$ spring version
Spring CLI v2.7.18

2.1. 使用 CLI 运行应用程序

您可以使用该命令编译和运行 Groovy 源代码。 Spring Boot CLI 是完全独立的，因此您不需要任何外部 Groovy 安装。runspring-doc.cn

以下示例显示了一个用 Groovy 编写的 “hello world” Web 应用程序：spring-doc.cn

hello.groovy
@RestController
class WebApplication {

    @RequestMapping("/")
    String home() {
        "Hello World!"
    }

}

要编译并运行应用程序，请键入以下命令：spring-doc.cn

$ spring run hello.groovy

要将命令行参数传递给应用程序，请使用 将命令与“spring”命令参数分开，如以下示例所示：--spring-doc.cn

$ spring run hello.groovy -- --server.port=9000

要设置 JVM 命令行参数，可以使用环境变量，如以下示例所示：JAVA_OPTSspring-doc.cn

$ JAVA_OPTS=-Xmx1024m spring run hello.groovy
在 Microsoft Windows 上进行设置时，请确保引用整个指令，例如 . 这样做可确保将值正确传递给进程。JAVA_OPTSset "JAVA_OPTS=-Xms256m -Xmx2048m"

2.1.1. 推导的 “grab” 依赖项

标准 Groovy 包括一个注释，它允许您声明对第三方库的依赖关系。 这种有用的技术允许 Groovy 以与 Maven 或 Gradle 相同的方式下载 jar，但不需要您使用构建工具。@Grabspring-doc.cn

Spring Boot 进一步扩展了这项技术，并尝试根据你的代码推断出要 “抓取” 的库。 例如，由于前面显示的代码使用了 Comments，因此 Spring Boot 会抓取“Tomcat”和“Spring MVC”。WebApplication@RestControllerspring-doc.cn

以下项目用作 “抓取提示”：spring-doc.cn

项目 抓住

JdbcTemplate, ,NamedParameterJdbcTemplateDataSourcespring-doc.cn

JDBC 应用程序。spring-doc.cn

@EnableJmsspring-doc.cn

JMS 应用程序。spring-doc.cn

@EnableCachingspring-doc.cn

缓存抽象。spring-doc.cn

@Testspring-doc.cn

JUnit 的spring-doc.cn

@EnableRabbitspring-doc.cn

RabbitMQ 的 RabbitMQ 中。spring-doc.cn

延伸Specificationspring-doc.cn

Spock 测试。spring-doc.cn

@EnableBatchProcessingspring-doc.cn

Spring Batch 中。spring-doc.cn

@MessageEndpoint @EnableIntegrationspring-doc.cn

Spring 集成。spring-doc.cn

@Controller @RestController @EnableWebMvcspring-doc.cn

Spring MVC + 嵌入式 Tomcat。spring-doc.cn

@EnableWebSecurityspring-doc.cn

Spring Security性。spring-doc.cn

@EnableTransactionManagementspring-doc.cn

Spring 事务管理。spring-doc.cn
请参阅 Spring Boot CLI 源代码中CompilerAutoConfiguration的子类，以准确了解如何应用自定义。

2.1.2. 推导的 “grab” 坐标

Spring Boot 扩展了 Groovy 的标准支持，允许您指定没有 group 或 version 的依赖项（例如，）。 这样做会查阅 Spring Boot 的默认依赖项元数据，以推断 artifact 的组和版本。@Grab@Grab('freemarker')spring-doc.cn

默认元数据与您使用的 CLI 版本相关联。 它仅在您迁移到新版本的 CLI 时更改，从而使您能够控制依赖项版本何时可能更改。 附录中显示了默认元数据中包含的依赖项及其版本的表格。

2.1.3. 默认 import 语句

为了帮助减小 Groovy 代码的大小，会自动包含几个语句。 请注意前面的示例如何引用 ， ，并且不需要使用完全限定的名称或语句。import@Component@RestController@RequestMappingimportspring-doc.cn

许多 Spring 注解无需 using 语句即可工作。 在添加导入之前，请尝试运行应用程序以查看失败的内容。import

2.1.4. 自动 main 方法

与等效的 Java 应用程序不同，您不需要在脚本中包含方法。 A 会自动创建，编译后的代码充当 .public static void main(String[] args)GroovySpringApplicationsourcespring-doc.cn

2.1.5. 自定义依赖项管理

默认情况下，CLI 在解析依赖项时使用 中声明的依赖项管理。 可以使用注释配置其他依赖项管理，这将覆盖默认依赖项管理。 注释的值应指定一个或多个 Maven BOM 的坐标 （）。spring-boot-dependencies@Grab@DependencyManagementBomgroupId:artifactId:versionspring-doc.cn

例如，请考虑以下声明：spring-doc.cn

@DependencyManagementBom("com.example.custom-bom:1.0.0")

前面的声明在 Maven 存储库中的 .custom-bom-1.0.0.pomcom/example/custom-versions/1.0.0/spring-doc.cn

当您指定多个 BOM 时，它们将按照您声明它们的顺序应用，如以下示例所示：spring-doc.cn

@DependencyManagementBom([
    "com.example.custom-bom:1.0.0",
    "com.example.another-bom:1.0.0"])

前面的示例表明 中的依赖项管理覆盖了 中的依赖项管理。another-bomcustom-bomspring-doc.cn

您可以在任何可以使用 的地方使用 . 但是，为了确保依赖项管理的排序一致，您最多可以在应用程序中使用 at once。@DependencyManagementBom@Grab@DependencyManagementBomspring-doc.cn

2.2. 具有多个源文件的应用程序

您可以将 “shell globbing” 与接受文件输入的所有命令一起使用。 这样做允许您使用单个目录中的多个文件，如以下示例所示：spring-doc.cn

$ spring run *.groovy

2.3. 打包应用程序

您可以使用该命令将应用程序打包到一个独立的可执行 jar 文件中，如以下示例所示：jarspring-doc.cn

$ spring jar my-app.jar *.groovy

生成的 jar 包含通过编译应用程序生成的类以及应用程序的所有依赖项，以便随后可以使用 . jar 文件还包含来自应用程序 Classpath 的条目。 您可以使用 和 添加和删除 jar 的显式路径。 两者都是逗号分隔的，并且都接受 “+” 和 “-” 形式的前缀，以表示它们应该从默认值中删除。 默认包括如下：java -jar--include--excludespring-doc.cn

public/**, resources/**, static/**, templates/**, META-INF/**, *

默认排除项如下：spring-doc.cn

.*, repository/**, build/**, target/**, **/*.jar, **/*.groovy

在命令行上键入以获取更多信息。spring help jarspring-doc.cn

2.4. 初始化新项目

该命令允许您在不离开 shell 的情况下使用 start.spring.io 创建新项目，如以下示例所示：initspring-doc.cn

$ spring init --dependencies=web,data-jpa my-project
Using service at https://start.spring.io
Project extracted to '/Users/developer/example/my-project'

前面的示例创建一个目录，其中包含一个基于 Maven 的项目，该项目使用 和 。 您可以使用标志列出服务的功能，如以下示例所示：my-projectspring-boot-starter-webspring-boot-starter-data-jpa--listspring-doc.cn

$ spring init --list
=======================================
Capabilities of https://start.spring.io
=======================================

Available dependencies:
-----------------------
actuator - Actuator: Production ready features to help you monitor and manage your application
...
web - Web: Support for full-stack web development, including Tomcat and spring-webmvc
websocket - Websocket: Support for WebSocket development
ws - WS: Support for Spring Web Services

Available project types:
------------------------
gradle-build -  Gradle Config [format:build, build:gradle]
gradle-project -  Gradle Project [format:project, build:gradle]
maven-build -  Maven POM [format:build, build:maven]
maven-project -  Maven Project [format:project, build:maven] (default)

...

该命令支持许多选项。 有关更多详细信息，请参阅输出。 例如，以下命令创建一个使用 Java 8 并打包的 Gradle 项目：inithelpwarspring-doc.cn

$ spring init --build=gradle --java-version=1.8 --dependencies=websocket --packaging=war sample-app.zip
Using service at https://start.spring.io
Content saved to 'sample-app.zip'

2.5. 使用嵌入式 shell

Spring Boot 包括 BASH 和 zsh shell 的命令行完成脚本。 如果您不使用这两个 shell（可能是 Windows 用户），则可以使用该命令启动集成的 shell，如以下示例所示：shellspring-doc.cn

$ spring shell
Spring Boot (v2.7.18)
Hit TAB to complete. Type \'help' and hit RETURN for help, and \'exit' to quit.

在嵌入式 shell 内部，您可以直接运行其他命令：spring-doc.cn

$ version
Spring CLI v2.7.18

嵌入式 shell 支持 ANSI 颜色输出和完成。 如果需要运行本机命令，可以使用前缀。 要退出嵌入式 shell，请按 。tab!ctrl-cspring-doc.cn

2.6. 向 CLI 添加扩展

您可以使用以下命令向 CLI 添加扩展。 该命令采用格式为 的一组或多组工件坐标，如以下示例所示：installgroup:artifact:versionspring-doc.cn

$ spring install com.example:spring-boot-cli-extension:1.0.0.RELEASE

除了安装由您提供的坐标标识的工件外，还会安装所有工件的依赖项。spring-doc.cn

要卸载依赖项，请使用命令。 与该命令一样，它采用 格式为 的一组或多组工件坐标，如以下示例所示：uninstallinstallgroup:artifact:versionspring-doc.cn

$ spring uninstall com.example:spring-boot-cli-extension:1.0.0.RELEASE

它将卸载由您提供的坐标及其依赖项标识的构件。spring-doc.cn

要卸载所有其他依赖项，您可以使用该选项，如以下示例所示：--allspring-doc.cn

$ spring uninstall --all

3. 使用 Groovy Beans DSL 开发应用程序

Spring Framework 4.0 具有对“DSL”（借鉴自 Grails）的本机支持，您可以使用相同的格式将 bean 定义嵌入到 Groovy 应用程序脚本中。 这有时是包含中间件声明等外部功能的好方法，如以下示例所示：beans{}spring-doc.cn

@Configuration(proxyBeanMethods = false)
class Application implements CommandLineRunner {

    @Autowired
    SharedService service

    @Override
    void run(String... args) {
        println service.message
    }

}

import my.company.SharedService

beans {
    service(SharedService) {
        message = "Hello World"
    }
}

只要类声明保持在顶层，就可以在同一个文件中混合使用它们，或者，如果你愿意，你可以将 bean DSL 放在一个单独的文件中。beans{}spring-doc.cn

4. 使用 settings.xml 配置 CLI

Spring Boot CLI 使用 Maven 的依赖项解析引擎 Maven Resolver 来解析依赖项。 CLI 使用 中找到的 Maven 配置来配置 Maven 解析程序。 CLI 支持以下配置设置：~/.m2/settings.xmlspring-doc.cn

有关更多信息，请参阅 Maven 的设置文档。spring-doc.cn

5. 接下来要读什么

GitHub 存储库中提供了一些示例 groovy 脚本，您可以使用它们来试用 Spring Boot CLI。 整个源代码中还有大量的 Javadoc。spring-doc.cn

如果您发现达到了 CLI 工具的限制，您可能希望考虑将应用程序转换为完整的 Gradle 或 Maven 构建的“Groovy 项目”。 下一节介绍 Spring Boot 的“构建工具插件”，您可以将其与 Gradle 或 Maven 一起使用。spring-doc.cn