2. SpringCloud Alibaba Nacos 之 服務配置中心

SpringCloud Alibaba系列文章清單

0. SpringCloud Alibaba入門簡介

1. SpringCloud Alibaba Nacos 之 服務注冊中心

2. SpringCloud Alibaba Nacos 之 服務配置中心

3. SpringCloud Alibaba Nacos 之 叢集

4. SpringCloud Alibaba Sentinel 服務限流熔斷（萬字長文）

文章目錄

• • • **SpringCloud Alibaba系列文章清單**
    • 1. Spring Cloud Alibaba Nacos Config
    • 2. 基礎配置
    • • 2.1 Data Id 配置規則
      • 2.2 nacos增加配置
    • 3. 分類配置
    • • 3.1 思考兩個問題
      • 3.2 概念
      • • 3.2.1 namespace （ 命名空間 ）
        • 3.2.2 Group （配置分組）
        • 3.2.2 Data Id （配置集 ID）
      • 3.3 項目實戰
      • • 3.3.1 Data Id 方案
        • 3.3.2 Group 方案
        • 3.3.2 NameSpace 方案

前言

官方文檔：

https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config

1. Spring Cloud Alibaba Nacos Config

Nacos 提供用于存儲配置和其他中繼資料的 key/value 存儲，為分布式系統中的外部化配置提供伺服器端和用戶端支援。使用 Spring Cloud Alibaba Nacos Config，您可以在 Nacos Server 集中管理你 Spring Cloud 應用的外部屬性配置。

Spring Cloud Alibaba Nacos Config 是 Config Server 和 Client 的替代方案，用戶端和伺服器上的概念與 Spring Environment 和 PropertySource 有着一緻的抽象，在特殊的 bootstrap 階段，配置被加載到 Spring 環境中。當應用程式通過部署管道從開發到測試再到生産時，您可以管理這些環境之間的配置，并確定應用程式具有遷移時需要運作的所有内容。

2. 基礎配置

2.1 Data Id 配置規則

參考官網 https://nacos.io/zh-cn/docs/quick-start-spring-cloud.html

在 Nacos Spring Cloud 中，

dataId

的完整格式如下：

${prefix}-${spring.profiles.active}.${file-extension}
           

• prefix

  預設為

  spring.application.name

  的值，也可以通過配置項

  spring.cloud.nacos.config.prefix

  來配置。

• spring.profiles.active

  即為目前環境對應的 profile，詳情可以參考 Spring Boot文檔。 注意：當

  spring.profiles.active

  為空時，對應的連接配接符

  -

  也将不存在，dataId 的拼接格式變成

  ${prefix}.${file-extension}

• file-exetension

  為配置内容的資料格式，可以通過配置項

  spring.cloud.nacos.config.file-extension

  來配置。目前隻支援

  properties

  和

  yaml

  類型。

具體配置如下圖所示：

dataid 為 nacos-config-client-dev.yaml

另外，通過 Spring Cloud 原生注解

@RefreshScope

實作配置自動更新；

2.2 nacos增加配置

點選+添加， 本文以YAML格式為例

按照規則填寫Data ID，

Group目前用預設的，後面會介紹。

配置格式選擇YAML，

配置内容得是YAML格式，空格沒有控制好的話會讀取不到配置資訊。建議在IDEA裡面編輯好後，複制回來。

點選釋出即可；

2.3 代碼實戰

建立項目cloudalibaba-config-nacos-client3377

• pom.xml

  <!--nacos-config-->
  <dependency>
      <groupId>com.alibaba.cloud</groupId>
      <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
  </dependency>
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-actuator</artifactId>
  </dependency>
             

• application.yml

  spring:
    profiles:
      active: dev
             

• bootstrap.yml

  Nacos同springcloud-config一樣，在項目初始化時，要保證先從配置中心進行配置拉取，拉取配置之後，才能保證項目的正常啟動。

  springboot中配置檔案的加載是存在優先級順序的,bootstrap優先級高于application

  server:
    port: 3377
  
  spring:
    application:
      name: nacos-config-client
    cloud:
      nacos:
        config:
          server-addr: localhost:8848 #配置中心位址
          file-extension: yaml #指定yaml格式的配置
             

• 業務類 web接口

  @RestController
  @RefreshScope //自動重新整理
  public class ConfigClientController {
      
      @Value("${config.info}")
      private String configInfo;
  
      /**
       * 讀取 配置的 config.info内容
       * @return
       */
      @GetMapping("/config/info")
      public String getConfigInfo() {
          return configInfo;
      }
  
  }
             

• 啟動類

  無額外注解

