Spring Boot自动配置第三方jar包中的配置

Myth丶恋晨 2023-03-12 09:05 14阅读 0赞

## 一、需求描述 ##

写了一个maven项目封装一套组件可以给第三方使用，如果第三方直接引用依赖，Spring Boot不会对引用的jar中的配置类（如带有@Configuration的类）

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

*  1.使用者手动配置 **@ComponentScan**
 *  2.配置开关决定是否开启配置
 *  3.**Spring Boot** 主动加载

这三种方式友好程度依次递增

## 二、解决方案 ##

### 1. 使用 @ComponentScan ###

只需在第三方程序的启动类或自定义的配置类中添加 **@ComponentScan** 注解即可  
**（1）启动类**

@SpringBootApplication
    @ComponentScan(basePackages = "com.jz.order")
    public class OrderApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(OrderApplication.class, args);
        }
    }

**（2）配置类**

@Configuration
    @ComponentScan(basePackages = { "com.jz.order"})
    public class TestConfig{ 
    }

### 2. 通过配置开关 ###

**（1）在自定义组件中添加配置类**

@Configuration
    @ComponentScan(basePackages = { "com.jz.order"})
    public class TestConfig{ 
    }

**（2）在自定义组件中添加注解开关**

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

**（3）在第三方应用中添加开关**

@EnableTestConfig
    @Configuration
    public class Config { 
    }

或者直接在启动类中添加 **@EnableTestConfig** 注解即可。

### 3. Spring 自动配置 ###

在自定义组件的 **resources** 中新建 **META-INF** 目录并添加 **spring.factories** 配置文件，内容如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.jz.order.TestConfig

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

从第二行开始，每一行都是一个需要自动配置的类的全路径。

这样第三方应用只需引用自定义组件的依赖即可自动加载配置文件

参考：https://www.cnblogs.com/adversary/p/10346278.html