Spring Boot中application配置文件的生效順序

Spring Boot的一個(gè)重要特性就是它的自動(dòng)配置，這一特性在很大程度上依賴于名稱為application的配置文件。本文將詳細(xì)介紹在Spring Boot中，這些配置文件的加載順序以及每份文件的應(yīng)用范圍。

配置文件的種類

在Spring Boot中，我們主要使用兩種類型的配置文件：

• application.properties
• application.yml

這兩種文件都用于定義項(xiàng)目的配置參數(shù)，只是書(shū)寫格式不同。其中，application.properties采用“鍵=值”的格式，而application.yml采用了YAML（YAML Ain’t Markup Language）語(yǔ)言的格式，設(shè)置更為清晰和明了。

配置文件的加載順序

當(dāng)項(xiàng)目啟動(dòng)時(shí)，Spring Boot會(huì)按照一定的順序去加載這些配置文件。以下是這些配置文件的默認(rèn)加載順序：

• 在當(dāng)前目錄下的/config子目錄的application配置文件
• 在當(dāng)前目錄下的application配置文件
• 在類路徑（classpath）下的/config子目錄的application配置文件
• 在類路徑（classpath）下的application配置文件

其中，列表中序號(hào)越小的配置文件優(yōu)先級(jí)越高。也就是說(shuō)，如果在不同的application配置文件中定義了相同的屬性，那么，優(yōu)先級(jí)更高的配置文件中定義的值會(huì)覆蓋優(yōu)先級(jí)較低的配置文件中定義的值。

配置文件的環(huán)境切換

除了主要的application配置文件之外，我們還可以為每個(gè)環(huán)境提供專門的配置文件。這些環(huán)境特定的配置文件的名稱格式為application-{profile}.properties或application-{profile}.yml，其中的{profile}表示特定的環(huán)境。例如，我們可以為開(kāi)發(fā)環(huán)境定義一個(gè)application-dev.properties文件，為生產(chǎn)環(huán)境定義一個(gè)application-prod.properties文件。

與普通的配置文件一樣，環(huán)境特定的配置文件也有一定的加載順序，但它們的加載時(shí)機(jī)是在對(duì)應(yīng)的application配置文件加載之后。也就是說(shuō)，如果環(huán)境特定的配置文件中定義了與application配置文件相同的屬性，那么環(huán)境特定的配置文件中的值將會(huì)覆蓋application配置文件中的值。

參考資源：

1. Config file processing in Spring Boot 2.4
2. Order of Configuration in SpringBoot
3. Spring Boot Externalized Configuration

擴(kuò)展：

SpringBoot配置文件application.yml及加載順序

配置文件分類

1. SpringBoot中4級(jí)配置文件

• 1級(jí)(工程路徑config目錄配置文件)：file：config/application.yml [最高]
• 2級(jí)(工程路徑目錄配置文件)：file:application.yml
• 3級(jí)(項(xiàng)目類路徑config目錄配置文件)：classpath:config/application.yml
• 4級(jí)(項(xiàng)目類路徑目錄配置文件)：classpath:application.yml [最低]

2. 作用：

• 1級(jí)與2級(jí)留做系統(tǒng)打包后設(shè)置通用屬性，1級(jí)常用于運(yùn)維經(jīng)理進(jìn)行線上整體項(xiàng)目部署方案調(diào)控，2級(jí)服務(wù)于運(yùn)維人員配置涉密線上環(huán)境
• 3級(jí)和4級(jí)用于系統(tǒng)開(kāi)發(fā)階段設(shè)置通用屬性，3級(jí)常用于項(xiàng)目經(jīng)理進(jìn)行整體項(xiàng)目屬性調(diào)控，4級(jí)服務(wù)于開(kāi)發(fā)人員本機(jī)開(kāi)發(fā)與測(cè)試

3. 注意：

多層級(jí)配置文件間的屬性采用疊加并覆蓋的形式作用于程序。

自定義配置文件

\1. 配置文件可以修改名稱，通過(guò)啟動(dòng)參數(shù)設(shè)定

\2. 配置文件可以修改路徑，通過(guò)啟動(dòng)參數(shù)設(shè)定

3.微服務(wù)開(kāi)發(fā)中配置文件通過(guò)配置中心進(jìn)行設(shè)置

配置文件總結(jié)

\1. SpringBoot在開(kāi)發(fā)和運(yùn)行環(huán)境均支持使用臨時(shí)參數(shù)修改工程配置

\2. SpringBoot支持4級(jí)配置文件，應(yīng)用于開(kāi)發(fā)與線上環(huán)境進(jìn)行配置的靈活設(shè)置

\3. SpringBoot支持使用自定義配置文件的形式修改配置文件存儲(chǔ)位置

4.基于微服務(wù)開(kāi)發(fā)時(shí)配置文件將使用配置中心進(jìn)行管理

Springboot中application.yml、application.properties和bootStrap.yml加載順序

SpringApplication位于項(xiàng)目根目錄

所以所有得代碼要和SpringApplication所在目錄平級(jí)或下一級(jí)

以jar包發(fā)布springboot項(xiàng)目時(shí)

默認(rèn)會(huì)先使用jar包跟目錄下的application.properties來(lái)作為項(xiàng)目配置文件。

如果在不同的目錄中存在多個(gè)配置文件，它的讀取順序是：

• 1、config/application.properties（項(xiàng)目根目錄中config目錄下）
• 2、config/application.yml
• 3、application.properties（項(xiàng)目根目錄下）
• 4、application.yml
• 5、resources/config/application.properties（項(xiàng)目resources目錄中config目錄下）
• 6、resources/config/application.yml
• 7、resources/application.properties（項(xiàng)目的resources目錄下）
• 8、resources/application.yml

**注： **

1、如果同一個(gè)目錄下，有application.yml也有application.properties，默認(rèn)先讀取application.properties。

2、如果同一個(gè)配置屬性，在多個(gè)配置文件都配置了，默認(rèn)使用第1個(gè)讀取到的，后面讀取的不覆蓋前面讀取到的。

3、創(chuàng)建SpringBoot項(xiàng)目時(shí)，一般的配置文件放置在“項(xiàng)目的resources目錄下”

4、先后加載順序：若application 和bootstrap 在同一目錄下：bootstrap先加載 application后加載

若application.yml 和bootStrap.yml 在同目錄下

則bootStrap.yml 的加載順序要于application.yml,即bootStrap.yml 會(huì)優(yōu)先被加載。

原理：

bootstrap.yml 于應(yīng)程序上下的引導(dǎo)階段。

bootstrap.yml 由Spring ApplicationContext加載。

• bootstrap.yml 可以理解成系統(tǒng)級(jí)別的?些參數(shù)配置，這些參數(shù)?般是不會(huì)變動(dòng)的。
• application.yml 可以?來(lái)定義應(yīng)?級(jí)別的，如果搭配 spring-cloud-config 使用 application.yml 定義的文件可以實(shí)現(xiàn)動(dòng)態(tài)替換。

到此這篇關(guān)于Spring Boot中application配置文件的生效順序的文章就介紹到這了,更多相關(guān)Spring Boot application配置文件內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論