一文快速上手 Nacos 註冊中心+配置中心！

2022 年 8 月 30 日
筆記
Java面試

Spring Cloud Alibaba 是阿里巴巴提供的一站式微服務開發解決方案，目前已被 Spring Cloud 官方收錄。而 Nacos 作為 Spring Cloud Alibaba 的核心組件之一，提供了兩個非常重要的功能：註冊中心和配置中心，我們今天來了解和實現一下二者。

1.Nacos 簡介

Nacos 致力於幫助開發者發現、配置和管理微服務。它提供了一組簡單易用的特性集，幫助開發者快速實現動態服務發現、服務配置、服務元數據及流量管理。

Nacos 特性介紹

Nacos 具有以下特性：

服務發現和服務健康監測：支持基於DNS和基於RPC的服務發現，支持對服務的實時的健康檢查，阻止向不健康的主機或服務實例發送請求。
動態配置服務：動態配置服務可以讓您以中心化、外部化和動態化的方式管理所有環境的應用配置和服務配置。
動態 DNS 服務：動態 DNS 服務支持權重路由，讓您更容易地實現中間層負載均衡、更靈活的路由策略、流量控制以及數據中心內網的簡單 DNS 解析服務。
服務及其元數據管理：支持從微服務平台建設的視角管理數據中心的所有服務及元數據。

2.註冊中心實現

註冊中心有兩個重要的功能：服務註冊和服務發現，它解決了微服務集群中，調用者和服務提供者連接管理和請求轉發的功能，讓程序的開發者無需過多的關注服務提供者的穩定性和健康程度以及調用地址，因為這些都可以依靠 Nacos 進行監測、管理和自動轉發。

註冊中心中有兩個角色：一個是服務提供者 Provider，另一個是服務調用者 Consumer，接下來我們分別來創建二者。

2.1 創建服務提供者

2.1.1 新建項目並添加依賴

新建一個 Spring Boot 項目，使用阿里雲地址 //start.aliyun.com 來創建 Spring Cloud Alibaba Nacos 項目，如下圖所示：

點擊 Next 下一步，如下圖所示：

增加 Nacos Service Discovery 框架支持，如下圖所示：

對應的依賴框架如下：

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

PS：添加 Spring Web（Spring MVC）框架主要是為了方便後面測試。

2.1.2 配置 Nacos 連接信息

在配置文件 application.properties 中要填寫 Nacos 的相關連接信息，具體信息如下：

# 應用名稱（也是 Nacos 中的服務名）
spring.application.name=spring-cloud-nacos-producer
# 應用服務 WEB 訪問端口
server.port=8082
# Nacos認證信息
spring.cloud.nacos.discovery.username=nacos
spring.cloud.nacos.discovery.password=nacos
# Nacos 服務發現與註冊配置，其中子屬性 server-addr 指定 Nacos 服務器主機和端口
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
# 註冊到 nacos 的指定 namespace，默認為 public
spring.cloud.nacos.discovery.namespace=public

2.1.3 添加服務提供方法

新建一個控制器 Controller，添加一個 sayhi 方法，此方法可以使用 HTTP 協議進行訪問，它是為後面的服務消費者提供的調用方法，具體實現如下：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class SpringCloudNacosProducerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringCloudNacosProducerApplication.class, args);
    }
    @RequestMapping("/sayhi/{name}")
    public String sayHi(@PathVariable String name) {
        return "Hi Nacos Discovery " + name;
    }
}

編寫完代碼之後，運行項目就可以在 Nacos 的服務列表中看到它了，如下圖所示：

經過以上步驟，我們的服務提供者就創建好了，接下來我們創建一個服務消費者 Consumer。

2.2 創建服務消費者

2.2.1 新建項目並添加依賴

此步驟和上面的服務提供者類似，也是添加 nacos discovery 和 web 依賴，具體實現如下：

2.2.2 配置 Nacos 連接信息

# 應用名稱
spring.application.name=springcloud-nacos-consumer
# 應用服務 WEB 訪問端口
server.port=8082
# Nacos認證信息
spring.cloud.nacos.discovery.username=nacos
spring.cloud.nacos.discovery.password=nacos
# Nacos 服務發現與註冊配置，其中子屬性 server-addr 指定 Nacos 服務器主機和端口
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
# 註冊到 nacos 的指定 namespace，默認為 public
spring.cloud.nacos.discovery.namespace=public

2.2.3 添加服務調用代碼

服務消費者的實現有兩個關鍵點，第一，先 new 一個 RestTemplate 對象，此對象是 Spring 框架提供用於進行 HTTP 請求的類，實現代碼如下：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
@EnableDiscoveryClient
public class SpringcloudNacosConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringcloudNacosConsumerApplication.class, args);
    }
    @LoadBalanced
    @Bean
    public RestTemplate restTemplate() {
        // 用於進行 HTTP 請求的對象
        return new RestTemplate();
    }
}

第二，新建一個控制器，注入 RestTemplate 對象，並調用 Nacos 中的服務提供者接口，實現代碼如下：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@RestController
public class TestController {
    @Autowired
    private RestTemplate restTemplate;

