14. 构建代码

Spring Boot 不需要任何特定的代码布局即可工作。但是,有一些最佳实践可以帮助您。

14.1 使用"default"软件包

当一个类不包含package声明时,它将被视为在“默认包”中。通常不建议使用“默认程序包”,应避免使用。对于使用@ComponentScan@EntityScan@SpringBootApplication注解的 Spring Boot 应用程序,这可能会导致特定的问题,因为每个 jar 中的每个类都会被读取。

Tip

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

14.2 查找主应用程序类

我们通常建议您将主应用程序类放在其他类之上的根包中。 @SpringBootApplication annotation通常放在您的主类上,它隐式定义某些项目的基本“搜索包”。例如,如果您正在编写 JPA 应用程序,则使用@SpringBootApplication注解的类的包来搜索@Entity项。使用根软件包还允许组件扫描仅应用于您的项目。

Tip

如果您不想使用@SpringBootApplication,则导入的@EnableAutoConfiguration@ComponentScan注解将定义该行为,因此也可以使用它。

以下 Lists 显示了典型的布局:

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

}