代码结构

Spring Boot 并不要求任何特定的代码布局才能工作。然而，有一些最佳实践会有所帮助。

如果您希望强制执行基于域的结构，请查看 Spring Modulith。

使用“default”包

当一个类不包含 package 声明时，它被认为位于“default package”中。通常不鼓励使用“default package”，应尽量避免。它可能会给使用 @ComponentScan、@ConfigurationPropertiesScan、@EntityScan 或 @SpringBootApplication 注解的 Spring Boot 应用带来特定问题，因为会读取所有 jar 中的所有类。

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

定位主应用类

我们通常建议您将主应用类放在其他类之上的根包中。`@SpringBootApplication` 注解通常放在您的主类上，它隐式地定义了某些项目的基本“搜索包”。例如，如果您正在编写一个 JPA 应用，则使用 @SpringBootApplication 注解的类的包将用于搜索 @Entity 项。使用根包也允许组件扫描仅应用于您的项目。

如果您不想使用 @SpringBootApplication，则它导入的 @EnableAutoConfiguration 和 @ComponentScan 注解定义了该行为，因此您也可以使用它们代替。

以下列表展示了典型的布局

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，如下所示

  • Java

  • Kotlin

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)
}