    @RequestMapping("/hi")
    public String hi(String name) {
        // 調用生產者 sayhi 方法，並返回結果
        return restTemplate.getForObject("//spring-cloud-nacos-producer/sayhi/" + name,
                String.class);
    }
}

其中 spring-cloud-nacos-producer 是服務提供者的 ID，而 sayhi 是服務提供者提供的接口地址。

通過以上配置，我們的服務消費者也創建好了，啟動項目，執行結果如下圖所示：

從上述結果可以看出，服務消費者通過 Nacos 已經成功調用到服務提供者了，這就是 Nacos 中註冊中心的基本使用。

3.配置中心實現

配置中心的作用是將本地配置文件雲端話，所謂的雲端也就是 Nacos 的服務器端，這樣既能保證配置文件中的敏感數據不會暴露，同時又提供了實時的修改、查看、回滾和動態刷新配置文件的功能，非常實用。

但是需要注意的是配置中心和註冊中心的依賴包是不同的，註冊中心的依賴包是 nacos discovery，而配置中心的依賴包是 nacos config，它的具體如下。

3.1 新建項目並添加依賴

創建一個 Spring Boot 項目，添加 nacos config 和 web 依賴包，如下圖所示：

PS：添加 web 依賴主要是為了方便後面測試。

對應的配置依賴信息如下：

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

3.2 配置 Nacos Config 信息

在應用的 /src/main/resources/ 目錄下，創建引導配置文件 bootstrap.yml（或 bootstrap.properties），添加以下 Nacos Config 配置：

spring:
  application:
    name: nacosconfig # 項目名稱和 nacos DataId 相匹配
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848 # nacos 地址和端口
        file-extension: yaml # 獲取配置文件的格式：yaml
        username: nacos # nacos 認證用戶名
        password: nacos # nacos 認證密碼
server:
  port: 9001 # 項目啟動端口

3.3 編寫代碼讀取配置文件

新建控制器，使用 @Value 註解讀取配置信息，實現代碼如下：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    // 從 nacos 中讀取配置項 config.info
    @Value("${config.info}")
    private String configInfo;

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

3.4 Nacos 控制台添加配置信息

在 Nacos 控制台創建並設置配置文件，執行步驟如下所示。
首先，在配置列表中點擊「添加」按鈕，如下圖所示：

進入配置頁面，新建 YAML 或 Properties 配置文件，如下圖所示：

以上關鍵參數的含義和規則說明如下。

3.4.1 Data ID

Data ID 的拼接格式如下：

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

其中

prefix 默認為 spring.application.name 的值，也可以通過配置項 spring.cloud.nacos.config.prefix 來配置。
spring.profiles.active 即為當前環境對應的 profile，當 active profile 為空時，對應的連接符 – 也將不存在，dataId 的拼接格式變成 ${prefix}.${file-extension}
file-extension 為配置內容的數據格式，可以通過配置項 spring.cloud.nacos.config.file-extension 來配置。目前只支持 properties 類型。

3.4.2 Group

Group 分組選項，主要是用來隔離不同的配置項目的，它的默認值為 DEFAULT_GROUP，可以通過 spring.cloud.nacos.config.group 配置。

配置好相應的內容之後，點擊底部的「發佈」按鈕即可，添加成功之後會自動返回配置列表，如下圖所示：

經過以上步驟，Nacos 配置中心的功能就實現完了，接下來啟動項目，程序的執行結果如下圖所示：

3.5 動態刷新功能

動態刷新功能是指，在 Nacos 配置中心修改了配置文件，在不重啟項目的前提下，可以實時讀取到最新的配置內置。

Nacos 默認會為所有獲取數據成功的 Nacos 的配置項添加了監聽功能，在監聽到服務端配置發生變化時會實時觸發 org.springframework.cloud.context.refresh.ContextRefresher 的 refresh 方法。

但如果需要對 Bean 進行動態刷新，需要參照 Spring 和 Spring Cloud 規範，推薦給類添加 @RefreshScope 或 @ConfigurationProperties 註解，就可以實現配置中心的動態刷新功能了。

4.項目源碼

//gitee.com/mydb/spring-cloud-alibaba-example

小結

Nacos 作為 Spring Cloud Alibaba 的核心組件之一，提供了兩個非常重要的功能：註冊中心和配置中心。註冊中心有兩個重要的功能：服務註冊和服務發現，它解決了微服務集群中，調用者和服務提供者連接管理和請求轉發的功能，保證了服務調用者能夠穩定的調用到健康的服務。而註冊中心的本質是將項目中的本地配置文件雲端化，解決了配置文件的安全性與統一性的問題，並且提供了配置文件歷史版本回滾和配置文件動態刷新的功能。

參考文檔

Nacos 官方文檔：//nacos.io/zh-cn/docs/what-is-nacos.html

是非審之於己，毀譽聽之於人，得失安之於數。

公眾號：Java中文社群

Java面試合集：//gitee.com/mydb/interview

Tags: Java面試