微服務架構 | 3.2 Alibaba Nacos 註冊中心

目錄

• 前言
• 1. Nacos 基礎知識
  • 1.1 Nacos 命名方式
  • 1.2 Nasoc 是什麼
  • 1.3 Nacos 的 4 個關鍵特性
  • 1.4 Nacos 生態圖
  • 1.5 Nacos 架構圖
  • 1.6 Nacos 支援 AP 和 CP 模式的切換
  • 1.7 Nacos 檔案結構說明
  • 1.8 Nacos 服務註冊與發現的原始碼分析
• 2. 安裝並執行 Nacos 伺服器
  • 2.1 安裝包安裝 Nacos 伺服器
    • 2.1.1 下載 Nacos
    • 2.1.2 直接執行報錯
    • 2.1.3 修改啟動方式後啟動
  • 2.2 原始碼部署 Nacos 伺服器
    • 2.2.1 下載原始碼
    • 2.2.2 本地編譯
    • 2.2.3 修改配置
    • 2.2.4 啟動 Nacos
  • 2.2.5 啟動報錯
• 3. 使用 Nacos 管理服務提供者
  • 3.1 引入 pom.xml 依賴檔案
  • 3.2 修改 application.yml 配置檔案
  • 3.3 在主程式類上新增註解
  • 3.4 編寫業務類
• 4. 使用 Nacos 管理服務消費者
  • 4.1 引入 pom.xml 依賴檔案
  • 4.2 修改 application.yml 配置檔案
  • 4.3 在主程式類上新增註解
  • 4.4 編寫業務類
• 5. Nacos 持久化配置
  • 5.1 切換成 MySQL
  • 5.2 修改配置檔案
• 6. Nacos 的高可用部署
  • 6.1 環境要求
  • 6.2 安裝包及環境準備
  • 6.3 修改叢集配置
  • 6.4 初始化 MySQL
  • 6.5 啟動 Nacos 服務
• 7. 包含 Nginx 的 Nacos 高可用示例
  • 7.1 [可選] 修改 startup.sh 啟動配置
  • 7.2 配置 Nginx 負載均衡器
  • 7.3 測試通過 Nginx 訪問 Nacos
• 8. Dubbo 使用 Nacos 作為註冊中心
• 最後

---

前言

參考資料：
《Spring Microservices in Action》
《Spring Cloud Alibaba 微服務原理與實戰》
《B站 尚矽谷 SpringCloud 框架開發教程 周陽》
《Nacos 官網》

Nacos 致力於解決微服務中的統一配置、服務註冊與發現等問題。它提供了一組簡單易用的特性集，幫助開發者快速實現動態服務發現、服務配置、服務後設資料及流量管理；

---

1. Nacos 基礎知識

1.1 Nacos 命名方式

• 前四個字母分別為 Naming 和 Configuration 的前兩個字母，最後的 s 為 Service；

1.2 Nasoc 是什麼

• 一個更易於構建雲原生應用的動態服務發現、配置管理和服務管理平臺；
• Nacos: Dynamic Naming and Configuration Service；
• Nacos 是註冊中心 + 配置中心的組合，相當於：Nacos = Eureka+Config +Bus；

1.3 Nacos 的 4 個關鍵特性

• 服務發現和服務健康監測：
  • Nacos 支援基於 DNS 和基於 RPC（HTTP&API）的服務發現；
  • Nacos 提供對服務的實時的健康檢查，阻止向不健康的主機或服務例項傳送請求；
  • 對於複雜的雲環境和網路拓撲環境中（如VPC、邊緣網路等）服務的健康檢查，Nacos 提供了 agent 上報和服務端主動檢測兩種健康檢查模式；
  • Nacos 還提供了統一的健康檢查儀表盤，幫助使用者根據健康狀態管理服務的可用性及流量；
