文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

SpringBoot的EnvironmentPostProcessor怎么用

2023-06-30 10:15

关注

今天小编给大家分享一下SpringBoot的EnvironmentPostProcessor怎么用的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。

一、背景

之前项目中用到了Apollo配置中心,对接Apollo配置中心后,配置中心的属性就可以在程序中使用了,那么这个是怎么实现的呢?配置中心的属性又是何时加载到程序中的呢?那么我们如果找到了这个是怎么实现的是否就可以 从任何地方加载配置属性配置属性的加解密功能呢

二、需求

SpringBoot的EnvironmentPostProcessor怎么用

从上图中得知,我们的需求很简单,即我们自己定义的属性需要比配置文件中的优先级更高。

三、分析

1、什么时候向SpringBoot中加入我们自己的配置属性

当我们想在Bean中使用配置属性时,那么我们的配置属性必须在Bean实例化之前就放入到Spring到Environment中。即我们的接口需要在 application context refreshed 之前进行调用,而 EnvironmentPostProcessor 正好可以实现这个功能。

2、获取配置属性的优先级

我们知道在 Spring中获取属性是有优先级的。
比如我们存在如下配置属性 username

├─application.properties│   >> username=huan├─application-dev.properties│   >> username=huan.fu

那么此时 username 的值是什么呢?此处借用 Apollo的一张图来说解释一下这个问题。

参考链接:https://www.apolloconfig.com/#/zh/design/apollo-design

SpringBoot的EnvironmentPostProcessor怎么用

Spring从3.1版本开始增加了ConfigurableEnvironmentPropertySource

ConfigurableEnvironment

PropertySource

由上方的原理图可知,key在最开始出现的PropertySource中的优先级更高,上面的例子在SpringBootusername的值为huan.fu

3、何时加入我们自己的配置

由第二步 获取配置属性的优先级 可知,PropertySource 越靠前越先执行,那么要我们配置生效,就必须放在越前面越好。

SpringBoot的EnvironmentPostProcessor怎么用

由上图可知,SpringBoot加载各种配置是通过EnvironmentPostProcessor来实现的,而具体的实现是ConfigDataEnvironmentPostProcessor来实现的。那么我们自己编写一个EnvironmentPostProcessor的实现类,然后在ConfigDataEnvironmentPostProcessor后执行,并加入到 Environment中的第一位即可。

SpringBoot的EnvironmentPostProcessor怎么用

四、实现

1、引入SpringBoot依赖

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>    <parent>        <groupId>org.springframework.boot</groupId>        <artifactId>spring-boot-starter-parent</artifactId>        <version>2.6.6</version>        <relativePath/> <!-- lookup parent from repository -->    </parent>    <groupId>com.huan.springcloud</groupId>    <artifactId>springboot-extension-point</artifactId>    <version>0.0.1-SNAPSHOT</version>    <name>springboot-extension-point</name>    <properties>        <java.version>1.8</java.version>    </properties>    <dependencies>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-web</artifactId>        </dependency>    </dependencies></project>

2、在application.properties中配置属性

vim application.properties
username=huan

3、编写自定义属性并加入Spring Environment中

SpringBoot的EnvironmentPostProcessor怎么用

注意:
1、如果发现程序中日志没有输出,检查是否使用了slf4j输出日志,此时因为日志系统未初始化无法输出日志。解决方法如下:

SpringBoot版本>= 2.4 可以参考上图中的使用 DeferredLogFactory 来输出日志< 2.41、参考如下链接 https://stackoverflow.com/questions/42839798/how-to-log-errors-in-a-environmentpostprocessor-execution2、核心代码:@Componentpublic class MyEnvironmentPostProcessor implements        EnvironmentPostProcessor, ApplicationListener<ApplicationEvent> {    private static final DeferredLog log = new DeferredLog();    @Override    public void postProcessEnvironment(            ConfigurableEnvironment env, SpringApplication app) {        log.error("This should be printed");    }    @Override    public void onApplicationEvent(ApplicationEvent event) {        log.replayTo(MyEnvironmentPostProcessor.class);    }}

4、通过SPI使自定义的配置生效

src/main/resources下新建META-INF/spring.factories文件

SpringBoot的EnvironmentPostProcessor怎么用

配置

org.springframework.boot.env.EnvironmentPostProcessor=\  com.huan.springcloud.extensionpoint.environmentpostprocessor.CustomEnvironmentPostProcessor

5、编写测试类,输出定义的 username 属性的值

@Componentpublic class PrintCustomizeEnvironmentProperty implements ApplicationRunner {    private static final Logger log = LoggerFactory.getLogger(PrintCustomizeEnvironmentProperty.class);    @Value("${username}")    private String userName;    @Override    public void run(ApplicationArguments args) {        log.info("获取到的 username 的属性值为: {}", userName);    }}

6、运行结果

SpringBoot的EnvironmentPostProcessor怎么用

五、注意事项

1、日志无法输出

参考上方的 3、编写自定义属性并加入Spring Environment中提供的解决方案。

配置没有生效检查

3、日志系统如何初始化

如下代码初始化日志系统

org.springframework.boot.context.logging.LoggingApplicationListener

以上就是“SpringBoot的EnvironmentPostProcessor怎么用”这篇文章的所有内容,感谢各位的阅读!相信大家阅读完这篇文章都有很大的收获,小编每天都会为大家更新不同的知识,如果还想学习更多的知识,请关注编程网行业资讯频道。

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