SpringBoot 配置文件加載和參數(shù)覆蓋

SpringBoot 或者SpringCloud 有配置文件加載和參數(shù)修改的機(jī)制，本文將從兩個(gè)角度闡述參數(shù)修改和配置文件啟動(dòng)覆蓋問題。

1、SpringBoot 配置文件加載

以下幾種方式都可以被@Value讀取到

1. java -jar -Dserver.port=8080 -Xms1024m demo.jar
2. java -jar demo.jar --server.port=8080
3. 從操作系統(tǒng)的環(huán)境變量中讀取
4. 通過項(xiàng)目中配置文件bootstrap/application文件載入

1.1、修改application.properties的參數(shù)幾種方式

1. 方法一：直接在cmd中執(zhí)行
2. 方法二：系統(tǒng)變量配置
3. 方法三：程序運(yùn)行配置
4. 方法四：外部加載

1.2、方法一：直接CMD

java -jar xxx.jar --server.port:8082
如果要修改多個(gè)參數(shù)，空格后繼續(xù)寫就可以了。再例如：java -jar xxx.jar --server.port:8082 --test.name=xxx

1.3、方法二：系統(tǒng)變量配置

1.4、方法三：程序運(yùn)行配置

1.5、方法四：外部加載

springboot 有讀取外部配置文件的方法，如下優(yōu)先級(jí)：

第一種是在jar包的同一目錄下建一個(gè)config文件夾，然后把配置文件放到這個(gè)文件夾下。
第二種是直接把配置文件放到j(luò)ar包的同級(jí)目錄。
第三種在classpath下建一個(gè)config文件夾，然后把配置文件放進(jìn)去。
第四種是在classpath下直接放配置文件。

我們通常在src/main/resources 文件夾下創(chuàng)建的application.properties 文件的優(yōu)先級(jí)是最低的！

1）內(nèi)外都有配置文件，配置文件讀取是有優(yōu)先級(jí),外配置文件優(yōu)于內(nèi)配置文件讀取。
2）如果內(nèi)配置文件里有外配置文件沒有的配置，那兩者互補(bǔ)。比如外配置文件沒有配置數(shù)據(jù)庫(kù)，內(nèi)配置文件里配置了數(shù)據(jù)庫(kù)，那內(nèi)配置文件的配置會(huì)被使用。
3）如果內(nèi)配置文件里和外配置文件里都有相同的配置，比如兩者都配置了數(shù)據(jù)庫(kù)，但是兩個(gè)連接的不同，那外配置文件會(huì)覆蓋內(nèi)配置文件里的配置。

2、SpringBoot 啟動(dòng)參數(shù)覆蓋

2.1、不指定profile的加載順序

首先，在默認(rèn)的情況下也就是不存在活動(dòng)的profile（即不指定spring.profiles.active=?）時(shí)，四種文件的加載優(yōu)先級(jí)依次為bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml。
總結(jié)：bootstrap的配置先于application的配置加載，同時(shí).properties的加載又先于.yml的加載，即加載優(yōu)先級(jí)bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml。

---

需要注意的是：

1. 當(dāng)同一個(gè)配置屬性在bootstrap.properties和bootstrap.yml文件中都存在時(shí)，那么properties中的配置會(huì)被加載，而忽略yml文件中的配置（即優(yōu)先級(jí)高的配置覆蓋優(yōu)先級(jí)低的配置），不同配置相互互補(bǔ)。此處application(.properties/yml)同理。
2. 但當(dāng)同一配置在bootstrap.properties和application.properties中都存在時(shí)，那么雖然優(yōu)先加載bootstrap.properties但是會(huì)被applicatioin.properties中的配置覆蓋，此時(shí)則變成了低優(yōu)先級(jí)覆蓋高優(yōu)先的配置，所以網(wǎng)上很多文章所說(shuō)的高優(yōu)先級(jí)覆蓋低優(yōu)先級(jí)其實(shí)是不嚴(yán)謹(jǐn)?shù)摹?/li>
3. 不同的配置會(huì)進(jìn)行互補(bǔ)操作，即SpringBoot會(huì)讀取全部的配置文件，加載所有不同的配置項(xiàng)，匯成一個(gè)總的配置。

2.2、指定profile的加載順序

例如在指定了spring.profiles.active=dev/test/prod此類時(shí)，即指定profile時(shí)，加載優(yōu)先級(jí)便會(huì)發(fā)生變化此時(shí)活動(dòng)的優(yōu)先級(jí)最高。

當(dāng)指定dev時(shí)：
此時(shí)的加載優(yōu)先級(jí)變?yōu)榱薭ootstrap-dev.yml -> bootstrap.properties -> application-dev.yml ->application.properties。且同屬性配置的覆蓋問題和之前一樣，在同為bootstrap或同為application的情況下，優(yōu)先級(jí)高的覆蓋優(yōu)先級(jí)低的。但當(dāng)同時(shí)存在bootstrap和application時(shí)后者仍會(huì)覆蓋前者中的配置。
**舉例1：**假如此時(shí)只有bootstrap-dev.yml 和bootstrap.properties且存在相同配置，則使用bootstrap-dev.yml中的配置，此時(shí)遵循高優(yōu)先級(jí)覆蓋低優(yōu)先級(jí)。
**舉例2：**假如此時(shí)有bootstrap-dev.yml 、bootstrap.properties及application.properties且存在相同配置，則使用application.properties中的配置，遵循application覆蓋bootstrap原則，同樣此時(shí)變成了低優(yōu)先級(jí)覆蓋高優(yōu)先級(jí)。

3、使用外部配置

如項(xiàng)目使用nacos做配置中心，則存在相同配置時(shí)以nacos中配置為主（在沒有開啟本地覆蓋nacos遠(yuǎn)程配置的情況下），nacos中的配置將會(huì)覆蓋一切本地相同的配置，不同配置可以和本地進(jìn)行互補(bǔ)。

3.1、擴(kuò)展nacos開啟本地覆蓋遠(yuǎn)程配置

如果需要啟動(dòng)參數(shù)或者本地配置覆蓋遠(yuǎn)程配置，那么需要在遠(yuǎn)程配置里配置上允許重寫：
spring.cloud.config.allowOverride=true
但這是不夠的，盡管它開啟了總開關(guān)，但是還有兩個(gè)默認(rèn)的小開關(guān)卡住了。
應(yīng)同時(shí)添加如下配置：
spring.cloud.config.overrideNone=true
spring.cloud.config.overrideSystemProperties=false
第一個(gè)開關(guān)是遠(yuǎn)端不覆蓋本地？true 是的不覆蓋。
第二個(gè)開關(guān)是遠(yuǎn)端是否覆蓋系統(tǒng)配置？false 不覆蓋。 （默認(rèn)為true 覆蓋）
請(qǐng)注意,第一個(gè)小開關(guān)包括第二個(gè)。
overrideNone = true的話會(huì)開啟所有包括本地配置和系統(tǒng)配置并忽略掉overrideSystemProperties配置。
如果只想開啟overrideSystemProperties，那么就是overrideNone = false，overrideSystemProperties=false。

外部參考

1. springBoot項(xiàng)目配置文件加載優(yōu)先級(jí)及同配置覆蓋問題
2. springboot 啟動(dòng)修改application.properties中的參數(shù)的方法