JAVA SpringBoot 项目打成jar包供第三方引用自动配置(Spring发现)解决方案
本项目测试环境
jdk: 1.8
springboot: 2.1
-
需求描述
当我们想要利用springboot封装一套组件并发布给第三方使用时,我们就不得不考虑我们的组件能否被使用者正确引入使用,此处描述的时打包成 jar 包后 spring 配置类不为扫描、未注册bean的问题。
-
解决方案
此处提供三种解决方案,友好型依次提升。
- 使用者手动配置 basepackages
- 使用者通过注解方式启用配置
- springboot 主动发现
-
正文开始
第一种:使用者手动配置 basepackages (对组件开发者最为简单,对使用者最为繁琐)
使用此方式,对组件开发者最为简单,不需要对项目进行任何其余配置,我们只需要在测试环境使用功能后直接打包发布。
但是使用者使用时需要手动配置 basepackages,假设我们的组件的包基础为:“top.huic.logrecord.ui”,则在使用时应进行如下配置:
@configuration @componentscan(basepackages = {"top.huic.logrecord.plus.ui.**"}) public class testconfig{ }配置方式: 在springboot启动类或能被spring发现的 configuration 类上增加 @componentscan(basepackages={"top.huic.logrecord.plus.ui.**"})
通过此方式配置后,spring会在启动时扫描 top.huic.logrecord.plus.ui 这个包,我们的组件自然而然也会被注册为spring bean
第二种:使用者通过注解方式引入(在特定的需求环境使用)
第一种方式需要使用者手动进行 basepackages 配置,当使用者忘记配置时,我们的组件则不会生效,第二种雷同,只不过配置方式有变
首先来看看我们项目(组件)的文件结构
logrecordclientconfig 则为我们主要配置类,相当于我们组件的入口,代码如下:
1 @configuration 2 @componentscan("top.huic.logrecord.client.**") 3 public class logrecordclientconfig { 4 }其中,第一行是声明为一个配置类
第二行为设置自动扫描包,让spring能够发现我们封装的组件的其他 spring bean
到这儿还远远没完,因为我们的目的是使用者通过注解才能发现该配置类,所以我们还需要建立一个注解类,此处取名为 enablelogrecordclient,我们来看看enablelogrecordclient中的代码:
1 @retention(retentionpolicy.runtime) 2 @target({elementtype.type}) 3 @documented 4 @import({logrecordclientconfig.class}) 5 public @interface enablelogrecordclient { 6 }关键代码为第 4 行,此行是代码导入 logrecordclientconfig 类,也就是我们前面的配置类。
自此,我们的任务就完成了,剩下的步骤就交于使用者了。
当使用者使用我们组件,需要在能被spring发现到的 configuration 上使用我们的注解,代码如下:
@enablelogrecordclient @configuration public class testconfig { }
这样,当用户启动程序时,spring就会将 logrecordclientconfig 注册到bean,然后读取logrecordclientconfig中的 @componentscan 注解,就实现了我们组件全包被spring覆盖
第三种:这也是本文介绍的最后一种,对组件开发者和使用者都比较友好,故推荐使用,如遇复杂业务,可在第二种和第三种中取舍
使用此方法时,我们任然来看看目录结构
logrecordplusuistart 等同于方法2的 logrecordclientconfig,请参照配置
此方法最关键的为 resources/meta_inf/spring.factories 文件,当项目启动时,spring会扫描所有jar包下面的 spring.factories 文件,进行相应的自动配置处理,此处我们不进行深入讲解,只看看基本配置
1 org.springframework.boot.autoconfigure.enableautoconfiguration=\ 2 top.huic.logrecord.plus.ui.logrecordplusuistart其中 org.springframework.boot.autoconfigure.enableautoconfiguration 代表自动配置的 key,即代表需要自动配置哪些类,\ 可以理解为一个换行符,则该行下面的每行当做一个参数
第二行则为我们刚才看见的配置类的全路径,如果需要 spring 自动配置多个类,我们依行写入它的全路径即可
当做完这一步,我们的组件就可以打包了,然后使用者只需要引入我们的jar包,spring就会在启动时对我们 spring.factories 中的所有配置类进行自动配置
自此,三种方法均介绍完毕。
如需深入了解此方法,请自行搜索 spring boot starter
下一篇: Red and Black