• 動態配置服務：
  • Nacos 提供了一個簡潔易用的 UI（控制檯樣例 Demo）幫助使用者管理所有服務和應用的配置；
  • Nacos 還提供了包括配置版本跟蹤、金絲雀釋出、一鍵回滾配置及客戶端配置更新狀態跟蹤在內的一系列開箱即用的配置管理特性；
• 動態 DNS 服務：
  • 動態 DNS 服務支援權重路由，讓開發者更容易地實現中間層負載均衡、更靈活的路由策略、流量控制，以及資料中心內網的簡單 DNS 解析服務；
• 服務及其後設資料管理：
  • Nacos 可以使開發者從微服務平臺建設的視角管理資料中心的所有服務及後設資料；
  • 包括；管理服務的描述、生命週期、服務的靜態依賴分析、服務的健康狀態、服務的流量管理、路由及安全策略、服務的 SLA 及最重要的 metrics 統計資料；

1.4 Nacos 生態圖

1.5 Nacos 架構圖

• 服務提供者通過 VIP（Virtual IP）訪問 Nacos Server 高可用叢集，基於 Open API 完成服務的註冊和服務查詢；
• Nacos Server 本身可以支援主備模式，所以底層會採用資料一致性演算法來完成從節點的資料同步；
• 服務消費者也是如此，基於 Open API 從 Nacos Server 中查詢服務列表；

1.6 Nacos 支援 AP 和 CP 模式的切換

• 簡單來說：
  • C 是所有節點在同一時間看到的資料是一致的；而 A 的定義是所有的請求都會收到響應；
• 模式選擇：
  • 如果不需要儲存服務級別的資訊且服務例項是通過 nacos-client 註冊，並能夠保持心跳上報，那麼就可以選擇 AP 模式；
  • 當前主流的服務如 Spring cloud 和 Dubbo 服務，都適用於 AP 模式，AP 模式為了服務的可能性而減弱了一致性，因此 AP 模式下只支援註冊臨時例項；
  • 如果需要在服務級別編輯或者儲存配置資訊，那麼 CP 是必須， K8S 服務和 DNS 服務則適用於 CP 模式；
  • CP 模式下則支援註冊持久化例項，此時則是以 Raft 協議為叢集執行模式，該模式下注冊例項之前必須先註冊服務，如果服務不存在，則會返回錯誤；
• 切換模式：
  • curl -X PUT '$NACOS_SERVER:8848/nacos/v1/ns/operator/switches?entry=serverMode&value=CP'；

1.7 Nacos 檔案結構說明

• bin 目錄：服務啟動/停止指令碼；
• conf 目錄：配置檔案；
  • application.properties 檔案：Spring Boot 專案預設的配置檔案；
  • cluster.conf.example：叢集配置樣例檔案；
  • nacos-mysql.sql：MySQL 資料庫指令碼；
  • nacos-logback.xml：Nacos 日誌配置檔案；
• data 目錄：Derby 資料庫儲存；
• logs 目錄：日誌；
• target 目錄：編譯打包後的檔案；

1.8 Nacos 服務註冊與發現的原始碼分析

• 由於篇幅有限，該內容放在：《微服務架構 | *3.5 Nacos 服務註冊與發現的原始碼分析》；

2. 安裝並執行 Nacos 伺服器

Nacos 依賴 Java 1.8 以上環境，有兩種安裝方式：使用已經編譯好的安裝包和原始碼部署；由於《*3.5 Nacos 服務註冊與發現的原始碼分析》要對 Nacos 原始碼進行分析，這裡推薦原始碼部署；
這裡選擇的版本是 2.0.3；

2.1 安裝包安裝 Nacos 伺服器

2.1.1 下載 Nacos

• 從官網下載 Nacos：https://github.com/alibaba/nacos/releases；

2.1.2 直接執行報錯

• 下載解壓後如圖：
  
• 直接雙擊執行 startup.cmd 會報錯：

org.springframework.context.ApplicationContextException: Unable to start web server; nested exception is org.springframework.boot.web.server.WebServerException: Unable to start embedded Tomcat
        at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.onRefresh(ServletWebServerApplicationContext.java:156)
        at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:544)
        at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:141)

