翻譯： 冷冷、如夢(mèng)技術(shù)

原文鏈接：spring.io/blog/2020/0…

Spring Boot 2.4.0.M2 剛剛發(fā)布，它對(duì) application.properties 和 application.yml 文件的加載方式進(jìn)行重構(gòu)。如果應(yīng)用程序僅使用單個(gè) application.properties 或 application.yml 作為配置文件，那么可能感受不到任何區(qū)別。但是如果您的應(yīng)用程序使用更復(fù)雜的配置(例如，Spring Cloud 配置中心等)，則需要來(lái)了解更改的內(nèi)容以及原因。

為什么要進(jìn)行這些更改

隨著最新版本 Spring Boot 發(fā)布，Spring 一直在努力提升對(duì) Kubernetes 的原生支持。在 Spring Boot 2.3 中，官方增加 Kubernetes Volume 的配置支持，但是未能實(shí)現(xiàn)。

Volume 配置掛載是 Kubernetes 的一項(xiàng)常用功能，其中 ConfigMap 指令用于直接在文件系統(tǒng)上顯示配置。您可以裝載包含多個(gè)鍵和值合并的完整 YAML 文件，也可以使用更簡(jiǎn)單的目錄樹(shù)格式，其中文件名是鍵，文件內(nèi)容是值。

希望同時(shí)提供兩者的支持，并且能夠兼容我們現(xiàn)有的 application.properties 和 application.yml 。為此需要修改 ConfigFileApplicationListener 類。

ConfigFileApplicationListener 問(wèn)題

在 Spring Boot 中配置文件加載類 ConfigFileApplicationListener 屬于比較核心的底層代碼，每次維護(hù)都是非常的困難。并不是因?yàn)榇a編寫(xiě)錯(cuò)誤或者缺少相關(guān)單元測(cè)試，而是在添加新功能時(shí)，很難解決之前存在的問(wèn)題。

即：

• 配置文件非常靈活，可以在當(dāng)前文件啟用其他配置文件。
• 文檔加載順序不固定。

以下面的例子來(lái)說(shuō)：

security.user.password: usera---spring.profiles: localsecurity.user.password: userbrunlocal: true---spring.profiles: !devspring.profiles.include: localsecurity.user.password: userc

在這里，我們有一個(gè) 多文檔 YAML文件(一個(gè)文件由三個(gè)邏輯文檔組成，由 --- 分隔)。

如果使用 --spring.profile.actives=prod 運(yùn)行，那么 security.user.password 的值是什么？是否設(shè)置 runlocal 屬性？中間部分文檔是否包括在內(nèi)，因?yàn)榕渲梦募谔幚頃r(shí)沒(méi)有激活？

我們經(jīng)常會(huì)遇到關(guān)于這個(gè)文件處理邏輯的問(wèn)題，但是每當(dāng)試圖修復(fù)它們時(shí)，最后帶來(lái)各種各樣的負(fù)面問(wèn)題。

因此，在 Spring boot 2.4 中對(duì) Properties 和 YAML 文件的加載方式進(jìn)行兩個(gè)重大更改：

文檔將按定義的順序加載。

profiles 激活開(kāi)關(guān)不能被配置在特定環(huán)境中。

文檔排序

從 Spring Boot 2.4 開(kāi)始，加載 Properties 和 YAML 文件時(shí)候會(huì)遵循， 在文檔中聲明排序靠前的屬性將被靠后的屬性覆蓋 。

這點(diǎn)與 .properties 的排序規(guī)則相同。我們可以想一想，每次將一個(gè) Value 放入 Map ，具有相同 key 的新值放入時(shí)，將替換已經(jīng)存在的 Value。

同理對(duì) Multi-document 的 YAML 文件，較低的排序也將被較高的覆蓋：

test: "value"---test: "overridden-value"

Properties 文件支持多文檔屬性

