SpringBoot - 如何解决多模块依赖时BEAN无法注入的问题?

逃离我推掉我的手 2023-10-08 16:58 12阅读 0赞

#### 写在前面 ####

在实际的项目中会存在一个项目包含多个模块的情况，而多个模块之间又存在着依赖关系，如何设置才能让多个模块在主模块启动时全部加载到Spring容器中呢？在开始之前，我们先了解一下Spring的自动注入。  
[SpringBoot - @ComponentScan注解使用详解][SpringBoot - _ComponentScan]  
[SpringBoot - @Configuration注解使用详解][SpringBoot - _Configuration]  
[SpringBoot - 向容器中注册组件的方法有哪些？][SpringBoot -]  
[SpringBoot - 如何查看Spring上下文中加载的Bean][SpringBoot - _Spring_Bean]

###### 1. 自动注入 ######

在基于SpringBoot框架的项目中，我们会使用到@Bean，@Configuration，@Contoller，@Service，@Component等注解来标注我们的的业务类，被添加这些注解的类在SpringBoot 启动时，会自动被装配到Spring容器中。

###### 2. 自动装配 ######

当SpringBoot 启动时，根据定义的扫描路径，把符合扫描规则的类装配到Spring容器中。简单来讲：在Spring中通过定义BEAN的注解定义了一些BEAN，而Spring并不知道除非你告诉它去哪里可以找到它们，而@ComponentScan的作用就是告诉Spring容器去哪个路径下可以找到这些BEAN。

###### 3. 扫描策略 ######

（1）通过使用 value，basePackages 属性来指定扫描范围；  
（2）自动扫描指定路径下带有 @Controller，@Service，@Repository，@Component 等注解标注的类到Spring容器中；  
（3）通过 includeFilters 将扫描路径下没有以上注解的类加入 Spring 容器；  
（4）通过 excludeFilters 将扫描路径下的类过滤并标识出无需加入到Spring 容器的类；  
（5）通过自定义的方式，将符合规则的类加入到Spring容器中。

#### 场景描述 ####

项目名servicex-single，该项目有三个模块分别为：servicex-admin、servicex-system和servicex-common，servicex-admin依赖于servicex-system模块，servicex-system依赖于servicex-common模块，他们的基础包路径分包为：com.handoopx.servicex.admin、com.handoopx.servicex.system和com.handoopx.servicex.common，servicex-admin为主模块。

#### 解决方案 ####

如果不做任何配置的话，只会扫描启动类当前包路径（com.handoopx.servicex.admin）及其子路径下的文件，并将符合条件的对象注入到Spring容器中，所以这也就导致了，servicex-system和servicex-common模块中的类，虽然添加了@Bean的注解，也不会加入到容器中的现象。

所以需要进行如下配置：

@SpringBootApplication(scanBasePackages = {
        "com.handoopx.servicex"})

#### 源码、示例及DEMO ####

[源码、示例及DEMO][DEMO]

[SpringBoot - _ComponentScan]: https://blog.csdn.net/goodjava2007/article/details/122265287
[SpringBoot - _Configuration]: https://blog.csdn.net/goodjava2007/article/details/122212748
[SpringBoot -]: https://blog.csdn.net/goodjava2007/article/details/125268145
[SpringBoot - _Spring_Bean]: https://blog.csdn.net/goodjava2007/article/details/122235877
[DEMO]: https://gitee.com/cloneme01/preflight