开发者社区> 分享达人> 正文

springboot源码分析14-ApplicationContextInitializer原理Springboot中PropertySource注解多环境支持以及原理

简介: 摘要:Springboot中PropertySource注解的使用一文中,详细讲解了PropertySource注解的使用,通过PropertySource注解去加载指定的资源文件、然后将加载的属性注入到指定的配置类,@value以及@ConfigurationProperties的使用。
+关注继续查看

摘要:Springboot中PropertySource注解的使用一文中,详细讲解了PropertySource注解的使用,通过PropertySource注解去加载指定的资源文件、然后将加载的属性注入到指定的配置类,@value以及@ConfigurationProperties的使用。但是也遗留一个问题,PropertySource注解貌似是不支持多种环境的动态切换?这个问题该如何解决呢?我们需要从源码中看看他到底是否支持。

首先,我们开始回顾一下上节课说的PropertySource注解的使用,实例代码如下:

1 @PropertySource( name="jdbc-bainuo-dev.properties",

2 value={"classpath:config/jdbc-bainuo-dev.properties"},ignoreResourceNotFound=false,encoding="UTF-8")

我们使用了PropertySource注解中的参数有:name、value、ignoreResourceNotFound、encoding。其实PropertySource注解还有一个参数,那就是factory,该参数默认的值为PropertySourceFactory.class。

PropertySource注解的定义如下:

1 public @interface PropertySource {

String name() default "";

String[] value();

boolean ignoreResourceNotFound() default false;

String encoding() default "";

Class<? extends PropertySourceFactory> factory() default PropertySourceFactory.class;

7 }

我们不妨先看一下PropertySourceFactory接口是做什么的?该接口的核心定义代码如下:

1 public interface PropertySourceFactory {

PropertySource<?> createPropertySource(@Nullable String name, EncodedResource resource) throws IOException;

3 }

上述代码中,PropertySourceFactory接口仅仅提供了一个createPropertySource方法,该方法就是创建PropertySource实例对象的,关于PropertySource的架构可以参考前面的系列文章进行学习,既然是接口,那肯定有实现类吧?该接口的默认实现类为DefaultPropertySourceFactory,代码如下:

1 public class DefaultPropertySourceFactory implements PropertySourceFactory {

public PropertySource<?> createPropertySource(@Nullable String name, EncodedResource resource) throws IOException {

return (name != null ? new ResourcePropertySource(name, resource) : new ResourcePropertySource(resource));

}

5 }

首先判断name参数值是否为空,如果不为空直接实例化ResourcePropertySource并将name参数值进行传递,否则直接实例化ResourcePropertySource。看到这个地方的处理,感觉也没什么神奇的地方,那么问题来了,我们思考如下三个问题:DefaultPropertySourceFactory 类什么时候被Spring框架调用呢?Name参数值是如何传递过来的呢?ResourcePropertySource实例化的时候做了什么呢?我们一个个的来看源码进行分析。

1.1. DefaultPropertySourceFactory 类什么时候被Spring框架调用呢

第一个问题:DefaultPropertySourceFactory 类什么时候被Spring框架调用呢?这个我们就需要看一下我们定义的PropertySource注解是如何被Spring框架解析的?经过我的一系列排查,我找到了。Spring框架开始解析PropertySource注解的方法位于ConfigurationClassParser类中,为了防止大量的跟踪源码跟踪丢失了,自己也糊涂了。我们直奔主题,看一下processPropertySource方法,如下所示:

1 private static final PropertySourceFactory DEFAULT_PROPERTY_SOURCE_FACTORY = new DefaultPropertySourceFactory();