• 原因是 Nacos 預設以叢集模式啟動，我們需要單機模式，修改啟動方式即可；

2.1.3 修改啟動方式後啟動

• 修改 startup.cmd 裡第26行為 standalone：

• 儲存後啟動，訪問 http://localhost:8848/nacos 即可；

• 預設起始密碼和賬號都是 nacos；

2.2 原始碼部署 Nacos 伺服器

由於 2.0.3 版本筆者一直部署失敗，因此這裡以 1.4.2 版本為例；

2.2.1 下載原始碼

• 訪問連結：https://github.com/alibaba/nacos
• 將程式碼派生到自己的倉庫，在 Tags 標籤裡選擇 1.4.2 版本的，拉取 Nacos-1.4.2 原始碼；

• 建立 Nacos 1.4.2 分支（名字可以自己取）；

• 由於 GitHub Http 預設拉取 default 標籤下的程式碼，因此這裡選擇修改 default 為 1.4.2 標籤，再拉取程式碼；

• 點選 Update；

• 然後在 idea 上拉取程式碼即可；

2.2.2 本地編譯

• 原始碼下載後，會自動匯入依賴 jar 包，有匯入不成功的可以嘗試手動匯入，親測有效；
• 需要使用 Maven 對原始碼進行編譯。進入到 Nacos 原始碼目錄，使用如下mvn命令，開始本地編譯：
• mvn -Prelease-nacos -Dmaven.test.skip=true clean install -U

• 編譯完成後截圖如下：

2.2.3 修改配置

• 跟安裝包部署一樣，我們需要以單機方式啟動 Nacos；
• 因此需要在啟動引數中進行設定，在 JVM 的啟動引數中，新增：-Dnacos.standalone=true

2.2.4 啟動 Nacos

• 找到 nacos-console 模組下的啟動類 com.alibaba.nacos.Nacos 啟動即可；
• 瀏覽器訪問：http://localhost:8848/nacos
• 預設賬號和密碼都是 nacos；

2.2.5 啟動報錯

• 如果啟動失敗報錯 找不到 entity 包，這需要編譯 nacos-consistency 模組，重新整理下 Maven，然後重新啟動即可；

3. 使用 Nacos 管理服務提供者

使用 Nacos 構建服務提供者大致與 Zookeeper 和 Consul 相同； Zookeeper 與 Consul 的構建方式詳情請見《3.3 Apache Zookeeper 註冊中心》與《3.4 HashiCorp Consul 註冊中心》；

3.1 引入 pom.xml 依賴檔案

• 父工程的依賴：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
    <version>2.1.0.RELEASE</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

• 本模組的依賴：

<!--SpringCloud ailibaba nacos -->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

3.2 修改 application.yml 配置檔案

server:
  port: 9001

spring:
  application:
    name: nacos-provider
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #配置Nacos地址

management:
  endpoints:
    web:
      exposure:
        include: '*'

3.3 在主程式類上新增註解

• @EnableDiscoveryClient：使用其他元件（Nacos、zookeeper、Consul）作為註冊中心；

3.4 編寫業務類

這裡編寫一個簡單介面僅作為示例；

@RestController
public class providerController{
    @Value("${server.port}")
    private String serverPort;

    @RequestMapping(value = "/provider/nacos")
    public String providerNacos(){
        return "springcloud with nacos: "+serverPort+"\t"+ UUID.randomUUID().toString();
    }
}

4. 使用 Nacos 管理服務消費者

使用 Nacos 構建服務提供者大致與 Zookeeper 和 Consul 相同； Zookeeper 與 Consul 的構建方式詳情請見《3.3 Apache Zookeeper 註冊中心》與《3.4 HashiCorp Consul 註冊中心》；

4.1 引入 pom.xml 依賴檔案

<!--SpringCloud ailibaba nacos -->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

4.2 修改 application.yml 配置檔案