• 測試

  啟動項目cloudalibaba-config-nacos-client3377，

  浏覽器通路 http://localhost:3377/config/info

  結果通路成功

  

  nacos中編輯配置檔案内容 version=2，再次通路接口

  自動重新整理成功。非常牛皮，比springcloud config友善多了

  

3. 分類配置

3.1 思考兩個問題

• 實際開發中，通常一個系統會準備dev開發環境、test測試環境、prod生産環境。如何保證指定環境啟動時服務能正确讀取到Nacos上相應環境的配置檔案呢?
• 一個大型分布式微服務系統會有很多微服務子項目，每個微服務項目又都會有相應的開發環境、測試環境、預發環境、正式環境…那怎麼對這些微服務配置進行管理呢?

3.2 概念

官網 https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config

3.2.1 namespace （ 命名空間 ）

用于進行租戶粒度的配置隔離。不同的命名空間下，可以存在相同的 Group 或 Data ID 的配置。Namespace 的常用場景之一是不同環境的配置的區分隔離，例如開發測試環境和生産環境的資源（如配置、服務）隔離等。

在沒有明确指定

${spring.cloud.nacos.config.namespace}

配置的情況下， 預設使用的是 Nacos 上 Public 這個namespae。如果需要使用自定義的命名空間，可以通過以下配置來實作：

spring.cloud.nacos.config.namespace=b3404bc0-d7dc-4855-b519-570ed34b62d7
           

Note	該配置必須放在 bootstrap.properties 檔案中。此外 spring.cloud.nacos.config.namespace 的值是 namespace 對應的 id，id 值可以在 Nacos 的控制台擷取。并且在添加配置時注意不要選擇其他的 namespae，否則将會導緻讀取不到正确的配置。

3.2.2 Group （配置分組）

Nacos 中的一組配置集，是組織配置的次元之一。通過一個有意義的字元串（如 Buy 或 Trade ）對配置集進行分組，進而區分 Data ID 相同的配置集。當您在 Nacos 上建立一個配置時，如果未填寫配置分組的名稱，則配置分組的名稱預設采用 DEFAULT_GROUP 。配置分組的常見場景：不同的應用或元件使用了相同的配置類型，如 database_url 配置和 MQ_topic 配置。

在沒有明确指定

${spring.cloud.nacos.config.group}

配置的情況下， 預設使用的是 DEFAULT_GROUP 。如果需要自定義自己的 Group，可以通過以下配置來實作：

spring.cloud.nacos.config.group=DEVELOP_GROUP
           

Note	該配置必須放在 bootstrap.properties 檔案中。并且在添加配置時 Group 的值一定要和 spring.cloud.nacos.config.group 的配置值一緻。

3.2.2 Data Id （配置集 ID）

Nacos 中的某個配置集的 ID。配置集 ID 是組織劃配置設定置的次元之一。Data ID 通常用于組織劃分系統的配置集。一個系統或者應用可以包含多個配置集，每個配置集都可以被一個有意義的名稱辨別。Data ID 通常采用類 Java 包（如 com.taobao.tc.refund.log.level）的命名規則保證全局唯一性。此命名規則非強制。

Spring Cloud Alibaba Nacos Config 從 0.2.1 版本後，可支援自定義 Data Id 的配置。

具體配置看官網 https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config#%E6%94%AF%E6%8C%81%E8%87%AA%E5%AE%9A%E4%B9%89%E6%89%A9%E5%B1%95%E7%9A%84-data-id-%E9%85%8D%E7%BD%AE

3.3 項目實戰

3.3.1 Data Id 方案

• 預設命名空間+預設分組+建立dev和test兩個Data Id

  借助克隆功能；克隆成功後修改内容；

  

• 項目中通過spring.profiles.active屬性進行多環境下配置檔案的讀取

  spring:
    profiles:
      #active: dev
      active: test
             

重新開機項目，浏覽器通路 http://localhost:3377/config/info

3.3.2 Group 方案

• 預設命名空間，相同的Data ID，新增一個Group

• 項目中配置

• 測試

  重新開機項目，浏覽器通路 http://localhost:3377/config/info

  

得到的是GG_GROUP下的配置檔案；

3.3.2 NameSpace 方案

• 建立命名空間+相同的Group+相同的DataID

克隆配置，或者上方切換到dev命名空間後新增

添加成功後，修改内容

• 項目中配置namespace的id

• 測試

  重新開機項目，浏覽器通路 http://localhost:3377/config/info

  

可見namespace > Group > DataID

點贊+評論+關注

本文源碼位址： https://gitee.com/shuaidawang/SpringCloudDemo.git

有錯誤的地方歡迎指正！可以加入qq交流群： 700637673