2  private void processPropertySource(AnnotationAttributes propertySource) throws IOException {

String name = propertySource.getString("name");

if (!StringUtils.hasLength(name)) {

name = null;

}

String encoding = propertySource.getString("encoding");

if (!StringUtils.hasLength(encoding)) {

encoding = null;

10  }

11  String[] locations = propertySource.getStringArray("value");

12   boolean ignoreResourceNotFound = propertySource.getBoolean("ignoreResourceNotFound");

13  Class factoryClass = propertySource.getClass("factory");

14  PropertySourceFactory factory = (factoryClass == PropertySourceFactory.class ?

15  DEFAULT_PROPERTY_SOURCE_FACTORY : BeanUtils.instantiateClass(factoryClass));

16  for (String location : locations) {

17  try {

18  String resolvedLocation = this.environment.resolveRequiredPlaceholders(location);

19  Resource resource = this.resourceLoader.getResource(resolvedLocation);

20  addPropertySource(factory.createPropertySource(name, new EncodedResource(resource, encoding)));

21  }

22  catch (IllegalArgumentException ex) {

23  if (ignoreResourceNotFound) {

24  if (logger.isInfoEnabled()) {

25  logger.info("Properties location [" + location + "] not resolvable: " + ex.getMessage());

26  }

27  }

28      else {

29  throw ex;

30      }

31  }

32  catch (IOException ex) {

33  }

34   }

上述代码的逻辑分为如下几个核心的步骤:

1. 开始解析nameencoding值。

2. 解析value(数组)以及ignoreResourceNotFound值。

3. 解析factory,如果该值没有配置,默认为PropertySourceFactory则直接实例化DefaultPropertySourceFactory类,否则开始实例化自定义的类。换言之factory的处理类我们是可以进行自定义的。BeanUtils.instantiateClass是Spring中比较常用的一个工具类,其内部就是通过反射手段实例化类,在这里我们就不一一讲解了。

4. 循环遍历所有的location值,进行如下的处理。

     4.1.location进行SPEL表达式的解析。比如当前的配置环境中有一个属性为app=shareniu,我们配置的location${app}最终值为shareniu。通过这里的处理逻辑可以知道location支持多环境的切换以及表达式的配置。

     4.2.使用资源加载器resourceLoader将resolvedLocation抽象为Resource。

     4.3.调用addPropertySource属性进行处理。将指定的资源处理之后,添加到当前springboot运行的环境中,这个前面的章节也详细讲解过类似的,在这里就不详细说明了。注意:这里调用了DefaultPropertySourceFactory类中的createPropertySource方法了。

5.如果上述的任意步骤报错,则开始查找ignoreResourceNotFound的值,如果该值为treu,则忽略异常,否则直接报错。在这里我们可以看出ignoreResourceNotFound参数值的配置非常的重要。

1.2. ResourcePropertySource

我们看一下ResourcePropertySource类的构造函数,主要看一下没有name参数的构造函数,如下所示:

1 public ResourcePropertySource(EncodedResource resource) throws IOException {

super(getNameForResource(resource.getResource()),PropertiesLoaderUtils.loadProperties(resource));

this.resourceName = null;

4  }

上述代码,我们重点关注一下name值的生成逻辑。也就是getNameForResource中的处理逻辑,如下所示:

1 private static String getNameForResource(Resource resource) {

String name = resource.getDescription();

if (!StringUtils.hasText(name)) {

name = resource.getClass().getSimpleName() + "@" + System.identityHashCode(resource);

}

return name;

7  }

通过resource中的getDescription方法获取name值。如果name值为空,则重新生成,否则直接返回。大家又兴起可以看看resource中各个子类的定义以及使用。

PropertiesLoaderUtils.loadProperties(resource)毋庸置疑就是加载指定的属性文件了。

1.3. PropertySource多环境配置以及表达式使用

springboot中,可以通过设置spring.profiles.active属性,达到不同环境配置文件的动态切换。我们看一下这种方式如何使用,首先在application.properties增加如下的信息:

spring.profiles.active=dev

application.properties文件位置如下图所示:

 

然后,我们修改CustomerDataSourceConfig1类,这个类的配置以及启动类进行测试可以参考上一篇文章进行学习。

1 @PropertySource( name="jdbc-bainuo-dev.properties",value= {"classpath:config/jdbc-bainuo-$ {spring.profiles.active}.properties"},ignoreResourceNotFound=false,encoding="UTF-8")

2 public class CustomerDataSourceConfig1  {

3 }

这里注意value的值已经修改为了:"classpath:config/jdbc-bainuo-${spring.profiles.active}.properties"。

${spring.profiles.active}表达式可以动态的进行配置,从而达到动态切换不同的配置文件了。


欢迎关注我的微信公众号,第一时间获得博客更新提醒,以及更多成体系的Java相关原创技术干货。 
扫一扫下方二维码或者长按识别二维码,即可关注。
 


版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
java B2B2C Springboot电子商务平台源码-统一日志管理ELK
什么是ELK?ELK是三个开源软件的缩写,分别表示:Elasticsearch , Logstash, Kibana , 它们都是开源软件。新增了一个FileBeat,它是一个轻量级的日志收集处理工具(Agent),Filebeat占用资源少,适合于在各个服务器上搜集日志后传输给Logstash,官方也推荐此工具。
1065 0
SpringBoot运行源代码分析
SpringBoot运行源代码分析
27 0
SpringBoot自动装配原理解析
本文包含:SpringBoot的自动配置原理及如何自定义SpringBootStar等 我们知道,在使用SpringBoot的时候,我们只需要如下方式即可直接启动一个Web程序: @SpringBootApplication public class DemoApplication { p...
11348 0
SpringBoot源码解析之应用类型识别
SpringBoot源码解析之应用类型识别
40 0
@SpringBootApplication无法被解析引入
问题描述:@SpringBootApplication无法被解析引入,导致SpringBoot启动类报错 原因分析:springboot的包冲突了所致 解决方案: 需要删掉 repository\org\springframework\boot 目录下的spring-boot-autoconfig...
2894 0
SpringBoot-12-之Ajax跨域访问全解析
一.什么是跨域呢? 1.引入: 先讲个故事:从前一个叫8080的大佬和一个8081的大佬各占一方天地,还有一个叫浏览器的大佬和8080还有8081关系都不错。
1208 0
[Android]从Launcher开始启动App流程源码分析
以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/5017056.html 从Launcher开始启动App流程源码分析 com.
644 0
精通SpringBoot——第二篇:视图解析器,静态资源和区域配置
精通spring boot 之视图解析器,静态资源和区域配置,来看看SprinBoot这个幕后英雄为了我们干了什么,让我们开发如此轻松和快乐吧~~
12627 0
+关注
分享达人
开源爱好者,喜欢钻研新技术。Activiti权威指南一书作者。
131
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
JS零基础入门教程(上册)
立即下载
性能优化方法论
立即下载
手把手学习日志服务SLS,云启实验室实战指南
立即下载