server:
  port: 80

spring:
  application:
    name: nacos-consumer
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848

#消費者將要去訪問的微服務名稱(註冊成功進nacos的微服務提供者)
service-url:
  nacos-user-service: http://nacos-provider

4.3 在主程式類上新增註解

• 同提供者；
• @EnableDiscoveryClient：使用其他元件（Nacos、zookeeper、Consul）作為註冊中心；

4.4 編寫業務類

• 由於我們使用 Ribbon + RestTemplate 的負載均衡策略，因此需要在 IoC 容器中新增一個 RestTemplate JavaBean；
• 詳情請見《4.1 基於 Ribbon 的負載均衡詳解》；
• 該 Bean 可以在主啟動類中新增；也可以在主啟動類所在包或子包的 config 包中新增，如下：

@Configuration
public class ApplicationContextBean{
    @Bean
    @LoadBalanced
    public RestTemplate getRestTemplate(){
        return new RestTemplate();
    }
}

• 我們在 controller 層開放介面給客戶端，並在該介面裡呼叫提供者的 API；

@RestController
public class ComsumerNacosController{
    public static final String INVOKE_URL = "http:// nacos-provider";

    @Autowired
    private RestTemplate restTemplate;

    @RequestMapping(value = "/consumer/nacos")
    public String paymentInfo(){
        String result = restTemplate.getForObject(INVOKE_URL+"/provider/nacos", String.class);
        System.out.println("消費者呼叫提供者獲取服務--->result:" + result);
        return result;
    }
}

5. Nacos 持久化配置

• 在 0.7 版本之前，在單機模式時 Nacos 使用嵌入式資料庫 Derby 實現資料的儲存，不方便觀察資料儲存的基本情況。0.7 版本增加了支援 MySQL 資料來源能力；
• Derby 資料庫是一種檔案型別的資料庫，在使用時會存在一定的侷限性。比如它無法支援多使用者同時操作，在資料量大、連線數多的情況下會產生大量連線的積壓。所以在生產環境中，可以用 MySQL 替換；
• 在 pom.xml 裡可以找到 Derby 依賴；

5.1 切換成 MySQL

• 首先在 nacos-server-2.0.3\nacos\conf 目錄下找到 sql 指令碼 nacos-mysql.sql；

#需要自己先建立資料庫，再執行 sql 指令碼；
CREATE DATABASE nacos_config;
USE nacos_config;

• 在 MySQL 裡執行該指令碼新建資料庫；

5.2 修改配置檔案

• 接著在 nacos-server-2.0.3\nacos\conf 目錄下找到 application.properties 配置檔案，修改成 MySQL 相關；
• 原始碼部署需要在 ..\nacos\console\src\main\resources\application.properties 檔案裡配置；

spring.datasource.platform=mysql
db.num=1
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=root
db.password=123456

• 再以單機模式啟動 Nacos，Nacos 所有寫嵌入式資料庫的資料都寫到了 MySQL；

6. Nacos 的高可用部署

• 叢集模式：用於生產環境，確保高可用；

• 叢集部署官方文件：https://nacos.io/zh-cn/docs/cluster-mode-quick-start.html；
  

• Nacos 的資料一致性演算法採用的是 Raft，同樣採用了該演算法的中介軟體有 Redis Sentinel 的 Leader 選舉、Etcd 等；
  

6.1 環境要求

• 64 bit OS Linux/UNIX/Mac，推薦 Linux 系統；
• 64bit JDK1.8 及以上；
• Maven3.2.x 及以上；
• 3 個或 3 個以上 Nacos 節點才能構成叢集；
• MySQL 資料庫，版本 5.6.5+；

6.2 安裝包及環境準備

• 準備 3 臺伺服器；
• 到官方 GitHub 下載 Linux 版：https://github.com/alibaba/nacos/releases/tag/2.0.3；
• 解壓檔案：

unzip nacos-server-2.0.3.zip

6.3 修改叢集配置

