对于最新的稳定版本,请使用 Spring Boot 3.5.5spring-doc.cadn.net.cn

构建代码

Spring Boot 不需要任何特定的代码布局即可工作。 但是,有一些最佳实践可以提供帮助。spring-doc.cadn.net.cn

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

使用“默认”包

当类不包含package声明,则认为它在“默认包”中。 通常不鼓励使用“默认包”,应避免使用。 它可能会给使用@ComponentScan,@ConfigurationPropertiesScan,@EntityScan@SpringBootApplication注释,因为每个 jar 中的每个类都被读取。spring-doc.cadn.net.cn

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

查找主应用程序类

我们通常建议您将主应用程序类放在根包中,高于其他类。 这@SpringBootApplication注解通常放置在主类上,并且它隐式定义了某些项目的基本“搜索包”。 例如,如果您正在编写一个 JPA 应用程序,则@SpringBootApplicationannotated 类用于搜索@Entity项目。 使用根包还允许组件扫描仅应用于您的项目。spring-doc.cadn.net.cn

如果您不想使用@SpringBootApplication@EnableAutoConfiguration@ComponentScan它导入的注释定义了该行为,因此您也可以改用这些注释。

以下列表显示了典型布局:spring-doc.cadn.net.cn

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如下:spring-doc.cadn.net.cn

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