一、背景之前项目中用到了apollo配置中心,对接apollo配置中心后,配置中心的属性就可以在程序中使用了,那么这个是怎么实现的呢?配置中心的属性又是何时加载到程序中的呢?那么我们如果找到了这个是怎么实现的是否就可以 从任何地方加载配置属性、配置属性的加解密功能呢?
二、需求
从上图中得知,我们的需求很简单,即我们自己定义的属性需要比配置文件中的优先级更高。
三、分析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
spring从3.1版本开始增加了configurableenvironment和propertysource:
configurableenvironment
spring的applicationcontext会包含一个environment(实现configurableenvironment接口)
configurableenvironment自身包含了很多个propertysource
propertysource
属性源
可以理解为很多个key - value的属性配置
由上方的原理图可知,key在最开始出现的propertysource中的优先级更高,上面的例子在springboot中username的值为huan.fu。
3、何时加入我们自己的配置由第二步 获取配置属性的优先级 可知,propertysource 越靠前越先执行,那么要我们配置生效,就必须放在越前面越好。
由上图可知,springboot加载各种配置是通过environmentpostprocessor来实现的,而具体的实现是configdataenvironmentpostprocessor来实现的。那么我们自己编写一个environmentpostprocessor的实现类,然后在configdataenvironmentpostprocessor后执行,并加入到 environment中的第一位即可。
四、实现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中
注意:
1、如果发现程序中日志没有输出,检查是否使用了slf4j输出日志,此时因为日志系统未初始化无法输出日志。解决方法如下:
springboot版本 >= 2.4 可以参考上图中的使用 deferredlogfactory 来输出日志 < 2.4 1、参考如下链接 https://stackoverflow.com/questions/42839798/how-to-log-errors-in-a-environmentpostprocessor-execution 2、核心代码: @component public 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使自定义的配置生效1、在 src/main/resources下新建meta-inf/spring.factories文件
2、配置
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、运行结果
五、注意事项1、日志无法输出参考上方的 3、编写自定义属性并加入spring environment中提供的解决方案。
2、配置没有生效检查
检查environmentpostprocessor的优先级,看看是否@order或者ordered返回的优先级值不对。
看看别的地方是否实现了 environmentpostprocessor或applicationcontextinitializer或beanfactorypostprocessor或beandefinitionregistrypostprocessor等这些接口,在这个里面修改了 propertysource的顺序。
理解 spring 获取获取属性的顺序 参考 2、获取配置属性的优先级
3、日志系统如何初始化如下代码初始化日志系统
org.springframework.boot.context.logging.loggingapplicationlistener
以上就是springboot的environmentpostprocessor怎么用的详细内容。