• 在 Nacos 的解壓目錄 nacos/conf 下，有配置檔案叢集的 cluster.conf 檔案，裡面配置 ip:port，需要配置3個或3個以上節點；

cd ${NACOS_HOME}/config
cp cluster.conf.example cluster.conf

• 使用 vi 編輯器開啟 cluster.config，按 a/i/o 鍵可進入插入模式，輸入以下內容（3 臺機器都需要修改）；

#ip:port
10.51.10.128:8848
10.51.10.129:8848
10.51.10.130:8848

• 然後按ESC鍵返回到命令模式，再按shif+:進入末行模式，輸入wq敲回車（儲存並退出）；
• 由於 3 臺機器需要彼此通訊，在部署時需要防火牆對外開放 8848 埠；

6.4 初始化 MySQL

• 參考：《5. Nacos 持久化配置》，將每個 Nacos 的資料來源換成 MySQL；
• 同樣，3 臺機器都需要配置 MySQL 資料庫；

6.5 啟動 Nacos 服務

• 分別進入 3 臺機器的 bin 目錄，執行 sh startup.sh 或者 startup.cmd-m cluster 命令啟動服務；
• 服務啟動成功之後，在 ${NACOS_HOME}\logs\start.out 下可以獲得如下日誌，表示服務啟動成功：

2020-01-2814：26：25，654INFO Nacos Log files:/data/program/nacos/1ogs/
2020-01-2014：26：25，654 INFO Nacos Conf files:/data/program/nacos/conf/
2020-01-20 14：26：25，654 INFO Nacos Data files:/data/program/nacos/data/
2020-01-20 14：26：25，654 INFO Nacos started successfully in cluster mode.

• 通過 http://$NACOS_CLUSTER_IP：8848/nacos 即可訪問 Nacos 控制檯；

7. 包含 Nginx 的 Nacos 高可用示例

• 即要完成上圖的叢集配置；
• 在《6. Nacos 的高可用部署》的基礎上，還需要配置 Nginx 伺服器；

7.1 [可選] 修改 startup.sh 啟動配置

• 這裡指在一臺伺服器上啟動 3 個 Nacos 例項模擬叢集時才需要配置；
• 比如 cluster.config 的配置如下（指一臺伺服器上開放三個埠模擬叢集）：

#ip:port
192.168.111.144:3333
192.168.111.144:4444
192.168.111.144:5555

• 目的：使 Nacos 能夠接受不同的啟動埠，即傳遞不同的埠號啟動不同的 Nacos 例項；
• 在 ${NACOS_HOME}\bin\startup.sh 檔案裡：

• 修改完後，我們可以指定不同的埠啟動不同的 Nacos 例項；
  

7.2 配置 Nginx 負載均衡器

• 如果需要通過 Nignx 對 Nacos 例項進行負載均衡，需要以下配置；
• 修改 Nginx 的配置檔案 nginx/conf/nginx.conf；

• 按照指定啟動：

7.3 測試通過 Nginx 訪問 Nacos

• 需要修改服務提供者的 application.yml 檔案指向 Nginx 伺服器：

server:
  port: 9002

spring:
  application:
    name: nacos-provider
  cloud:
    nacos:
      discovery:
        #配置Nacos地址
        #server-addr: localhost:8848
        # 換成nginx的1111埠，做叢集
        server-addr: 192.168.111.144:1111

management:
  endpoints:
    web:
      exposure:
        include: '*'

• 訪問連線：http://192.168.111.144:1111/nacos/#/login；
• 結果如下：

8. Dubbo 使用 Nacos 作為註冊中心

• 詳情請見：本系列另外一篇文章《12.1 使用 Apache Dubbo 實現遠端通訊》裡的《6. Dubbo 使用 Nacos 作為註冊中心》；

---

最後

新人制作，如有錯誤，歡迎指出，感激不盡！ 歡迎關注公眾號，會分享一些更日常的東西！ 如需轉載，請標註出處！