在 Spring Boot 2.4 中， Properties 支持類似 YAML 多文檔功能。多文檔屬性文件使用注釋( # )后跟三個(gè)(---)破折號(hào)來(lái)分隔文檔( 選擇使用注釋，以使現(xiàn)有的 IDE 正常支持 )。

例如，上面的 YAML 等效的 properties 為：

test=value#---test=overridden-value

特定環(huán)境激活配置

上述示例實(shí)際上沒(méi)有任何意義,在我們開(kāi)發(fā)過(guò)程中更為常見(jiàn)是聲明某個(gè)屬性僅在特定環(huán)境生效激活。

在 Spring Boot 2.3 中可以配置 spring.profiles 來(lái)實(shí)現(xiàn)。但在 Spring Boot 2.4 中 屬性更改 為 spring.config.activate.on-profile 。

例如，我們想要 test 屬性僅僅在 dev Profile 激活時(shí)覆蓋它，則可以使用以下配置：

test=value#---spring.config.activate.on-profile=devtest=overridden-value

Profile Activation

使用 spring.profiles.active 屬性在 application.properties 或 application.yaml 文件的 根配置文件 來(lái)激 相關(guān)環(huán)境文件。

例如，下面這樣：

test=valuespring.profiles.active=local#---spring.config.activate.on-profile=devtest=overridden value

不允許的是將 spring.profiles.active 屬性與 spring.config.activate.on-profile 一起使用。例如，以下文件將引發(fā)異常：

test=value#---spring.config.activate.on-profile=devspring.profiles.active=local # will failtest=overridden value

通過(guò)這一新限制能使 application.properties 和 application.yml 文件更加容易理解。使得 Spring Boot 本身更易于管理和維護(hù)。

Profile Groups

Profile Groups 是 Spring Boot 2.4 中的一項(xiàng)新功能，可讓您將單個(gè)配置文件擴(kuò)展為多個(gè)子配置文件。例如，假設(shè)有一組復(fù)雜的 @Configuration 類，可以使用 @Profile 注釋有條件地啟用它們。使用 @Profile("proddb") 開(kāi)啟數(shù)據(jù)庫(kù)配置，使用 @Profile("prodmq") 開(kāi)啟消息配置等等。

使用多個(gè)配置文件可以使我們的代碼更易于理解，但是對(duì)于部署而言并不是理想的選擇。若用戶需要同時(shí)激活 proddb ， prodmq ， prodmetrics 等。那么 Profile Groups 可讓您做到這一點(diǎn)。

您可以在 application.properties 或 application.yml 文件中定義 spring.profiles.group，那么開(kāi)啟 prod 則就相當(dāng)于激活了此組的全部環(huán)境 。例如：

spring.profiles.group.prod=proddb,prodmq,prodmetrics

Importing 擴(kuò)展 Configuration

現(xiàn)在，我們已經(jīng)解決了配置文件處理的基本問(wèn)題，我們終于能夠考慮我們想要提供的新功能。我們使用 Spring Boot 2.4 提供的主要功能是支持導(dǎo)入其他配置。

對(duì)于早期版本的 Spring Boot，很難在 application.properties 和 application.yml 之外導(dǎo)入其他 properties 或 yaml 文件。可以使用 spring.config.additional-location 屬性但它可以處理的文件類型非常有限。

在 Spring Boot 2.4 可以直接在 application.properties 或 application.yml 文件中使用新的 spring.config.import 屬性。例如希望導(dǎo)入一個(gè) "忽略的 git" 的 developer.properties 文件，以便團(tuán)隊(duì)中的任何開(kāi)發(fā)人員都可以快速更改屬性：

application.name=myappspring.config.import=developer.properties

甚至可以將 spring.config.import 與 spring.config.activate.on-profile 結(jié)合起來(lái)使用。例如，這里 prod.properties 僅在 prod 配置文件處于激活狀態(tài)時(shí)加載：

spring.config.activate.on-profile=prodspring.config.import=prod.properties

Import 可以被視為在聲明它們的文檔下方插入的其他文檔。它們 遵循與常規(guī)多文檔文件相同的自上而下的順序：導(dǎo)入僅被導(dǎo)入一次，無(wú)論聲明了多少次。

volume 掛載配置

導(dǎo)入定義使用與 URL 一樣語(yǔ)法作為其值。如果您的位置沒(méi)有前綴，則它被視為常規(guī)文件或文件夾。但是，如果您使用 configtree: 前綴，則告訴 Spring Boot，您將期望在該位置使用 Kubernetes volume 裝載的配置樹(shù)。

例如，您可以在 application.properties 配置:

spring.config.import=configtree:/etc/config

如果您有以下裝載的內(nèi)容：

etc/ +- config/ +- my/ | +- application +- test

將在 Spring Environment 中擁有 my.application 和 test 屬性。 my.application 的值是 /etc/config/my/application 的內(nèi)容， test 的值是 /etc/config/test 的內(nèi)容。

根據(jù)云平臺(tái)類型激活

如果只希望 Volume 掛載的配置(或該內(nèi)容的任何屬性)在特 定的云平臺(tái)上 處于激活狀態(tài)，可以使用 spring.config.activate.on-cloud-platform 屬性。它的工作方式與 spring.config.activate.on-profile 類似，但它使用 CloudPlatform 的值，而不是配置文件名稱。

如果我們想要在部署到 Kubernetes 時(shí)啟用上述配置樹(shù)，我們可以執(zhí)行以下操作：

spring.config.activate.on-cloud-platform=kubernetesspring.config.import=configtree:/etc/config

支持其他位置

spring.config.import 屬性中指定的位置字符串是完全可插拔的，可以通過(guò)編寫(xiě)幾個(gè)自定義類來(lái)擴(kuò)展，第三方庫(kù)將對(duì)自定義位置提供支持。例如，你能想到的第三方 jar 文件，例如 archaius://… ， vault://… 或 zookeeper://… 。

如果您有興趣添加其他位置支持，請(qǐng)查看 org.springframework.boot.context.config 包 ConfigDataLocationResolver 和 ConfigDataLoader 的 javadoc。

版本回滾

正如上文所描述的，Spring Boot 針對(duì)配置文件的功能變更是非常大的。考慮到低版本的兼容性

可以設(shè)置 spring.config.use-legacy-processing=true 屬性即可，恢復(fù)到之前版本的文件處理機(jī)制。

如果發(fā)現(xiàn)關(guān)于此處的問(wèn)題，則需要切換到舊版處理，請(qǐng) 在 GitHub 上提出問(wèn)題，官方將嘗試解決該問(wèn)題。

總結(jié)

官方希望新的配置數(shù)據(jù)處理更加好用，并且不會(huì)引起太多升級(jí)麻煩。如果您想了解更多有關(guān)它們的信息，可以查閱更新的 參考文檔。

總結(jié)

以上是生活随笔為你收集整理的异常信息配置文件已被另一个程序更改_抢先目睹：SpringBoot2.4配置文件加载机制大变化的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。