SpringBoot扩展外部化配置的原理解析
Environment实现原理
在基于SpringBoot开发的应用中,我们常常会在application.properties
、application-xxx.properties
、application.yml
、application-xxx.yml
等配置文件中设置一些属性值,然后通过@Value
、@ConfigurationProperties
等注解获取,或者采用编码的方式通过Environment
获取。
# application.properties my.config.appId=demo
@RestController public class WebController { @Value("${my.config.appId}") private String appId; @Autowired private Environment env; @Autowired private ConfigurableEnvironment environment; @GetMapping("/appInfo") public String appInfo() { System.out.println(environment.getProperty("my.config.appId")); System.out.println(env.getProperty("my.config.appId")); System.out.println(appId); System.out.println(env == environment); //true return appId; } }
实际上env
和environment
是同一个对象,在Spring中ConfigurableEnvironment
是Environment
的子类,具体实现类全部是通过implements
ConfigurableEnvironment
接口来实现,所以所有可以拿到Environment
接口地方都可以强制转换为ConfigurableEnvironment
。
ConfigurableEnvironment
继承Environment
,Environment
继承PropertyResolver
,主要提供了对属性获取方法,AbstractEnvironment
做为抽象类实现了ConfigurableEnvironment
接口方法,其内部是通过org.springframework.core.env.MutablePropertySources
来保存不同类型的属性资源。而MutablePropertySources
内部实际上就是List<PropertySource<?>>集合。
public interface ConfigurableEnvironment extends Environment, ConfigurablePropertyResolver { void setActiveProfiles(String... profiles); void addActiveProfile(String profile); void setDefaultProfiles(String... profiles); //MutablePropertySources 内部实际上就是**List<PropertySource<?>>集合 MutablePropertySources getPropertySources(); Map<String, Object> getSystemProperties(); Map<String, Object> getSystemEnvironment(); void merge(ConfigurableEnvironment parent); }
PropertySource
是什么呢?
其实就是一个key-value集合,key就是一个配置项,value就是配置的值。
例如: 通过System.getProperties()
得到的系统属性就是一种类型的PropertySource
,通过application.yml
配置的属性是另一种属性资源。当调用env.getProperty()
获取属性值时,会遍历PropertySource集合,只要有一个PropertySource
中有对应属性值则不再继续遍历查找,所以在集合中越靠前的属性优先级越高。
获取某个配置项值的访问方式,源码如下:
org.springframework.core.env.PropertySourcesPropertyResolver#getProperty(java.lang.String, java.lang.Class<T>, boolean)
protected <T> T getProperty(String key, Class<T> targetValueType, boolean resolveNestedPlaceholders) { if (this.propertySources != null) { for (PropertySource<?> propertySource : this.propertySources) { if (logger.isTraceEnabled()) { logger.trace("Searching for key '" + key + "' in PropertySource '" + propertySource.getName() + "'"); } Object value = propertySource.getProperty(key); if (value != null) { if (resolveNestedPlaceholders && value instanceof String) { value = resolveNestedPlaceholders((String) value); } logKeyFound(key, propertySource, value); return convertValueIfNecessary(value, targetValueType); } } } if (logger.isTraceEnabled()) { logger.trace("Could not find key '" + key + "' in any property source"); } return null; }
如何扩展自己的外部化配置?
实际上我们可以利用SpringBoot中的扩展点,拿到ConfigurableEnvironment
对象来获取到MutablePropertySources
,添加自己的PropertySource
就行,例如可以访问一个http接口,获取外部化配置。
扩展接口及优先级如下
梯形缩进表示内部调用了下面的接口实现
1.org.springframework.boot.SpringApplicationRunListener#environmentPrepared(ConfigurableBootstrapContext, ConfigurableEnvironment)
1.ApplicationListener< org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent>
EnvironmentPostProcessorApplicationListener
1. org.springframework.boot.env.EnvironmentPostProcessor
1.org.springframework.boot.context.config.ConfigDataLoader
1.org.springframework.boot.env.PropertySourceLoader
1.org.springframework.context.ApplicationContextInitializer#initialize
1.org.springframework.boot.SpringApplicationRunListener#contextPrepared
4.org.springframework.boot.context.event.ApplicationPreparedEvent
5.org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry
org.springframework.beans.factory.config.BeanFactoryPostProcessor#postProcessBeanFactory
但是在4.BeanDefinitionRegistryPostProcessor
和5.BeanFactoryPostProcessor
中扩展时机比较晚,这个时候已经执行完包扫描,如果在这个时机添加自己的外部化配置,对于注解@ConditionalOnProperty
可能大部分不会生效。
Apollo配置中心客户端和SpringBoot的整合实现
Apollo配置中心客户端是如何与SpringBoot整合的?
开源的Apollo配置中心默认启动就是通过BeanFactoryPostProcessor
来扩展apollo上的配置到Spring的Environment
中,
@EnableApolloConfig
注解向Spring中导入了bean com.ctrip.framework.apollo.spring.config.PropertySourcesProcessor
,PropertySourcesProcessor
同时实现了org.springframework.core.PriorityOrdered
并设置了最高的执行优先级Ordered.HIGHEST_PRECEDENCE
,但是由于包扫描已经在PropertySourcesProcessor
之前执行完成,所以即使设置了最高优先级,同样无法解决在Spring执行包扫描阶段访问不到apllo上的配置问题。
因此在SpringBoot项目中,apollo提供了另一种启动方式,使用配置项apollo.bootstrap.enabled = true
来解决,实现类为com.ctrip.framework.apollo.spring.boot.ApolloApplicationContextInitializer
,其主要是通过实现第2个扩展接口org.springframework.context.ApplicationContextInitializer
来提前将apollo的PropertySource
添加到Spring的Environment
中。
这样我们就可以通过Environment
来获取到apollo中的配置项值。而@ConditionalOnProperty
则是从Environment
获取属性值来判断的条件是否成立,因此使用该接口扩展Environment,@ConditionalOnProperty
注解则可以在启动阶段正常访问到apollo中的配置项。
到此这篇关于SpringBoot扩展外部化配置的原理解析的文章就介绍到这了,更多相关SpringBoot扩展外部化配置内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞!
相关文章
IntelliJ IDEA2021.1 配置大全(超详细教程)
这篇文章主要介绍了IntelliJ IDEA2021.1 配置大全(超详细教程),需要的朋友可以参考下...2021-04-18- VPN可以虚拟出一个专用网络,让远处的计算机和你相当于处在同一个局域网中,而中间的数据也可以实现加密传输,用处很大,特别是在一些大公司,分公司处在不同的区域。...2016-01-27
- 这篇文章主要介绍了Tomcat配置及如何在Eclipse中启动,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-02-04
- 如果我们需要安培Laravel4的话最php最低要求要在php5.3.7版本并且我们需要把mcrypt与openss这两个扩展开启才可以,具体步骤我们参考下文。 前面我们介绍我了 com...2016-11-25
解决springboot使用logback日志出现LOG_PATH_IS_UNDEFINED文件夹的问题
这篇文章主要介绍了解决springboot使用logback日志出现LOG_PATH_IS_UNDEFINED文件夹的问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-04-28- 这篇文章主要为大家详细介绍了SpringBoot实现excel文件生成和下载,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-02-09
详解Maven profile配置管理及激活profile的几种方式
这篇文章主要介绍了详解Maven profile配置管理及激活profile的几种方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-01-26- 这篇文章主要介绍了详解springBoot启动时找不到或无法加载主类解决办法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-09-16
- 这篇文章主要介绍了SpringBoot集成Redis实现消息队列的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-02-10
- 这篇文章主要介绍了IDEA如何添加配置文件到classpath中,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-19
- 通常php.ini的位置在:复制代码 代码如下:/etc目录下或/usr/local/lib目录下。如果你还是找不到php.ini或者找到了php.ini修改后不生效(其实是没找对),请使用如下办法:1.新建php文件,写入如下代码复制代码 代码如下:<?phpe...2014-05-31
- 以下就是部署PHP时的4个配置修改说明,大家一个一个进行学习研究。1、short_open_tag 是什么呢? 决定是否允许使用代码开始标志的缩写形式(<? ?> )。如果要和 XML 结合使用PHP,可以禁用此选项以便于嵌入使用<?x...2015-10-21
- 这篇文章主要介绍了解决Springboot get请求是参数过长的情况,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-09-17
- 这篇文章主要介绍了Springboot+TCP监听服务器搭建过程,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2020-10-28
Spring Boot项目@RestController使用重定向redirect方式
这篇文章主要介绍了Spring Boot项目@RestController使用重定向redirect方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-02- 这篇文章主要介绍了springBoot 项目排除数据库启动方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-10
- 在使用vue-router的项目中,实例化VueRouter是其配置选项routes该选项指定路由与视图的组件的关系或者路由与其他路由的关系,Router配置选项中是其中最重要的配置。本文就详细的介绍一下...2021-10-25
华为畅享20Pro配置怎么样?华为畅享20Pro参数配置分析
华为畅享20Pro配置怎么样?对于即将上市的华为畅享20 Pro手机,很多的网友们也是相当关注的,大家都想要知道这款华为畅享20 Pro手机的配置到底怎么样,赶紧看看吧...2020-06-29springboot中使用@Transactional注解事物不生效的坑
这篇文章主要介绍了springboot中使用@Transactional注解事物不生效的原因,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-01-26- vue项目中有一些方法需要在多个页面调用,但为了避免在每个页面都import进来,可以把方法加到原型上去,这样在每个组件中都能使用了,下面这篇文章主要给大家介绍了关于配置vue全局方法的两种方式,需要的朋友可以参考下...2021-09-13