Spring Cloud Alibaba基礎教程:Nacos配置的多環境管理

程式猿DD發表於2019-01-31

前情回顧:

通過之前兩篇對Nacos配置管理功能的介紹,已經學會了在Nacos中如何加入配置以及Spring Cloud應用如何通過配置來載入到對應的內容。接下來,我們討論一個在使用配置中心時,都需要關注的一個問題:多環境的配置如何實現與管理?

多環境管理

在Nacos中,本身有多個不同管理級別的概念,包括:Data IDGroupNamespace。只要利用好這些層級概念的關係,就可以根據自己的需要來實現多環境的管理。

下面,我就來介紹一下,可以使用的幾種實現方式:

使用Data IDprofiles實現

Data ID在Nacos中,我們可以理解為就是一個Spring Cloud應用的配置檔名。通過上一篇《Spring Cloud Alibaba基礎教程:Nacos配置的載入規則詳解》,我們知道預設情況下Data ID的名稱格式是這樣的:${spring.application.name}.properties,即:以Spring Cloud應用命名的properties檔案。

實際上,Data ID的規則中,還包含了環境邏輯,這一點與Spring Cloud Config的設計類似。我們在應用啟動時,可以通過spring.profiles.active來指定具體的環境名稱,此時客戶端就會把要獲取配置的Data ID組織為:${spring.application.name}-${spring.profiles.active}.properties

實際上,更原始且最通用的匹配規則,是這樣的:${spring.cloud.nacos.config.prefix}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}。而上面的結果是因為${spring.cloud.nacos.config.prefix}${spring.cloud.nacos.config.file-extension}都使用了預設值。

動手試一試

我們可以用《Spring Cloud Alibaba基礎教程:使用Nacos作為配置中心》一文中的列子(可在文末倉庫中獲取)為基礎,體驗一下這種區分環境的配置方式。

第一步:先在Nacos中,根據這個規則,建立兩個不同環境的配置內容。比如:

Spring Cloud Alibaba基礎教程:Nacos配置的多環境管理

如上圖,我們為alibaba-nacos-config-client應用,定義了DEV和TEST的兩個獨立的環境配置。我們可以在裡面定義不同的內容值,以便後續驗證是否真實載入到了正確的配置。

第二步:在alibaba-nacos-config-client應用的配置檔案中,增加環境配置:spring.profiles.active=DEV

第三步:啟動應用,我們可以看到日誌中列印了,載入的配置檔案:

2019-01-30 15:25:18.216  INFO 96958 --- [           main] o.s.c.a.n.c.NacosPropertySourceBuilder   : Loading nacos data, dataId: 'alibaba-nacos-config-client-DEV.properties', group: 'DEFAULT_GROUP'

使用Group實現

Group在Nacos中是用來對Data ID做集合管理的重要概念。所以,如果我們把一個環境的配置視為一個集合,那麼也就可以實現不同環境的配置管理。對於Group的用法並沒有固定的規定,所以我們在實際使用的時候,需要根據我們的具體需求,可以是架構運維上對多環境的管理,也可以是業務上對不同模組的引數管理。為了避免衝突,我們需要在架構設計之初,做好一定的規劃。這裡,我們先來說說如何用Group來實現多環境配置管理的具體實現方式。

動手試一試

第一步:先在Nacos中,通過區分Group來建立兩個不同環境的配置內容。比如:

Spring Cloud Alibaba基礎教程:Nacos配置的多環境管理

如上圖,我們為alibaba-nacos-config-client應用,定義了DEV環境和TEST環境的兩個獨立的配置,這兩個匹配與上一種方法不同,它們的Data ID是完全相同的,只是GROUP不同。

第二步:在alibaba-nacos-config-client應用的配置檔案中,增加Group的指定配置:spring.cloud.nacos.config.group=DEV_GROUP

第三步:啟動應用,我們可以看到日誌中列印了,載入的配置檔案:

2019-01-30 15:55:23.718  INFO 3216 --- [main] o.s.c.a.n.c.NacosPropertySourceBuilder   : Loading nacos data, dataId: 'alibaba-nacos-config-client.properties', group: 'DEV_GROUP'

