使用EnvironmentPostProcessor自定义启动配置

墨蓝 2022-12-28 00:43 171阅读 0赞

### 文章目录 ###

*   *   *   *  介绍
             *  基本使用
             *  测试Order注解
             *  覆盖application.properties

#### 介绍 ####

SpringBoot支持动态的读取文件，留下的扩展接口org.springframework.boot.env.EnvironmentPostProcessor。这个接口是spring包下的，使用这个进行配置文件的集中管理，而不需要每个项目都去配置配置文件。这种方法也是springboot框架留下的一个扩展（可以自己去扩展）

#### 基本使用 ####

任意路径下创建配置文件

![在这里插入图片描述][2020121219011862.png]

![在这里插入图片描述][20201212190122591.png]

定义MyEnvironmentPostProcessor实现EnvironmentPostProcessor接口

@Component
    public class MyEnvironmentPostProcessor1 implements EnvironmentPostProcessor { 
        @Override
        public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { 
            try { 
                System.out.println("MyEnvironmentPostProcessor1");
                InputStream inputStream = new FileInputStream("D:\\test1.properties");
                Properties properties = new Properties();
                properties.load(inputStream);
                PropertiesPropertySource propertiesPropertySource = new PropertiesPropertySource("test", properties);
                environment.getPropertySources().addLast(propertiesPropertySource);
            } catch (IOException e) { 
                e.printStackTrace();
            }
        }
    }

在classpath定义一个META-INF文件夹然后在其下面先建spring.factories文件，在其中指定：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70]

测试

@SpringBootApplication
    public class DemoApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(DemoApplication.class, args);
        }
    
        @Value("${jdbc.root.user}")
        String userName;
    
        @PostConstruct
        public void post() { 
            System.out.println("--------------------------------");
            System.out.println(userName);
        }
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70 1]

EnvironmentPostProcessor接口官网说明  
允许定制应用的上下文的应用环境优于应用的上下文之前被刷新，即可以在spring上下文构建之前可以设置一些系统配置  
EnvironmentPostProcessor的实现类必须要在META-INF/spring.factories文件中去注册，并且注册的是全类名。  
EnvironmentPostProcessor处理器检测Org.springframework.core.Ordered注解，这样相应的实例也会按照@Order注解的顺序去被调用。

#### 测试Order注解 ####

定义俩个配置类  
![在这里插入图片描述][20201212190230300.png]  
![在这里插入图片描述][20201212190235648.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70 2]

针对同一配置文件，同一命名空间的相同键值设置@Order()注解，结果是@Order()值越小的先执行，@Order()值大的后执行，并且非常重要的是后执行的会覆盖掉前面的值

覆盖流程如下：下面的name是当前配置文件的一个key，相当于一个命名空间  
![在这里插入图片描述][2020121219030540.png]

在执行addLast的时候会移除掉已有的配置文件，而PropertySource也重写equals和hashCode是以name作为重复判断的元素

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70 3]

看到上面我们可以总结出俩个结论：  
1：俩个相同名称的name的配置属性后执行的会覆盖掉前面的，注意是移除，然后添加，如果后面的配置文件里面内容和前面的不同，前面的配置文件即使有其他属性也同样不会被加载  
2：利用这样的处理流程我们可以操作IOC加载的一些配置，比如操作application.properties文件

#### 覆盖application.properties ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70 4]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70 5]

![在这里插入图片描述][20201212190350105.png]

通过上面代码可以看到Spring对于默认的配置文件已经设置对应的name，只要我们指定这个name就可以覆盖掉他的属性值，完成自定义的功能实现（默认配置文件的加载在自定义配置之前）

应用场景  
1：可以通过这种方式加载不在Classpath路径下的文件  
2：可以覆盖掉系统提供的默认配置  
3：当我们引入一些第三方框架，我们可以通过这种方式去替换其匹配的配置文件

[2020121219011862.png]: /images/20221120/ebb7bfaf2f7d4e59a09a0841f7167290.png
[20201212190122591.png]: /images/20221120/195da4c2564e4da7a4ced79ee227be43.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20201212190154356.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201212190211225.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ==,size_16,color_FFFFFF,t_70
[20201212190230300.png]: https://img-blog.csdnimg.cn/20201212190230300.png
[20201212190235648.png]: https://img-blog.csdnimg.cn/20201212190235648.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20201212190240508.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ==,size_16,color_FFFFFF,t_70
[2020121219030540.png]: https://img-blog.csdnimg.cn/2020121219030540.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20201212190315234.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20201212190340877.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20201212190331349.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L09jdG9wdXMyMQ==,size_16,color_FFFFFF,t_70
[20201212190350105.png]: https://img-blog.csdnimg.cn/20201212190350105.png