【框架----SpringBoot】jar包引用自动配置(Spring发现)解决方案

环境

JDK: 1.8

SpringBoot: 2.x

需求

当我们想要利用SpringBoot封装一套组件并发布给第三方使用时，我们需要考虑组件能否被使用者正确引入使用。

此处提供三种解决方案，友好型依次提升。

1. 手动配置 basePackages
2. 使用者通过注解方式启用配置
3. SpringBoot 主动发现

一、手动配置

使用者：繁琐，手动配置 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

二、注解方式

使用者：繁琐，手动配置使用注解，忘记时不生效

开发者：简单，不需要任何其余配置，只需在测试环境测试后直接打包发布。

项目结构

LogRecordClientConfig 则为我们主要配置类，相当于我们组件的入口，代码如下：

@Configuration
@ComponentScan("top.huic.logrecord.client.**")
public class LogRecordClientConfig {
}

@Configuration是声明为一个配置类

@ComponentScan是设置自动扫描包，让Spring能够发现我们封装的组件的其他 Spring Bean

 

到这儿还远远没完，因为我们的目的是使用者通过注解才能发现该配置类，所以我们还需要建立一个注解类，此处取名为 EnableLogRecordClient，我们来看看EnableLogRecordClient中的代码：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Import({LogRecordClientConfig.class})
public @interface EnableLogRecordClient {
}

关键代码为@Import，此行是代码导入LogRecordClientConfig 类，也就是我们前面的配置类。

当使用者使用我们组件，需要在能被Spring发现到的 Configuration 上使用我们的注解，代码如下:

@EnableLogRecordClient
@Configuration
public class TestConfig {
}

这样，当用户启动程序时，Spring就会将 LogRecordClientConfig 注册到Bean，然后读取LogRecordClientConfig中的 @ComponentScan注解，就实现了我们组件全包被Spring覆盖

 

三、spring.factories

使用者：简单，不需要任何配置

开发者：简单，增加一个配置文件即可

最后一种Spring Boot Starter，推荐使用，如遇复杂业务，可在第二种和第三种中取舍

目录结构

LogRecordPlusUiStart 等同于方法2的 LogRecordClientConfig，请参照配置

此方法最关键的为 resources/META-INF/spring.factories 文件，当项目启动时，Spring会扫描所有jar包下面的 spring.factories 文件，进行相应的自动配置处理，此处我们不进行深入讲解，只看看基本配置

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
top.huic.logrecord.plus.ui.LogRecordPlusUiStart

其中  org.springframework.boot.autoconfigure.EnableAutoConfiguration 代表自动配置的 key，即代表需要自动配置哪些类，\ 可以理解为一个换行符，则该行下面的每行当做一个参数

第二行则为我们刚才看见的配置类的全路径，如果需要 Spring 自动配置多个类，我们依行写入它的全路径即可，例如

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
top.huic.logrecord.plus.ui.LogRecordPlusUiStartA,\
top.huic.logrecord.plus.ui.LogRecordPlusUiStartB,\
top.huic.logrecord.plus.ui.LogRecordPlusUiStartC

当做完这一步，我们的组件就可以打包了，然后使用者只需要引入我们的jar包，Spring就会在启动时对我们 spring.factories 中的所有配置类进行自动配置