第四章 Nacos之服務配置

Nacos之服務配置

文章目錄

• Nacos之服務配置
• 前言
• 一、Nacos作為服務配置中心
• • 1. 建立子產品
  • 2. 導入pom依賴
  • 3. 配置yam檔案
  • 4. 主啟動類
  • 5. 業務類
• 總結

前言

在Nacos出現之前，我們通常使用SpringCloud Config 分布式配置中心 + SpringCloud Bus 消息總線來實作配置檔案的分布式配置和動态重新整理。微服務意味着要将單體應用中的業務拆分成一個個子服務，每個服務的粒度相對較小，是以系統中會出現大量的服務。由于每個服務都需要必要的配置資訊才能運作，是以一套集中式的、動态的配置管理設施是必不可少的。而Nacos很好的整合了這幾個功能，下文就Nacos作為服務配置中心進行介紹。

一、Nacos作為服務配置中心

1. 建立子產品

cloudalibaba-config-nacos-client3377

2. 導入pom依賴

<dependencies>
        <!--nacos-config-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <!--nacos-discovery-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!--web + actuator-->
        <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>
        <!--一般基礎配置-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

           

3. 配置yam檔案

需要配置bootstrap和application兩個檔案，bootstrap優先級高于application。

Nacos同springcloud-config一樣，在項目初始化時，要保證先從配置中心進行配置拉取，

拉取配置之後，才能保證項目的正常啟動。

application.yml

spring:
  profiles:
    active: dev # 開發環境
#    active: test # 測試環境
#    active: info # 開發環境
           

bootstrap.yml

server:
  port: 3377
spring:
  application:
    name: nacos-config-client
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 # 注冊中心
      config:
        server-addr: localhost:8848 # 配置中心
        file-extension: yaml # 這裡指定的檔案格式需要和nacos上建立的配置檔案字尾相同，否則讀不到
        # group: DEFAULT_GROUP
        # namespace: 18181b6a-19ee-441c-8eeb-b7263f368b08

# 以下為在nacos添加配置檔案的命名格式
# ${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
#  nacos-config-client-dev.yaml

           

Nacos中的dataid的組成格式及與SpringBoot配置檔案中的比對規則

• prefix 預設為 spring.application.name 的值，也可以通過配置項
• spring.cloud.nacos.config.prefix來配置。 spring.profiles.active 即為目前環境對應的profile，詳情可以參考 Spring Boot文檔。 注意：當 spring.profiles.active 為空時，對應的連接配接符也将不存在，dataId 的拼接格式變成 p r e f i x . {prefix}. prefix.{file-extension}

• file-exetension 為配置内容的資料格式，可以通過配置項 spring.cloud.nacos.config.file-extension 來配置。目前隻支援properties 和 yaml 類型。

  Nacos會記錄配置檔案的曆史版本預設保留30天，此外還有一鍵復原功能，復原操作将會觸發配置更新

  

4. 主啟動類

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

/**
 * @author Xin
 * @date 2022/10/3 18:57
 */
@SpringBootApplication
@EnableDiscoveryClient
public class NacosClientConfig3377 {
    public static void main(String[] args) {
        SpringApplication.run(NacosClientConfig3377.class);
    }
}
           

5. 業務類

package com.xin.springcloud.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Xin
 * @date 2022/10/3 19:00
 */
@RestController
// 通過 Spring Cloud 原生注解 @RefreshScope 實作配置自動更新
@RefreshScope
public class ConfigClientController {
    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/config/info")
    public String getConfigInfo() {
        return configInfo;
    }
}
           

##6. 測試

1. 啟動前需要在nacos用戶端-配置管理-配置管理欄目下有對應的yaml配置檔案
2. 運作cloud-config-nacos-client3377的主啟動類
3. 調用接口檢視配置資訊:http://localhost:3377/config/info

   

4. nacos自帶動态重新整理。修改下Nacos中的yaml配置檔案，再次調用檢視配置的接口，就會發現配置已經重新整理

總結

本文簡單介紹了Nacos配置中心的使用，而Nacos提供的動态配置服務可以讓以中心化、外部化和動态化的方式管理所有環境的應用配置和服務配置。動态配置消除了配置變更時重新部署應用和服務的需要，讓配置管理變得更加高效和靈活。相比SpringCloud Config 分布式配置中心 + SpringCloud Bus 消息總線來看。Nacos的配置中心使用起來更加的友善快捷。