SpringBoot 官方文档中文版 - 3. 构建你的代码

前言

这是 SpringBoot 官方文档中文翻译版系列的第三篇文章：

前两篇文章如下：

SpringBoot 官方文档中文版 - 1. 入门指南

SpringBoot 官方文档中文版 - 2. 构建系统

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

1.避免使用“默认”包

当一个类不包含包声明时，它被认为是在“默认包”中。通常不鼓励使用“默认包”，应该避免使用。

对于使用 @ComponentScan、@ConfigurationPropertiesScan、@EntityScan或@SpringBootApplication 注释的 SpringBoot 应用程序来说，它可能会导致特定的问题，因为每个 jar 中的每个类都被读取。

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

2. 主应用程序类的位置

我们通常建议您将主应用程序类放在其他类之上的根包中。@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

MyApplication.java 文件将声明 mian 方法，以及基本的 @SpringBootApplication，如下所示:

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

}

每天学习一点点，每天进步一点点。