springboot批量加载自定义配置文件

一,加载自定义配置文件

springboot启动时会默认加载application.properties和application.yml以及application-{profile}.properties和application-{profile}.yml

profile为对应的环境变量,比如dev,所以一般的资源文件结构如下:


如果配置内容太多的话,就会显得很不方便,解决方案一般会分成多个不同的配置文件,期望加载application.yml后,会加载对应profile文件夹下的所有配置文件。

分多个配置文件的接口如下:


所以下面开始工作吧(大概思路是,利用EnvironmentPostProcessor接口,读取自定义文件夹,把内容加载到environment里去)

1,新建实现实现EnvironmentPostProcessor的类O2oClientEnvironmentPostProcessor

2,利用PathMatchingResourcePatternResolver加载多个文件

3,PropertySourceLoader读取相应的配置文件,这里的location可以自己定义,本文为classpath:{profile}/client-*.fileExtension,如果profile为dev,PropertySourceLoader为YamlPropertySourceLoader的话,则为classpath:dev/client-*.yml,就会加载dev文件夹下以client-开头的所有yml文件。

4,添加进environment。

内容如下:


类写好了,下面让它起作用,在META-INF/spring.factories下面配置

org.springframework.boot.env.EnvironmentPostProcessor=com.mama100.o2o.client.config.O2oClientEnvironmentPostProcessor

然后就OK了,可以直接注入自定义文件的属性。

二,官网的说明

官网文档关于EnvironmentPostProcessor的说明,举例是加载单个文件的,点击进入spring官方文档。懒得点的话,我把内容也复制进这里了。


三,原理

下面我们看看springboot启动的时候,在哪执行我们的代码的。(本来以为有专门代码格式的,结果没有,文字版没法看,那就截图吧)

1,入口函数不多说


2,大概就会new一个SpringApplication的实例来run。

3,new实例时会查找所有jar包里面META-INF/spring.factories配置的org.springframework.context.ApplicationListener,并设到实例的属性listeners中。

4,再来看看run,这里就是主流程了,这方法有个局部变量listeners,不要和SpringApplication的属性listeners搞混。关注浅蓝色阴影背景部分。

4.1,先看看这个局部Listeners的来源,也是从META-INF/spring.factories下面查找,发现有
# Run Listeners
org.springframework.boot.SpringApplicationRunListener=\
org.springframework.boot.context.event.EventPublishingRunListener

然后会把EventPublishingRunListener实例化,可以看到,getSpringFactoriesInstances方法里的入参args里面添加了this,就是把SpringApplication传递给EventPublishingRunListener,这样实例化的时候可以获取SpringApplication的属性listeners,最后封装成SpringApplicationRunListeners返回,属性listeners只有EventPublishingRunListener的实例。

4.2,EventPublishingRunListener实例化的时候,把之前SpringApplication的属性listeners逐一添加到initialMulticaster,当然也包括org.springframework.boot.context.config.ConfigFileApplicationListener

5,回到第4步的再来看看run,继续往下走

5.1现在看看准备环境,传递了局部的listeners,最终是调用了EventPublishingRunListener的environmentPrepared方法(参考4.1,循环里的属性listeners只有EventPublishingRunListener的实例)。

5.2EventPublishingRunListener通过initialMulticaster发布事件ApplicationEnvironmentPreparedEvent

5.3initialMulticaster发布事件,getApplicationListeners就能获取到之前SpringApplication的属性listeners(参考4.2EventPublishingRunListener实例化的时候,把之前SpringApplication的属性listeners逐一添加到initialMulticaster,当然也包括org.springframework.boot.context.config.ConfigFileApplicationListener)

5.4,最终会调用listener.onApplicationEvent(event),其中也就是会调用ConfigFileApplicationListener中的onApplicationEvent方法,当然,这里还会调用到其它Listener中的onApplicationEvent方法。

5.5,再来看看ConfigFileApplicationListener中的监听代码,事件类型是ApplicationEnvironmentPreparedEvent(参考5.2EventPublishingRunListener通过initialMulticaster发布事件ApplicationEnvironmentPreparedEvent)

看loadPostProcessors(),这里会查找META-INF/spring.factories下org.springframework.boot.env.EnvironmentPostProcessor的类,其中就包括了我们的类O2oClientEnvironmentPostProcessor

然后就会调用我们的O2oClientEnvironmentPostProcessor的postProcessEnvironment方法了,

ConfigFileApplicationListener也是EnvironmentPostProcessor类,这里有加载默认配置文件的代码,O2oClientEnvironmentPostProcessor也是参考这个类写出来的,具体信息请读者自己研究。


到这里,我们的代码就已经成功执行了。后面的就不分析了。总结一下,springboot启动的时候会初始化一系列listeners,并发布不同阶段的事件,其中ConfigFileApplicationListener会监听ApplicationEnvironmentPreparedEvent,在处理这个事件中,会查找META-INF/spring.factories下org.springframework.boot.env.EnvironmentPostProcessor的所有类,并执行其中的postProcessEnvironment方法。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,757评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,478评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,540评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,593评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,903评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,329评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,659评论 2 309
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,383评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,055评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,337评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,864评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,227评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,820评论 3 231
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,999评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,750评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,365评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,260评论 2 258

推荐阅读更多精彩内容