Spring Boot 2.4.0.M2 剛剛發布，它對 application.properties 和 application.yml 檔案的加載方式進行重構，如果應用程式僅使用單個 application.properties 或 application.yml 作為組態檔，那么可能感受不到任何區別，但是如果您的應用程式使用更復雜的配置（例如，Spring Cloud 配置中心等），則需要來了解更改的內容以及原因，
為什么要進行這些更改
隨著最新版本 Spring Boot 發布，Spring 一直在努力提升對 Kubernetes 的原生支持，在 Spring Boot 2.3 中，官方增加 Kubernetes Volume 的配置支持，但是未能實作，
Volume 配置掛載是 Kubernetes 的一項常用功能，其中 ConfigMap 指令用于直接在檔案系統上顯示配置，您可以裝載包含多個鍵和值合并的完整 YAML 檔案，也可以使用更簡單的目錄樹格式，其中檔案名是鍵，檔案內容是值，
希望同時提供兩者的支持，并且能夠兼容我們現有的 application.properties 和 application.yml ，為此需要修改 ConfigFileApplicationListener 類，
ConfigFileApplicationListener 問題
在 Spring Boot 中組態檔加載類 ConfigFileApplicationListener 屬于比較核心的底層代碼，每次維護都是非常的困難，并不是因為代碼撰寫錯誤或者缺少相關單元測驗，而是在添加新功能時，很難解決之前存在的問題，
即：
- 組態檔非常靈活，可以在當前檔案啟用其他組態檔，
- 檔案加載順序不固定，
以下面的例子來說：
security.user.password: usera
---
spring.profiles: local
security.user.password: userb
runlocal: true
---
spring.profiles: !dev
spring.profiles.include: local
security.user.password: userc
在這里，我們有一個 多檔案 YAML檔案（一個檔案由三個邏輯檔案組成，由 --- 分隔），
如果使用 --spring.profile.actives=prod 運行，那么 security.user.password 的值是什么？是否設定 runlocal 屬性？中間部分檔案是否包括在內，因為組態檔在處理時沒有激活？
我們經常會遇到關于這個檔案處理邏輯的問題，但是每當試圖修復它們時，最后帶來各種各樣的負面問題，
因此，在 Spring boot 2.4 中對 Properties 和 YAML 檔案的加載方式進行兩個重大更改：
- 檔案將按定義的順序加載，
- profiles 激活開關不能被配置在特定環境中，
檔案排序
從 Spring Boot 2.4 開始，加載 Properties 和 YAML 檔案時候會遵循， 在檔案中宣告排序靠前的屬性將被靠后的屬性覆寫 ，
這點與 .properties 的排序規則相同，我們可以想一想，每次將一個 Value 放入 Map ，具有相同 key 的新值放入時，將替換已經存在的 Value，
同理對 Multi-document 的 YAML 檔案，較低的排序也將被較高的覆寫：
test: "value"
---
test: "overridden-value"
Properties 檔案支持多檔案屬性
在 Spring Boot 2.4 中， Properties 支持類似 YAML 多檔案功能，多檔案屬性檔案使用注釋（ # ）后跟三個（---）破折號來分隔檔案（ 選擇使用注釋，以使現有的 IDE 正常支持 ），
例如，上面的 YAML 等效的 properties 為：
test=value
#---
test=overridden-value
特定環境激活配置
上述示例實際上沒有任何意義,在我們開發程序中更為常見是宣告某個屬性僅在特定環境生效激活，
在 Spring Boot 2.3 中可以配置 spring.profiles 來實作，但在 Spring Boot 2.4 中 屬性更改 為 spring.config.activate.on-profile ，
例如，我們想要 test 屬性僅僅在 dev Profile 激活時覆寫它，則可以使用以下配置：
test=value
#---
spring.config.activate.on-profile=dev
test=overridden-value
Profile Activation
使用 spring.profiles.active 屬性在 application.properties 或 application.yaml 檔案的 根組態檔 來激 相關環境檔案，
例如，下面這樣：
test=value
spring.profiles.active=local
#---
spring.config.activate.on-profile=dev
test=overridden value
不允許的是將 spring.profiles.active 屬性與 spring.config.activate.on-profile 一起使用，例如，以下檔案將引發例外：
test=value
#---
spring.config.activate.on-profile=dev
spring.profiles.active=local # will fail
test=overridden value
通過這一新限制能使 application.properties 和 application.yml 檔案更加容易理解，使得 Spring Boot 本身更易于管理和維護，
Profile Groups
Profile Groups 是 Spring Boot 2.4 中的一項新功能，可讓您將單個組態檔擴展為多個子組態檔，例如，假設有一組復雜的 @Configuration 類，可以使用 @Profile 注釋有條件地啟用它們，使用 @Profile("proddb") 開啟資料庫配置，使用 @Profile("prodmq") 開啟訊息配置等等，
使用多個組態檔可以使我們的代碼更易于理解，但是對于部署而言并不是理想的選擇，若用戶需要同時激活 proddb ， prodmq ， prodmetrics 等，那么 Profile Groups 可讓您做到這一點，
您可以在 application.properties 或 application.yml 檔案中定義 spring.profiles.group，那么開啟 prod 則就相當于激活了此組的全部環境 ，例如：
spring.profiles.group.prod=proddb,prodmq,prodmetrics
Importing 擴展 Configuration
現在，我們已經解決了組態檔處理的基本問題，我們終于能夠考慮我們想要提供的新功能，我們使用 Spring Boot 2.4 提供的主要功能是支持匯入其他配置，
對于早期版本的 Spring Boot，很難在 application.properties 和 application.yml 之外匯入其他 properties 或 yaml 檔案，可以使用 spring.config.additional-location 屬性但它可以處理的檔案型別非常有限，
在 Spring Boot 2.4 可以直接在 application.properties 或 application.yml 檔案中使用新的 spring.config.import 屬性，例如希望匯入一個 "忽略的 git" 的 developer.properties 檔案，以便團隊中的任何開發人員都可以快速更改屬性：
application.name=myapp
spring.config.import=developer.properties
甚至可以將 spring.config.import 與 spring.config.activate.on-profile 結合起來使用，例如，這里 prod.properties 僅在 prod 組態檔處于激活狀態時加載：
spring.config.activate.on-profile=prod
spring.config.import=prod.properties
Import 可以被視為在宣告它們的檔案下方插入的其他檔案，它們 遵循與常規多檔案檔案相同的自上而下的順序：匯入僅被匯入一次，無論宣告了多少次，
volume 掛載配置
匯入定義使用與 URL 一樣語法作為其值，如果您的位置沒有前綴，則它被視為常規檔案或檔案夾，但是，如果您使用 configtree: 前綴，則告訴 Spring Boot，您將期望在該位置使用 Kubernetes volume 裝載的配置樹，
例如，您可以在 application.properties 配置:
spring.config.import=configtree:/etc/config
如果您有以下裝載的內容：
etc/
+- config/
+- my/
| +- application
+- test
將在 Spring Environment 中擁有 my.application 和 test 屬性， my.application 的值是 /etc/config/my/application 的內容， test 的值是 /etc/config/test 的內容，
根據云平臺型別激活
如果只希望 Volume 掛載的配置（或該內容的任何屬性）在特 定的云平臺上 處于激活狀態，可以使用 spring.config.activate.on-cloud-platform 屬性，它的作業方式與 spring.config.activate.on-profile 類似，但它使用 CloudPlatform 的值，而不是組態檔名稱，
如果我們想要在部署到 Kubernetes 時啟用上述配置樹，我們可以執行以下操作：
spring.config.activate.on-cloud-platform=kubernetes
spring.config.import=configtree:/etc/config
支持其他位置
spring.config.import 屬性中指定的位置字串是完全可插拔的，可以通過撰寫幾個自定義類來擴展，第三方庫將對自定義位置提供支持，例如，你能想到的第三方 jar 檔案，例如 archaius://… ， vault://… 或 zookeeper://… ，
如果您有興趣添加其他位置支持，請查看 org.springframework.boot.context.config 包 ConfigDataLocationResolver 和 ConfigDataLoader 的 javadoc，
版本回滾
正如上文所描述的，Spring Boot 針對組態檔的功能變更是非常大的，考慮到低版本的兼容性
可以設定 spring.config.use-legacy-processing=true 屬性即可，恢復到之前版本的檔案處理機制，
如果發現關于此處的問題，則需要切換到舊版處理，請 在 GitHub 上提出問題，官方將嘗試解決該問題，
總結
官方希望新的配置資料處理更加好用，并且不會引起太多升級麻煩，如果您想了解更多有關它們的資訊，可以查閱更新的 參考檔案，
歡迎關注我，后續會通過代碼來詳細說明此處變更，
翻譯： 冷冷、如夢技術
原文鏈接：https://spring.io/blog/2020/08/14/config-file-processing-in-spring-boot-2-4
專案推薦: Spring Cloud 、Spring Security OAuth2的RBAC權限管理系統 歡迎關注
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/61823.html
標籤：Java