Guide to Using Boot Add

您可以使用“project list”命令中提供的所有项目将代码和配置添加到现有项目中。 CLI 是通过以下方式完成此操作的:

  • 将 Maven 构建文件合并,以便将所有缺少的项目属性、依赖项、依赖项管理和插件添加到目标项目中。

  • 执行程序包重构,以便使用相同的程序包结构将代码复制到目标项目中。

  • 在目标项目中的 Spring Boot 主应用程序中添加所有缺少的注释。

  • README.adoc(或 .md)文件重命名为 README-<project-name>.adoc,以便您可以描述关于已添加代码的其他信息。

  • 合并 application.yamlapplication.properties 文件。

目前执行此任务的启发式方法并非 100% 完整,所以如果你是一位早期采用者,可能会遇到一些问题。 例如,假设我们已添加快速入门目录:

spring catalog add gs https://github.com/rd-1-2022/spring-gs-catalog

这会提供以下可供选择的项目:

┌──────────┬────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────┬───────┬──────────────┐
│Name      │URL                                                     │Description                                                     │Catalog│Tags          │
├──────────┼────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────┼───────┼──────────────┤
│web       │https://github.com/rd-1-2022/rpt-rest-service           │Hello, World RESTful web service.                               │gs     │[rest, web]   │
├──────────┼────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────┼───────┼──────────────┤
│jpa       │https://github.com/rd-1-2022/rpt-spring-data-jpa        │Learn how to work with JPA data persistence using Spring Data   │gs     │[jpa, h2]     │
│          │                                                        │JPA.                                                            │       │              │
├──────────┼────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────┼───────┼──────────────┤
│eureka    │https://github.com/rd-1-2022/eureka                     │Spring Cloud Eureka Server                                      │gs     │[cloud,       │
│          │                                                        │                                                                │       │eureka]       │
└──────────┴────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────┴───────┴──────────────┘

我们可以创建一个新的 Web 项目,然后通过运行以下命令向该项目添加 JPA 功能:

spring boot new demo web --package-name com.xkcd
cd demo
spring boot add jpa

项目树现在包含 Web 应用程序和 JPA 功能:

$ tree
.
├── LICENSE
├── mvnw
├── mvnw.cmd
├── pom.xml
├── README.adoc
├── README-jpa.md
└── src
    ├── main
    │   └── java
    │       └── com
    │           └── xkcd
    │               ├── Application.java
    │               ├── customer
    │               │   ├── CustomerCommandLineRunner.java
    │               │   ├── Customer.java
    │               │   └── CustomerRepository.java
    │               └── greeting
    │                   ├── GreetingController.java
    │                   └── Greeting.java
    └── test
        └── java
            └── com
                └── xkcd
                    ├── customer
                    │   └── CustomerRepositoryTests.java
                    └── greeting
                        └── GreetingControllerTests.java

Conventions

当你运行 spring boot add 时,为了对代码库执行智能合并,项目中必须遵循以下约定:

  • 你应该将 @SpringBootApplication 主脚本放置在软件包层级根部,并将所有其他代码放在子软件包中。

  • @SpringBootApplication 类中不应有其他 @Bean 注释。任何配置均应存在于独立的 @Configuration 类中。

Limitations

目前,仅支持单模块 Maven 项目。计划在 1.0 版本中支持单模块 Gradle 项目。尚未确定对多模块项目提供支持的时间表。