对于最新稳定版本,请使用 Spring Boot 4.0.4spring-doc.cadn.net.cn

结构化您的代码

Spring Boot 不要求任何特定的代码布局就能工作。 然而,有一些最佳实践是有帮助的。spring-doc.cadn.net.cn

如果你希望基于领域强制实施一种结构,请查看Spring Modulith

使用“默认”包

当一个类不包含 package 声明时,它被视为位于“默认包”中。 通常不推荐使用“默认包”,应避免使用。 对于使用了 @ComponentScan@ConfigurationPropertiesScan@EntityScan@SpringBootApplication 注解的 Spring Boot 应用程序来说,这可能会引起特定问题,因为会读取每个 jar 包中的每个类。spring-doc.cadn.net.cn

我们建议您遵循Java推荐的包命名约定,并使用反向域名(例如,com.example.project)。

定位主应用程序类

我们通常建议将主应用程序类位于其他类之上的根包中。 @SpringBootApplication 注解 通常放置在您的主类上,它隐式地为某些项定义了一个基础“搜索包”。 例如,如果您正在编写一个 JPA 应用程序,则带有 @SpringBootApplication 注解的类的包将用于搜索 @Entity 项。 使用根包还可以使组件扫描仅应用于您的项目。spring-doc.cadn.net.cn

如果您不想使用 @SpringBootApplication,它导入的 @EnableAutoConfiguration@ComponentScan 注解也定义了该行为,因此您也可以改用这些注解。

以下示例显示了一种典型的布局:spring-doc.cadn.net.cn

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

MyApplication.java 文件将声明 main 方法,以及基本的 @SpringBootApplication,如下所示:spring-doc.cadn.net.cn

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

	public static void main(String[] args) {
		SpringApplication.run(MyApplication.class, args);
	}

}
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

@SpringBootApplication
class MyApplication

fun main(args: Array<String>) {
	runApplication<MyApplication>(*args)
}