SpringBoot公共模块配置方式

SpringBoot公共模块配置

开发微服务的项目中，很多时候会将公共的部分抽离出来单独实现，以便于重用、易于维护，为此，我们一般会将公共的配置信息放在公共模块中，这样能尽量减少重复的配置，使得代码结构更简洁清晰，下面是简单的两个模块的配置案例

先看下两个模块的配置结构，common-provider公共模块，包含公共的服务和公共的配置信息，merchant-provider具体业务模块

这是公共模块dev环境配置中的一个参数，后面将读取这个参数来测试

这个是最顶层的父pom，需要在当中配置上面两个模块的profile，其中

<profiles.active>dev</profiles.active>是当前业务模块的profile，

<commonactive>common-dev</commonactive>是公共模块的profile，<commonactive>标签的名称可以根据自己的需要取名称

父pom配置好了后，接下来只需要在merchant-provider模块的bootstrap.yml引入profile就可以了

active的参数值跟父pom中的profile配置的名称需要对应

接着在merchant-provider模块中引入common-provider模块

下面是common-provider模块中的一个文件服务接口，在里面引用了配置文件中的uploadFilePath参数

接下来启动merchant-provider模块

可以看到common-provider模块中uploadFile参数读取到了

Spring Bean和Mybatis接口 扫描路径配置

先看下两个模块的目录结构

common-provide模块

merchant-provider模块

在common-provide模块中，定义了一些公共服务，如FileService文件上传服务，系统配置服务，这些服务在其他的业务模块很多地方会用到，接下来通过配置后，在merchant-provider模块中调用common-provide模块中的FileService服务接口

在common-provide模块定义好了业务Bean以后，接下来就是要配置如何能调用到，也就是要配置扫描Bean的路径，以便Spring扫描到并加载到Spring容器，通常设置Bean的扫描路径无非就是在配置文件中指定路径、在启动类中通过注解@ComponentScan、@MapperScan注解指定，或者通过自定已的配置文件中指定

先看看在启动类中指定

上图中指定了三个扫描路径

@ComponentScan(basePackages ={"com.mall.comservice.service"})

指定common-provider公共模块服务Bean的扫描路径，这里把指定范围限定在最小的service目录，这样可以减少Spring扫描的范围

@MapperScan(basePackages = {"com.mall.merchant.dao,com.mall.comservice.dao"})

这里指定了common-provider公共模的扫描Mapper接口的路径com.mall.comservice.dao

指定了当前模块扫描Mapper接口的路径com.mall.merchant.dao

以上是比较常用的一种做法，但是我们这里是将common-provider公共模抽离出来重用，因此应该尽量减少代码侵入，而上面的这种做法意味着以后其他每个模块要调用common-provider模块时，都需要重复的在每个启动类上配置扫描路径，这种方式不便于维护

因此比较好的做法是，将扫描路径配置到common-provider模块的自定已配置类中，让公共模块自动扫描，而不依赖调用方来指定路径，这样其他业务模块就不用再重复的配置扫描路径了，只需要在pom文件中引入该模块即可

那么接下来我们在common-provider模块中定义一个配置类，并指定服务Bean和Mapper接口的扫描路径

因为需要让公共模块自动扫描，所以还需要针对配置类在建目录resources/META-INF/spring，在该目录下建org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，并在该文件中指定配置类的路径，让spring通过该路径扫描到配置类

注：因为本案例采用的是SpringBoot3，SpringBoot3对自动配置类进行了升级，对与SpringBoot2.7版本以下的还是按原来的配置方式，即在resources/META-INF/spring.factories文件中指定配置类的路径，SpringBoot2.7以上版本不在支持这种方式

接下来把merchant-provider模块中起启动类中指定的扫描路径去掉

启动运行看看效果

可以看到日志显示Common-provider模块中的Mapper接口被加载了

然后调用公共模块的FileService接口，接口被@Autowired注入进来了，可以正常的访问

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。