Spring Boot 2.x基础教程：工程结构推荐

CollinPeng 发布于2019-08-19 11:38 / 680人阅读

摘要：典型示例以下结构是比较推荐的组织方式，所有的类和其他都在之下。应用主类，该类直接位于下。默认情况下，的应用主类会自动扫描以及所有子包下的所有类来进行初始化。

Spring Boot框架本身并没有对工程结构有特别的要求，但是按照最佳实践的工程结构可以帮助我们减少可能会遇见的坑，尤其是Spring包扫描机制的存在，如果您使用最佳实践的工程结构，可以免去不少特殊的配置工作。

典型示例

以下结构是比较推荐的package组织方式：

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

root package：com.example.myproject，所有的类和其他package都在root package之下。

应用主类：Application.java，该类直接位于root package下。通常我们会在应用主类中做一些框架配置扫描等配置，我们放在root package下可以帮助程序减少手工配置来加载到我们希望被Spring加载的内容

com.example.myproject.domain包：用于定义实体映射关系与数据访问相关的接口和实现

com.example.myproject.service包：用于编写业务逻辑相关的接口与实现

com.example.myproject.web：用于编写Web层相关的实现，比如：Spring MVC的Controller等

上面的结构中，root package与应用主类的位置是整个结构的关键。由于应用主类在root package中，所以按照上面的规则定义的所有其他类都处于root package下的其他子包之后。默认情况下，Spring Boot的应用主类会自动扫描root package以及所有子包下的所有类来进行初始化。

什么意思呢？举个例子，假设我们将com.example.myproject.web包与上面所述的root package：com.example.myproject放在同一级，像下面这样：

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

这个时候，应用主类Application.java在默认情况下就无法扫描到com.example.myproject.web中的Controller定义，就无法初始化Controller中定义的接口。

非典型结构下的初始化

那么如果，我们一定要加载非root package下的内容怎么办呢？

方法一：使用@ComponentScan注解指定具体的加载包，比如：

@SpringBootApplication
@ComponentScan(basePackages="com.example")
public class Bootstrap {

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

}

这种方法通过注解直接指定要扫描的包，比较直观。如果有这样的需求也是可以用的，但是原则上还是推荐以上面的典型结构来定义，这样也可以少写一些注解，代码更加简洁。

方法二：使用@Bean注解来初始化，比如：

@SpringBootApplication
public class Bootstrap {

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

    @Bean
    public CustomerController customerController() {
        return new CustomerController();
    }

}

这种方法在业务开发的时候并不是特别推荐，更适合用于框架封装等场景，关于更多封装上的技巧，后面我们在进阶教程中详细讲解。

如果读者觉得自己团队使用的工程结构不错，欢迎留言分享~

代码示例

本教程配套仓库：

Github：https://github.com/dyc87112/SpringBoot-Learning/tree/2.x

Gitee：https://gitee.com/didispace/SpringBoot-Learning/tree/2.x

如果您觉得本文不错，欢迎Star支持，您的关注是我坚持的动力！

专栏推荐

Spring Boot从入门到精通

Spring Cloud从入门到精通

关联内容

Spring Boot工程结构推荐 - 1.x版本

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/77609.html

Spring Boot 2.x基础教程：快速入门

摘要：编写一个接口创建命名为根据实际情况修改创建类，内容如下启动主程序，使用等工具发起请求，可以看到页面返回编写单元测试用例打开的下的测试入口类。简介在您第1次接触和学习Spring框架的时候，是否因为其繁杂的配置而退却了？在你第n次使用Spring框架的时候，是否觉得一堆反复黏贴的配置有一些厌烦？那么您就不妨来试试使用Spring Boot来让你更易上手，更简单快捷地构建Spring应...

tigerZH 2019-08-16 16:08 评论0 收藏0
Spring Boot 2 快速教程：WebFlux 集成 Thymeleaf（五）

摘要：数据和信息是不可分离的，数据是信息的表达，信息是数据的内涵。数据本身没有意义，数据只有对实体行为产生影响时才成为信息。主要目标是为开发提供天然的模板，并且能在里面准确的显示。目前是自然更加推荐。这是泥瓦匠的第105篇原创文章工程： JDK 1.8 Maven 3.5.2 Spring Boot 2.1.3.RELEASE 工程名：springboot-webflux-4-thym...

姘存按 2019-08-16 17:46 评论0 收藏0
Spring Boot 2.x 系列教程：WebFlux 系列教程大纲（一）

摘要：使用则需要及以上版本。开发使用框架七系列教程目录系列教程大纲快速入门实践实践整合整合中和实践整合中实现缓存中实现通信集成测试及部署实战图书管理系统 WebFlux 系列教程大纲一、背景大家都知道，Spring Framework 是 Java/Spring 应用程序跨平台开发框架，也是 Java EE（Java Enterprise Edition）轻量级框架，其 Spring ...

jone5679 2019-08-16 16:53 评论0 收藏0
Spring Boot 2.x 系列教程：WebFlux REST API 全局异常处理 Error

摘要：挺多人咨询的，异常处理用切面注解去实现去全局异常处理。全局异常处理类，代码如下代码解析如下抽象类是用来处理全局错误时进行扩展和实现注解标记的切面排序，值越小拥有越高的优先级，这里设置优先级偏高。本文内容为什么要全局异常处理？ WebFlux REST 全局异常处理实战小结摘录：只有不断培养好习惯，同时不断打破坏习惯，我们的行为举止才能够自始至终都是正确的。一、为什么要全局...

BicycleWarrior 2019-08-16 16:43 评论0 收藏0
Spring Boot 2 快速教程：WebFlux 快速入门（二）

摘要：响应式编程是基于异步和事件驱动的非阻塞程序，只是垂直通过在内启动少量线程扩展，而不是水平通过集群扩展。三特性常用的生产的特性如下响应式编程模型适用性内嵌容器组件还有对日志消息测试及扩展等支持。摘要: 原创出处 https://www.bysocket.com 「公众号：泥瓦匠BYSocket 」欢迎关注和转载，保留摘要，谢谢！ 02：WebFlux 快速入门实践文章工程： JDK...

gaara 2019-08-16 17:14 评论0 收藏0