代码结构

DeepSeek V3 中英对照 Structuring Your Code

Spring Boot 不需要任何特定的代码布局即可工作。然而，有一些最佳实践可以帮助你更好地组织代码。

提示

如果你想基于领域来强制实施结构，可以看看 Spring Modulith。

使用 “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

none

MyApplication.java 文件将声明 main 方法，并包含基本的 @SpringBootApplication，如下所示：

Java

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

}

java

Kotlin

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

@SpringBootApplication
class MyApplication

fun main(args: Array<String>) {
    runApplication<MyApplication>(*args)
}

kotlin