14. 构建代码

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

14.1 使用"default"软件包

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

Tip

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

14.2 查找主应用程序类

我们通常建议您将主应用程序类放在其他类之上的根包中。 @EnableAutoConfigurationComments 通常放在您的主类上,并且为某些项目隐式定义了基本的“搜索包”。例如,如果您正在编写 JPA 应用程序,则使用@EnableAutoConfigurationComments 类的包将搜索@Entity项。

使用根包也可以使用@ComponentScanComments,而无需指定basePackage属性。如果您的主类在根包中,则也可以使用@SpringBootApplication注解。

这是典型的布局:

com
 +- example
     +- myproject
         +- Application.java
         |
         +- domain
         |   +- Customer.java
         |   +- CustomerRepository.java
         |
         +- service
         |   +- CustomerService.java
         |
         +- web
             +- CustomerController.java

Application.java文件将与基本@Configuration一起声明main方法。

package com.example.myproject;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}