代码结构

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