此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Boot 3.4.0! |
构建代码
Spring Boot 不需要任何特定的代码布局即可工作。 但是,有一些最佳实践会有所帮助。
如果你希望实现基于域的结构,请查看 Spring Modulith。 |
使用 “default” 软件包
当一个类不包含声明时,它被视为位于 “default package” 中。
通常不建议使用 “default package” 并且应该避免使用。
对于使用 @ComponentScan
、@ConfigurationPropertiesScan
、@EntityScan
或 @SpringBootApplication
注释的 Spring Boot 应用程序,它可能会导致特定问题,因为每个 jar 中的每个类都会被读取。package
我们建议您遵循 Java 建议的包命名约定,并使用反向域名(例如 )。com.example.project |
查找 Main Application 类
我们通常建议您将主应用程序类放在其他类上方的根包中。
@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
该文件将声明方法以及基本@SpringBootApplication
,如下所示:MyApplication.java
main
-
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)
}