此版本仍在开发中,尚未被视为稳定版本。如需最新稳定版本,请使用 Spring Boot 4.0.4!spring-doc.cadn.net.cn

组织你的代码

Spring Boot 的运行并不要求特定的代码布局。 不过,有一些最佳实践可供参考。spring-doc.cadn.net.cn

如果您希望基于领域强制实施某种结构,请参阅 Spring Modulith

使用“default”包

当一个类未包含 package 声明时,该类被视为位于“默认包”中。 通常不建议使用“默认包”,应尽量避免。 对于使用 @ComponentScan@ConfigurationPropertiesScan@EntityScan@SpringBootApplication 注解的 Spring Boot 应用程序而言,这可能引发特定问题,因为会读取每个 JAR 包中的所有类。spring-doc.cadn.net.cn

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

定位主应用程序类

我们通常建议将主应用程序类置于其他类上方的根包中。 @SpringBootApplication 注解 通常添加在主类上,它会隐式地为某些项定义一个基础“扫描包”。 例如,如果您正在开发一个 JPA 应用程序,则会使用带有 @Entity 注解的类所在的包来搜索 @Repository 类型的组件。 使用根包还可确保组件扫描仅应用于您的项目。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)
}