使用 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

约定

为了在运行 spring boot add 时智能合并代码库,项目必须遵循以下约定

  • 您应该将主 @SpringBootApplication 放在包层次结构的根目录下,并将所有其他代码放在子包中。

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

限制

当前,仅支持单模块 Maven 项目。计划在 1.0 版本中支持单模块 Gradle 项目。尚未定义支持多模块项目的时限。