使用Namespace實現

Namespace在本系列教程中,應該還是第一次出現。先來看看官方的概念說明:用於進行租戶粒度的配置隔離。不同的名稱空間下,可以存在相同的GroupData ID的配置。Namespace的常用場景之一是不同環境的配置的區分隔離,例如:開發測試環境和生產環境的資源(如配置、服務)隔離等。

在官方的介紹中,就介紹了利用其可以作為環境的隔離使用,下面我們就來試一下吧!

動手試一試

第一步:先在Nacos中,根據環境名稱來建立多個Namespace。比如:

Spring Cloud Alibaba基礎教程:Nacos配置的多環境管理

第二步:在配置列表的最上方,可以看到除了Public之外,多了幾個剛才建立的Namepsace。分別在DEVTEST空間下為alibaba-nacos-config-client應用建立配置內容:

Spring Cloud Alibaba基礎教程:Nacos配置的多環境管理

第三步:在alibaba-nacos-config-client應用的配置檔案中,增加Namespace的指定配置,比如:spring.cloud.nacos.config.namespace=83eed625-d166-4619-b923-93df2088883a

這裡需要注意namespace的配置不是使用名稱,而是使用Namespace的ID。

第四步:啟動應用,通過訪問localhost:8001/test介面,驗證一下返回內容是否正確。這種方式下,目前版本的日誌並不會輸出與Namespace相關的資訊,所以還無法以此作為載入內容的判斷依據。

深入思考

上面我們分別利用Nacos配置管理功能中的幾個不同緯度來實現多環境的配置管理。從結果上而言,不論用哪一種方式,都能夠勝任需求,但是哪一種最好呢?

第一種:通過Data IDprofile實現。

  • 優點:這種方式與Spring Cloud Config的實現非常像,用過Spring Cloud Config的使用者,可以毫無違和感的過渡過來,由於命名規則類似,所以要從Spring Cloud Config中做遷移也非常簡單。
  • 缺點:這種方式在專案與環境多的時候,配置內容就會顯得非常混亂。配置列表中會看到各種不同應用,不同環境的配置交織在一起,非常不利於管理。
  • 建議:專案不多時使用,或者可以結合Group對專案根據業務或者組織架構做一些拆分規劃。

第二種:通過Group實現。

  • 優點:通過Group按環境講各個應用的配置隔離開。可以非常方便的利用Data IDGroup的搜尋功能,分別從應用緯度和環境緯度來檢視配置。
  • 缺點:由於會佔用Group緯度,所以需要對Group的使用做好規劃,畢竟與業務上的一些配置分組起衝突等問題。
  • 建議:這種方式雖然結構上比上一種更好一些,但是依然可能會有一些混亂,主要是在Group的管理上要做好規劃和控制。

第三種:通過Namespace實現。

  • 優點:官方建議的方式,通過Namespace來區分不同的環境,釋放了Group的自由度,這樣可以讓Group的使用專注於做業務層面的分組管理。同時,Nacos控制頁面上對於Namespace也做了分組展示,不需要搜尋,就可以隔離開不同的環境配置,非常易用。
  • 缺點:沒有啥缺點,可能就是多引入一個概念,需要使用者去理解吧。
  • 建議:直接用這種方式長遠上來說會比較省心。雖然可能對小團隊而言,專案不多,第一第二方式也夠了,但是萬一後面做大了呢?

注意:不論用哪一種方式實現。對於指定環境的配置(spring.profiles.active=DEVspring.cloud.nacos.config.group=DEV_GROUPspring.cloud.nacos.config.namespace=83eed625-d166-4619-b923-93df2088883a),都不要配置在應用的bootstrap.properties中。而是在釋出指令碼的啟動命令中,用-Dspring.profiles.active=DEV的方式來動態指定,會更加靈活!。

參考資料

程式碼示例

本文示例讀者可以通過檢視下面倉庫的中的alibaba-nacos-config-client專案:

如果您對這些感興趣,歡迎star、follow、收藏、轉發給予支援!

以下專題教程也許您會有興趣

相關文章