一处坪,加載自定義配置文件
springboot啟動(dòng)時(shí)會(huì)默認(rèn)加載application.properties和application.yml以及application-{profile}.properties和application-{profile}.yml
profile為對(duì)應(yīng)的環(huán)境變量,比如dev,所以一般的資源文件結(jié)構(gòu)如下:
如果配置內(nèi)容太多的話践叠,就會(huì)顯得很不方便楞慈,解決方案一般會(huì)分成多個(gè)不同的配置文件,期望加載application.yml后既穆,會(huì)加載對(duì)應(yīng)profile文件夾下的所有配置文件讶隐。
分多個(gè)配置文件的接口如下:
所以下面開始工作吧(大概思路是起胰,利用EnvironmentPostProcessor接口,讀取自定義文件夾巫延,把內(nèi)容加載到environment里去)
1效五,新建實(shí)現(xiàn)實(shí)現(xiàn)EnvironmentPostProcessor的類O2oClientEnvironmentPostProcessor
2,利用PathMatchingResourcePatternResolver加載多個(gè)文件
3炉峰,PropertySourceLoader讀取相應(yīng)的配置文件畏妖,這里的location可以自己定義,本文為classpath:{profile}/client-*.fileExtension,如果profile為dev,PropertySourceLoader為YamlPropertySourceLoader的話疼阔,則為classpath:dev/client-*.yml戒劫,就會(huì)加載dev文件夾下以client-開頭的所有yml文件。
4婆廊,添加進(jìn)environment迅细。
內(nèi)容如下:
類寫好了,下面讓它起作用淘邻,在META-INF/spring.factories下面配置
org.springframework.boot.env.EnvironmentPostProcessor=com.mama100.o2o.client.config.O2oClientEnvironmentPostProcessor
然后就OK了茵典,可以直接注入自定義文件的屬性。
二宾舅,官網(wǎng)的說(shuō)明
官網(wǎng)文檔關(guān)于EnvironmentPostProcessor的說(shuō)明统阿,舉例是加載單個(gè)文件的,點(diǎn)擊進(jìn)入spring官方文檔筹我。懶得點(diǎn)的話扶平,我把內(nèi)容也復(fù)制進(jìn)這里了。
三崎溃,原理
下面我們看看springboot啟動(dòng)的時(shí)候蜻直,在哪執(zhí)行我們的代碼的。(本來(lái)以為有專門代碼格式的,結(jié)果沒有概而,文字版沒法看呼巷,那就截圖吧)
1,入口函數(shù)不多說(shuō)
2,大概就會(huì)new一個(gè)SpringApplication的實(shí)例來(lái)run赎瑰。
3,new實(shí)例時(shí)會(huì)查找所有jar包里面META-INF/spring.factories配置的org.springframework.context.ApplicationListener王悍,并設(shè)到實(shí)例的屬性listeners中。
4餐曼,再來(lái)看看run压储,這里就是主流程了,這方法有個(gè)局部變量listeners源譬,不要和SpringApplication的屬性listeners搞混集惋。關(guān)注淺藍(lán)色陰影背景部分。
4.1踩娘,先看看這個(gè)局部Listeners的來(lái)源刮刑,也是從META-INF/spring.factories下面查找,發(fā)現(xiàn)有
# Run Listeners
org.springframework.boot.SpringApplicationRunListener=\
org.springframework.boot.context.event.EventPublishingRunListener
然后會(huì)把EventPublishingRunListener實(shí)例化养渴,可以看到,getSpringFactoriesInstances方法里的入?yún)rgs里面添加了this雷绢,就是把SpringApplication傳遞給EventPublishingRunListener,這樣實(shí)例化的時(shí)候可以獲取SpringApplication的屬性listeners理卑,最后封裝成SpringApplicationRunListeners返回翘紊,屬性listeners只有EventPublishingRunListener的實(shí)例。
4.2藐唠,EventPublishingRunListener實(shí)例化的時(shí)候帆疟,把之前SpringApplication的屬性listeners逐一添加到initialMulticaster,當(dāng)然也包括org.springframework.boot.context.config.ConfigFileApplicationListener
5宇立,回到第4步的再來(lái)看看run鸯匹,繼續(xù)往下走
5.1現(xiàn)在看看準(zhǔn)備環(huán)境,傳遞了局部的listeners泄伪,最終是調(diào)用了EventPublishingRunListener的environmentPrepared方法(參考4.1,循環(huán)里的屬性listeners只有EventPublishingRunListener的實(shí)例)匿级。
5.2EventPublishingRunListener通過initialMulticaster發(fā)布事件ApplicationEnvironmentPreparedEvent
5.3initialMulticaster發(fā)布事件,getApplicationListeners就能獲取到之前SpringApplication的屬性listeners(參考4.2EventPublishingRunListener實(shí)例化的時(shí)候蟋滴,把之前SpringApplication的屬性listeners逐一添加到initialMulticaster,當(dāng)然也包括org.springframework.boot.context.config.ConfigFileApplicationListener)
5.4痘绎,最終會(huì)調(diào)用listener.onApplicationEvent(event)津函,其中也就是會(huì)調(diào)用ConfigFileApplicationListener中的onApplicationEvent方法,當(dāng)然孤页,這里還會(huì)調(diào)用到其它Listener中的onApplicationEvent方法尔苦。
5.5,再來(lái)看看ConfigFileApplicationListener中的監(jiān)聽代碼,事件類型是ApplicationEnvironmentPreparedEvent(參考5.2EventPublishingRunListener通過initialMulticaster發(fā)布事件ApplicationEnvironmentPreparedEvent)
看loadPostProcessors()允坚,這里會(huì)查找META-INF/spring.factories下org.springframework.boot.env.EnvironmentPostProcessor的類魂那,其中就包括了我們的類O2oClientEnvironmentPostProcessor
然后就會(huì)調(diào)用我們的O2oClientEnvironmentPostProcessor的postProcessEnvironment方法了,
ConfigFileApplicationListener也是EnvironmentPostProcessor類稠项,這里有加載默認(rèn)配置文件的代碼涯雅,O2oClientEnvironmentPostProcessor也是參考這個(gè)類寫出來(lái)的,具體信息請(qǐng)讀者自己研究展运。
到這里活逆,我們的代碼就已經(jīng)成功執(zhí)行了。后面的就不分析了拗胜≌岷颍總結(jié)一下,springboot啟動(dòng)的時(shí)候會(huì)初始化一系列l(wèi)isteners埂软,并發(fā)布不同階段的事件锈遥,其中ConfigFileApplicationListener會(huì)監(jiān)聽ApplicationEnvironmentPreparedEvent,在處理這個(gè)事件中仰美,會(huì)查找META-INF/spring.factories下org.springframework.boot.env.EnvironmentPostProcessor的所有類迷殿,并執(zhí)行其中的postProcessEnvironment方法。