代码结构

Spring Boot 不需要任何特定的代码布局即可工作。但是，有一些最佳实践会有所帮助。

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

使用“默认”包

当一个类不包含 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)
}