springboot 2.x源码笔记- 配置文件加载 ConfigFileApplicationListener

springboot的源码(spring)主要分为几个部分

1、构造SpringApplication,完成spring.factories文件中Initializers与Listeners的加载
2、加载配置文件,通过ConfigFileApplicationListener
3、加载BeanDefinitionRegistryPostProcessor与BeanFactoryPostProcessor完成bean的定义包装(非生成实例)
4、生成bean实例以及初始化

本文主要针对第二点,主要看如何加载配置文件,即如何加载环境信息,主要通过ConfigFileApplicationListener完成

基于springboot2.1.4

项目地址:https://gitee.com/eshin/springbootdemo.git#autotest

org.springframework.boot.SpringApplication#run(java.lang.String...)-->org.springframework.boot.SpringApplication#prepareEnvironment

该方法主要看两部分

  • 1、系统环境信息配置初始化加载org.springframework.boot.SpringApplication#getOrCreateEnvironment

有图可以看出,在构造StandardServletEnvironment的时候,父类的构造器依次执行,构造后的StandardServletEnvironment就包含了如下的propertySource,主要是系统参数
  • 2、发布environmentPrepared事件,ConfigFileApplicationListener监听到后执行

environmentPrepared事件的发布,此处不做详述,可参考此处,其中监听到事件的Listener就有ConfigFileApplicationListener,其实现了EnvironmentPostProcessor接口和SmartApplicationListener接口。
因此在org.springframework.boot.context.config.ConfigFileApplicationListener#onApplicationEnvironmentPreparedEvent遍历执行EnvironmentPostProcessor的时候,就会执行到org.springframework.boot.context.config.ConfigFileApplicationListener#postProcessEnvironment,然后通过org.springframework.boot.context.config.ConfigFileApplicationListener#addPropertySources执行到org.springframework.boot.context.config.ConfigFileApplicationListener.Loader#load()


在上图中,this.propertySourceLoaders在spring.factories中配置,可自定义loader并配置。

  • initializeProfiles();中会根据系统参数设置activeProfiles,如果有设置的话,没有就只有default一个。可以在运行springboot项目的时候设置spring.profiles.active,或者spring.profiles.include。本文的前提是没有在系统参数中设置这两个变量,流程差不多,就是在this.profiles.poll()多走几个循环而已。
  • 进入org.springframework.boot.context.config.ConfigFileApplicationListener.Loader#load(Profile profile, DocumentFilterFactory filterFactory,DocumentConsumer consumer)
  • 进入org.springframework.boot.context.config.ConfigFileApplicationListener.Loader#loadForFileExtension->org.springframework.boot.context.config.ConfigFileApplicationListener.Loader#load(PropertySourceLoader loader, String location, Profile profile,DocumentFilter filter, DocumentConsumer consumer)


    图中中间位置

    其中List<Document> documents = loadDocuments(loader, name, resource);

    然后回到load方法中

最终通过loaded.forEach((document) -> consumer.accept(profile, document));将加载到的配置放入environment的properSourceList中


其中MutablePropertySources::addLast的方法引用方式比较少见,可参考此处

至此,整个environment的配置加载过程就完成了。

3、配置项的注入

配置项的注入是要等到bean的实例化后初始化阶段,参考这里.实例化后,会通过org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor#postProcessProperties-->org.springframework.beans.factory.annotation.InjectionMetadata#inject--->org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor.AutowiredMethodElement#inject--->org.springframework.beans.factory.support.DefaultListableBeanFactory#resolveDependency--->org.springframework.beans.factory.support.DefaultListableBeanFactory#doResolveDependency


--->org.springframework.beans.factory.support.AbstractBeanFactory#resolveEmbeddedValue然后进入org.springframework.context.support.PropertySourcesPlaceholderConfigurer#processProperties(org.springframework.beans.factory.config.ConfigurableListableBeanFactory, org.springframework.core.env.ConfigurablePropertyResolver)中已经定义的StringValueResolver
PropertySourcesPlaceholderConfigurer实现了BeanFactoryPostProcessor的postProcessBeanFactory接口方法,在bean的定义阶段就已经执行其实现的接口方法,将StringValueResolver添加到beanFactory的embeddedValueResolvers中
进入StringValueResolver--->org.springframework.core.env.AbstractPropertyResolver#resolveRequiredPlaceholders-->org.springframework.core.env.AbstractPropertyResolver#doResolvePlaceholders-->org.springframework.util.PropertyPlaceholderHelper#replacePlaceholders(java.lang.String, org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver)-->org.springframework.util.PropertyPlaceholderHelper#parseStringValue
--->org.springframework.core.env.PropertySourcesPropertyResolver#getPropertyAsRawString

总结:

  • 1、当系统启动参数中配置指定的目录spring.config.location,和文件名spring.config.name,则直接从读取改配置文件,否则使用默认路径,查找顺序为file:./config/,file:./,classpath:/config/,classpath:/,默认文件名为application。
  • 2、只要加载的配置文件中包含spring.profiles.active,且对应的文件没有加载过,那下次循环中就会继续加载对应的配置文件。
  • 3、每个实现org.springframework.boot.env.PropertySourceLoader的loader,都需要指定对应支持的拓展名。
  • 4、若有多个loader对相同拓展名的配置文件处理,优先级高的loader加载,后续的loader处理时略过。
  • 5、读取配置时从propertySourceList中按顺序查找,先放入list中的source中读到了配置,就不往后面查找,因此配置的生效顺序为:系统参数->file:./config/ -> file:./ -> classpath:/config/ -> classpath:/
    指定了profile的要比没有指定的优先。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,125评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,293评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,054评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,077评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,096评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,062评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,988评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,817评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,266评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,486评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,646评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,375评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,974评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,621评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,642评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,538评论 2 352