Spring Boot 2.4版本前後的分組配置變化及對多環境配置結構的影響

程式猿DD發表於2020-12-21
Spring Boot

前幾天在《Spring Boot 2.4 對多環境配置的支援更改》一文中，給大家講解了Spring Boot 2.4版本對多環境配置的配置變化。除此之外，還有一些其他配置變化，所以今天我們就繼續講講其他的更新內容！

spring.profiles.include對於這個配置項，你是否熟悉呢？從字面意思也不難理解，應該就是用來引入一些其他配置的配置（因為有個include嘛），實際作用也確實如此！

當我們的應用有很多配置資訊的時候，比如當用到了很多中介軟體MySQL、Redis、MQ等，每個中介軟體的配置都是一大串的，那麼這個時候我們為了配置更簡潔一些，可能就會對其做分組。

如果你有用過這樣的配置方式，那麼在升級2.4版本的時候一定要注意，因為原來的配置方法會失效！

2.4之前的分組配置

先來看看2.4版本之前的分組配置，我們用下面這個例子來介紹：

spring:
  profiles:
    active: "dev"

---
spring.profiles: "dev"
spring.profiles.include: "dev-db,dev-mq"

---
spring.profiles: "dev-db"

db: dev-db.didispace.com

---
spring.profiles: "dev-mq"

mq: dev-mq.didispace.com

其中：

  1. 第一個spring.profiles.active: dev，代表預設啟用dev配置
  2. 第二段dev配置中使用了spring.profiles.include來引入其他配置資訊，這裡模擬一下一個是dev的db配置，一個是dev的mq配置。在2.3和之前版本的時候，我們通常就是這樣來分組配置不同中介軟體的。
spring.profiles: "dev"
spring.profiles.include: "dev-db,dev-mq"

文末我們提供一個樣例工程，你可以通過修改spring boot版本到2.3和配置資訊使用上面的樣例，來啟動應用看看這種配置效果。不出意外，你可以在啟動日誌開頭，看到啟用的配置資訊如下：

The following profiles are active: dev,dev-db,dev-mq

同時啟用了dev、dev-db、dev-mq三組配置，include是生效的。

2.4的分組配置

在升級spring boot到2.4之後，再啟動之前的應用，你會發現配置就沒有生效了，這裡不僅是因為spring.profiles失效的原因，即使我們將其都修改為spring.config.activate.on-profile，也依然無法啟用dev-db和dev-mq的配置。因為在2.4版本之後，我們需要使用spring.profiles.group來配置了，同時組織結構也發生了變化。

可以嘗試把配置修改成如下格式：

spring:
  profiles:
    active: "dev"
    group:
      "dev": "dev-db,dev-mq"
      "prod": "prod-db,prod-mq"

---
spring:
  config:
    activate:
      on-profile: "dev-db"

db: dev-db.didispace.com

---
spring:
  config:
    activate:
      on-profile: "dev-mq"

mq: dev-mq.didispace.com

---
spring:
  config:
    activate:
      on-profile: "prod-db"

db: prod-db.didispace.com

---
spring:
  config:
    activate:
      on-profile: "prod-mq"

mq: prod-mq.didispace.com

啟動應用可以在日誌開頭看到啟用的配置組（預設啟用的是dev，所以對應的就是dev-db和dev-mq）：

The following profiles are active: dev,dev-db,dev-mq

、修改spring.profiles.active: "prod"直接切換到另外一個環境。

重啟應用可以在日誌開頭看到啟用的配置組：

The following profiles are active: prod,prod-db,prod-mq

可以看到，在2.4版本的配置中，不同環境的配置定義都在第一段預設配置中了，所有的環境定義都轉移到了spring.profiles.group的key欄位（上面配置了dev和prod），value欄位則代表了每個環境需要載入的不同配置分組。

回憶一下我們在《Spring Boot 2.4 對多環境配置的支援更改》中提到的多環境配置，是不是不同環境的配置標識都集中定義在了每個spring.config.activate.on-profile裡。而這次分組的配置改變，讓啟用配置、環境配置集中到了預設配置裡，其他的profile定義是環境+配置分組的組合內容。

對於這樣的調整，最直觀的感受就是選擇環境的時候，我不需要往下找有哪些profile就能知道有哪些可選項了，還是方便不少。那麼你對這樣的配置調整怎麼看呢？歡迎留言討論！

程式碼示例

本文的相關例子可以檢視下面倉庫中的chapter1-3目錄：

如果您覺得本文不錯，歡迎Star支援，您的關注是我堅持的動力！

相關閱讀

歡迎關注我的公眾號：程式猿DD，獲得獨家整理的免費學習資源助力你的Java學習之路！另每週贈書不停哦～

相關文章