14. 结构化你的代码

Spring Boot不需要任何特定的代码布局来工作，然而有一些最佳实践可以提供帮助。

14.1 使用“default”包

当一个类不包含package声明时，它被认为是在“default package”中，使用“default package”通常是不鼓励的，应该避免使用，它可能会导致使用@ComponentScan、@EntityScan或@SpringBootApplication注解的Spring Boot应用程序的特殊问题，因为每个jar的每个类都被读取。

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

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

上一篇：构建系统

下一篇：自动配置