3.2 结构化您的代码
优质
小牛编辑
125浏览
2023-12-01
Spring Boot不需要任何特定的代码布局即可工作。 但是,有一些最佳实践可以提供帮助。
3.2.1 使用“default”包
当类不包含包声明时,它被认为是在“默认包”中。 通常不鼓励使用“默认包”,应该避免使用。 对于使用@ComponentScan,@EntityScan或@SpringBootApplication注释的Spring Boot应用程序,它可能会导致特定问题,因为每个jar中的每个类都被读取。
我们建议您遵循Java推荐的包命名约定并使用反向域名(例如,com.example.project)
3.2.2 找到主应用程序类
我们通常建议您将主应用程序类放在其他类之上的根包中。 @SpringBootApplication注释通常放在您的主类上,它隐式地为某些项定义了一个基础“搜索包”。 例如,如果您正在编写JPA应用程序,则使用@SpringBootApplication带注释类的包来搜索@Entity项。 使用根包还允许组件扫描仅应用于您的项目。
如果您不想使用@SpringBootApplication,它导入的@EnableAutoConfiguration和@ComponentScan注释会定义该行为,因此您也可以使用它。
以下清单显示了典型的布局:
com
+- example
+- myapplication
+- Application.java
|
+- customer
| +- Customer.java
| +- CustomerController.java
| +- CustomerService.java
| +- CustomerRepository.java
|
+- order
+- Order.java
+- OrderController.java
+- OrderService.java
+- OrderRepository.java
Application.java文件将声明main方法以及基本的@SpringBootApplication,如下所示:
package com.example.myapplication;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}