快捷導(dǎo)航

SpringBoot源碼剖析之屬性文件加載原理

更新時(shí)間：2022年02月08日 15:10:20 作者：波波烤鴨

這篇文章主要給大家介紹了關(guān)于SpringBoot源碼剖析之屬性文件加載原理的相關(guān)資料,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

前言

首先我們來(lái)看一個(gè)問(wèn)題。就是我們?cè)趧?chuàng)建SpringBoot項(xiàng)目的時(shí)候會(huì)在對(duì)應(yīng)的application.properties或者application.yml文件中添加對(duì)應(yīng)的屬性信息，我們的問(wèn)題是這些屬性文件是什么時(shí)候被加載的？如果要實(shí)現(xiàn)自定義的屬性文件怎么來(lái)實(shí)現(xiàn)呢？本文來(lái)給大家揭曉答案：

1.找到入口

結(jié)合我們前面介紹的SpringBoot中的監(jiān)聽(tīng)事件機(jī)制，我們首先看下SpringApplication.run()方法，在該方法中會(huì)針對(duì)SpringBoot項(xiàng)目啟動(dòng)的不同的階段來(lái)發(fā)布對(duì)應(yīng)的事件。

處理屬性文件加載解析的監(jiān)聽(tīng)器是 ConfigFileApplicationListener ,這個(gè)監(jiān)聽(tīng)器監(jiān)聽(tīng)的事件有兩個(gè)。

而我們進(jìn)入SpringApplication.prepareEnvironment()方法中發(fā)布的事件其實(shí)就是ApplicationEnvironmentPreparedEvent事件。進(jìn)入代碼查看。

進(jìn)行進(jìn)入

繼續(xù)進(jìn)入會(huì)看到對(duì)應(yīng)的發(fā)布事件：ApplicationEnvironmentPreparedEvent

結(jié)合上篇文件的內(nèi)容，我們知道在initialMulticaster中是有ConfigFileApplicationListener這個(gè)監(jiān)聽(tīng)器的。

那么在此處觸發(fā)了配置環(huán)境的監(jiān)聽(tīng)器，后續(xù)的邏輯就應(yīng)該進(jìn)入對(duì)應(yīng)的

2.ConfigFileApplicationListener

2.1 主要流程分析

接下來(lái)我們看下ConfigFileApplicationListener中具體的如何來(lái)處理配置文件的加載解析的。

根據(jù)邏輯我們直接進(jìn)入onApplicationEnvironmentPreparedEvent()方法中。

系統(tǒng)提供那4個(gè)不是重點(diǎn)，重點(diǎn)是 ConfigFileApplicationListener 中的這個(gè)方法處理.

直接進(jìn)入ConfigFileApplicationListener.postProcessEnvironment()方法。

在進(jìn)入addPropertySources()方法中會(huì)完成兩個(gè)核心操作，1。創(chuàng)建Loader對(duì)象，2。調(diào)用Loader對(duì)象的load方法，

2.2 Loader構(gòu)造器

現(xiàn)在我們來(lái)看下在Loader構(gòu)造器中執(zhí)行了什么操作。

通過(guò)源碼我們可以發(fā)現(xiàn)在其中獲取到了屬性文件的加載器、從spring.factories文件中獲取，對(duì)應(yīng)的類(lèi)型是 PropertySourceLoader類(lèi)型。

而且在loadFactories方法中會(huì)完成對(duì)象的實(shí)例化。

到這Loader的構(gòu)造方法執(zhí)行完成了，然后來(lái)看下load()方法的執(zhí)行。先把代碼貼上

void load() {
			FilteredPropertySource.apply(this.environment, DEFAULT_PROPERTIES, LOAD_FILTERED_PROPERTY,
					(defaultProperties) -> {
						// 創(chuàng)建默認(rèn)的profile 鏈表
						this.profiles = new LinkedList<>();
						// 創(chuàng)建已經(jīng)處理過(guò)的profile 類(lèi)別
						this.processedProfiles = new LinkedList<>();
						// 默認(rèn)設(shè)置為未激活
						this.activatedProfiles = false;
						// 創(chuàng)建loaded對(duì)象
						this.loaded = new LinkedHashMap<>();
						// 加載配置 profile 的信息，默認(rèn)為 default
						initializeProfiles();
						// 遍歷 Profiles，并加載解析
						while (!this.profiles.isEmpty()) {
							// 從雙向鏈表中獲取一個(gè)profile對(duì)象
							Profile profile = this.profiles.poll();
							// 非默認(rèn)的就加入，進(jìn)去看源碼即可清楚
							if (isDefaultProfile(profile)) {
								addProfileToEnvironment(profile.getName());
							}
							load(profile, this::getPositiveProfileFilter,
									addToLoaded(MutablePropertySources::addLast, false));
							this.processedProfiles.add(profile);
						}
						// 解析 profile
						load(null, this::getNegativeProfileFilter, addToLoaded(MutablePropertySources::addFirst, true));
						// 加載默認(rèn)的屬性文件 application.properties
						addLoadedPropertySources();
						applyActiveProfiles(defaultProperties);
					});
		}

然后我們進(jìn)入具體的apply()方法中來(lái)查看。

中間的代碼都有注釋?zhuān)饕翘幚韕rofile的內(nèi)容。

首先是getSearchLocations()方法，在該方法中會(huì)查詢(xún)默認(rèn)的會(huì)存放對(duì)應(yīng)的配置文件的位置，如果沒(méi)有自定義的話(huà)，路徑就是 file:./config/ file:./ classpath:/config/ classpath:/ 這4個(gè)