代码结构

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