使用 Boot Add 的指南
您可以使用 project list 命令中提供的所有项目,向现有项目添加代码和配置。
CLI 通过以下方式实现:
-
合并 Maven 构建文件,以便将任何缺失的项目属性、依赖项、依赖管理和插件添加到目标项目中。
-
执行包重构,以便将要复制到目标项目的代码保持相同的包结构。
-
在目标项目的 Spring Boot 主应用程序上添加任何缺失的注解。
-
将
README.adoc(或 .md)文件重命名为README-<project-name>.adoc,以便您可以描述所添加代码的更多信息。 -
正在合并
application.yaml和application.properties个文件。
执行此任务的启发式方法目前尚未完全成熟,因此如果您是早期采用者,可能会遇到一些小问题。
例如,假设我们已添加了入门目录:
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类中。