跳到主要内容

Spring Boot 3.x 最佳实践

Spring Boot 3.x 最佳实践

Spring Boot不需要任何特定的代码布局。然而有一些最佳实践可以提供帮助。

代码结构

1、 使用默认的包;
当一个类没有包含包声明时,它会默认在"default package"中。通常不建议使用“default package”,应该避免使用。它可能会导致Spring Boot应用程序使用@ComponentScan, @ConfigurationPropertiesScan, @EntityScan, 或者 @SpringBootApplication 注解时,读取每个jar中的每个类。

2、 定位应用程序主类;
通常建议将主应用程序类放在根包中。@SpringBootApplication注释通常放在主类上, 它还隐式地为某些项目定义了一个基本的“search package”。例如,如果你正在编写一个JPA应用程序,那么@SpringBootApplication注解类的包将用于搜索@Entity项。使用根包还允许组件扫描只应用于你的项目。

下面一个典型的代码布局:

com
+- example
+- myapplication
+- FirstSpringboot3MavenApplication.java
|
+- customer
| +- Customer.java
| +- CustomerController.java
| +- CustomerService.java
| +- CustomerRepository.java
|
+- order
+- Order.java
+- OrderController.java
+- OrderService.java
+- OrderRepository.java

FirstSpringboot3MavenApplication.java定义了main方法,并且启用了@SpringBootApplication注解,如下所示: