天天看點

spring cloud alibaba微服務原理與實戰_Spring Cloud Alibaba系列(二)nacos作為服務配置中心

spring cloud alibaba微服務原理與實戰_Spring Cloud Alibaba系列(二)nacos作為服務配置中心
Nacos 提供用于存儲配置和其他中繼資料的 key/value 存儲,為分布式系統中的外部化配置提供伺服器端和用戶端支援。使用 Spring Cloud Alibaba Nacos Config,您可以在 Nacos Server 集中管理你 Spring Cloud 應用的外部屬性配置。

首先我們來看一下,微服務架構下關于配置檔案的一些問題:

  1. 配置檔案相對分散,在一個微服務架構中,配置檔案會随着微服務的增多變得越來越多,而且分散在各個微服務中,不好統一管理和配置。
  2. 配置檔案無法區分環境,微服務項目可能會有多個環境,例如:開發環境、預釋出環境、生成環境。每個環境所使用的配置理論上都是不同的,一旦需要修改,就需要我們去各個微服務下手動維護,這比較困難。
  3. 配置檔案無法實時更新,我們修改好了配置檔案之後,必須重新啟動微服務才能使配置檔案生效,這對一個正在運作的項目來說是非常不友好的。

基于上面這些問題,我們就需要引入配置中心來解決。

建立一個config服務

  1. 建立一個config服務,在pom檔案中添加必要依賴
<parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.2.5.RELEASE</version>
      <relativePath/> <!-- lookup parent from repository -->
  </parent>
  <dependencyManagement>
    <dependencies>
      <!--Spring cloud Hoxton.SR3-->
      <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-dependencies</artifactId>
        <version>Hoxton.SR3</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
      <!--Spring cloud alibaba 2.1.0.RELEASE-->
      <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-alibaba-dependencies</artifactId>
        <version>2.2.1.RELEASE</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.alibaba.cloud</groupId>
      <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
  </dependencies>
           
  1. 在配置檔案指定config位址等資訊 注意:不能使用原來的application.yml作為配置檔案,而是建立一個bootstrap.yml作為配置檔案

配置檔案加載的優先級(由高到低)

bootstrap.properties ->bootstrap.yml -> application.properties -> application.yml

server:
  port: 9002
spring:
  profiles:
    active: dev
  application:
    name: nacos-config-server
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848 # 配置中心
        file-extension: yaml # 這裡指定的檔案格式需要和nacos上建立的配置檔案字尾相同,否則讀不到
           
  1. 在nacos用戶端配置管理建立一個配置
spring cloud alibaba微服務原理與實戰_Spring Cloud Alibaba系列(二)nacos作為服務配置中心
  • Data ID:預設為
    spring cloud alibaba微服務原理與實戰_Spring Cloud Alibaba系列(二)nacos作為服務配置中心
    {spring.profile.active}.
    spring cloud alibaba微服務原理與實戰_Spring Cloud Alibaba系列(二)nacos作為服務配置中心
    {spring.application.name}.${spring.cloud.nacos.config.file-extension}
  • Group:對應配置檔案中的${spring.cloud.nacos.config.group},預設為DEFAULT_GROUP
  • 配置格式:對應配置檔案中的${spring.cloud.nacos.config.file-extension},
  • 配置内容:根據你的配置格式按對應的格式填寫即可。
  1. 在config服務中擷取配置資訊
@SpringBootApplication
public class NacosConfigServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosConfigServerApplication.class, args);
    }
    @RestController
    class TestController {

        @Value("${config.info}")
        private String config;

        @GetMapping("/test")
        public String hello() {
            return config;
        }

    }
}
           

我們通過@Value注解可以擷取到配置中心的值。

@RefreshScope動态重新整理配置

在TestController上加個@RefreshScope注解,然後我們去nacos用戶端手動修改http://config.info的資訊,然後重新調用這個/test接口,會發現響應的是修改後的内容。

配置自定義的命名空間

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

在沒有明确指定命名空間配置的情況下, 預設使用的是 Nacos 上 Public 這個namespae。

首先我們在nacos用戶端建立一個命名空間,

spring cloud alibaba微服務原理與實戰_Spring Cloud Alibaba系列(二)nacos作為服務配置中心

然後我們在配置檔案中新增下面這個屬性,具體的值填寫我們新增命名空間的ID,這樣啟動config服務後,就會自動去這個命名空間下尋找對應的配置檔案了。

spring:
  cloud:
    nacos:
      config:
        namespace: 
           

多環境配置的三種方式

最開始的時候我們也說過微服務項目會有多個環境,我們如何實作和管理這些環境呢?

1.通過Data ID 和profiles實作

我們可以在配置檔案中指定spring.profiles.active = **,然後在nocas用戶端建立對應的

spring cloud alibaba微服務原理與實戰_Spring Cloud Alibaba系列(二)nacos作為服務配置中心

{spring.profiles.active}

.

${spring.cloud.nacos.config.file-extension}配置來區分不同的環境。

2.通過Group實作

我們可以為不同的環境建立不同的分組,然後的配置檔案中指定spring.cloud.nacos.config.group=組名,這樣也可以實作不同環境的區分。

3.通過Namespace實作

這種方式是官方建議的方式,在nacos用戶端中建立不同的分組,然後再配置檔案中指定namespace就可以區分不同的環境了。

自定義擴充的Data ID

大多數時候我們可能更加傾向于将不同的配置分開寫到不同的配置檔案中,比如我想把檔案類和日志類的配置拆分開寫到兩個配置中,nacos也是支援這種寫法的。

  1. 我們在nacos中建立兩個Data ID 分别是log.yaml 和 file.yaml 的檔案。

我們在配置檔案中分别加入以下内容:log:level: 2,file:url: "http://123.com"。

  1. 如何配置呢
spring:
  cloud:
    nacos:
      config:
        extension-configs[0]:
          data-id: log.yaml
          group: DEFAULT_GROUP   # 預設為DEFAULT_GROUP
          refresh: true   # 是否動态重新整理,預設為false
        extension-configs[1]:
          data-id: file.yaml
          group: DEFAULT_GROUP
          refresh: true
           

為了更加清晰的在多個應用間配置共享的 Data Id,官方推薦使用如下配置:

spring:
  cloud:
    nacos:
      config:
        shared-configs[0]:
          data-id: log.yaml
          group: DEFAULT_GROUP   # 預設為DEFAULT_GROUP
          refresh: true   # 是否動态重新整理,預設為false
        shared-configs[1]:
          data-id: file.yaml
          group: DEFAULT_GROUP
          refresh: true
           
  1. 深入思考,既然我們有兩個配置檔案,假如兩個配置檔案中出現一樣的key值,這樣我們程式中會加載哪個配置呢,其實nacos在設計的時候也考慮到了優先級問題,下面我們一起來看看。

我們将file.yaml中的配置改成log:level: 22。這時候我們加載寫個接口取一下配置。看看它取到的是哪個檔案的内容。

RestController
    @RefreshScope
    class TestController {
        
        @Value("${log.level}")
        private String log;

        @GetMapping("/test")
        public String hello() {
            return "log.lelve="+log;
        }

    }
           
spring cloud alibaba微服務原理與實戰_Spring Cloud Alibaba系列(二)nacos作為服務配置中心

結果取到的是file.yaml中的配置,這是因為

多個 Data Id 同時配置時,他的優先級關系是

spring.cloud.nacos.config.extension-configs[n].data-id

其中 n 的值越大,優先級越高。
注意:

spring.cloud.nacos.config.extension-configs[n].data-id

的值必須帶檔案擴充名,檔案擴充名既可支援 properties,又可以支援 yaml/yml。 此時

spring.cloud.nacos.config.file-extension

的配置對自定義擴充配置的 Data Id 檔案擴充名沒有影響。

擴充:不同方式配置加載優先級

Spring Cloud Alibaba Nacos Config 目前提供了三種配置能力從 Nacos 拉取相關的配置。

  • A: 通過

    spring.cloud.nacos.config.shared-configs[n].data-id

    支援多個共享 Data Id 的配置
  • B: 通過

    spring.cloud.nacos.config.extension-configs[n].data-id

    的方式支援多個擴充 Data Id 的配置
  • C: 通過内部相關規則(spring.cloud.nacos.config.prefix

    spring.cloud.nacos.config.file-extension

    spring.cloud.nacos.config.group)自動生成相關的 Data Id 配置

當三種方式共同使用時,他們的一個優先級關系是:A < B < C

代碼示例

  • github :https://github.com/binzh303/spring-cloud-alibaba-learning
  • gitee :https://gitee.com/zhixie/spring-cloud-alibaba-learning

繼續閱讀