Spring Cloud Alibaba Nacos 服務注冊與發現功能實現

作者：磊哥 2022-02-07 07:10:32

Nacos 是 Spring Cloud Alibaba 中一個重要的組成部分，它提供了兩個重要的功能：服務注冊與發現和統一的配置中心功能。

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

試想一下，當一個系統被部署多個之后，如何確定要調用哪一個(服務)實例?當某個被調用的實例出現問題時，又如何將請求轉發到其他實例上?這些問題都是微服務架構中現實存在的問題，然而使用 Nacos 就可以輕松的解決這些問題。并且 Nacos 也提供了統一的配置中心，解決了之前項目配置文件存放在本地或 github 上的安全性問題，并且支持動態修改和統一維護配置文件的功能。

1.Nacos 簡介

Nacos 是 Dynamic Naming and Configuration Service 的首字母簡稱;它是?個更易于構建云原生應用的動態服務發現、配置管理和服務管理的平臺。

官網：https://nacos.io/

倉庫源碼：

??https://github.com/alibaba/nacos??

2.Nacos 生態

Nacos 幾乎支持所有主流語言，其中 Java/Golang/Python 已經支持 Nacos 2.0 長鏈接協議，能最大限度發揮 Nacos 性能。阿里微服務 DNS(Dubbo+Nacos+

Spring-cloud-alibaba/Seata/Sentinel)最佳實踐，是 Java 微服務生態最佳解決方案。

3.Nacos 快速部署

Nacos 支持 3 種部署模式：

單機部署
集群部署
多集群部署

Nacos 安裝方式有以下 2 種：

使用源碼安裝。
使用已編譯好的安裝包進行安裝。

本文我們將使用第一種方式加 Docker，來快速部署 Nacos 服務器端。

因為 Docker 方式安裝和卸載都比較方便，所以本文就采用此方式來演示 Nacos 的安裝，其他安裝方式，詳見官網：

??https://nacos.io/zh-cn/docs/quick-start.html??

3.1 預備環境準備

Nacos 依賴 Java 環境來運行，如果您是從代碼開始構建并運行 Nacos，還需要為此配置 Maven 環境，請確保是在以下版本環境中安裝使用：

64 bit OS，支持 Linux/Unix/Mac/Windows，推薦選用 Linux/Unix/Mac。
64 bit JDK 1.8+。
Maven 3.2.x+。

因為本文使用的是 Nacos + Docker 的方式進行部署的，所以沒有安裝 Docker 的同學，自行搜索安裝哦。

安裝 Open JDK 8

yum -y install java-1.8.0-openjdk-devel.x86_64

安裝完之后，使用 java -version 檢查是否安裝成功，如下圖所示：

若顯示具體的 Java 版本則表示安裝成功。

3.2 下載 Nacos

本文使用 git 的方式來下載 Nacos 源碼包，所以需要使用以下命令來先安裝 git：

yum -y install git

下載 Nacos 源碼：

git clone https://github.com/nacos-group/nacos-docker.git

下載完成如下圖所示：

進入 Nacos 目錄：

yum -y install git

3.3 啟動 Nacos 服務

Nacos 的運行是需要數據庫的，它支持兩種數據庫：本地數據庫 Derby、和 MySQL 數據庫。

所以對應的啟動命令有以下幾種：

Derby 數據庫運行單機模式：docker-compose -f example/standalone-derby.yaml up
MySQL 5.7 數據庫運行單機模式：docker-compose -f example/standalone-mysql-5.7.yaml up
MySQL 8 數據庫運行單機模式：docker-compose -f example/standalone-mysql-8.yaml up

集群模式啟動：docker-compose -f

example/cluster-hostname.yaml up

啟動成功如下圖所示：

3.3 訪問Nacos

啟動成功之后，就可以使用

http://127.0.0.1:8848/nacos/#/login 來訪問 Nacos 的管理控制臺了，如下圖所示：

用戶名和密碼都輸入 nacos 就可以進入系統了，如下圖所示：

3.4 常見報錯問題

3.4.1 docker-compose 命令未找到

docker-compose 是用于定義和運行多容器 Docker 應用程序的編排工具。使用 docker-compose 后不再需要逐一創建和啟動容器。您可以使用 YML 文件來配置應用程序需要的所有服務，然后使用一個命令，就可以從 YML 文件配置中創建并啟動所有服務。

但是 docker-compose 需要單獨安裝，否則會出現以下錯誤：

解決方案：

cd /usr/local/bin
wget https://github.com/docker/compose/releases/download/1.14.0-rc2/docker-compose-Linux-x86_64
rename docker-compose-Linux-x86_64 docker-compose docker-compose-Linux-x86_64
chmod +x /usr/local/bin/docker-compose
docker-compose version

安裝成功如下圖所示：

3.4.2 image：invalid reference format

使用 docker-compose 可能會提示“ERROR: no such image: nacos/nacos-server:: invalid reference format”，無效的參數格式，如下圖所示：

解決方案：修改 Nacos 源碼中

example/standalone-mysql-5.7.yaml 的配置項，將“image: nacos/nacos-server:{{NACOS_VERSION}}”，修改為：“image: nacos/nacos-server:latest”。

4.Spring Cloud Alibaba 服務注冊

服務注冊者也就是生產者，是微服務中的服務提供者。它是以 Spring Boot 項目為基礎創建的，具體操作步驟如下：

創建項目使用阿里云的地址 http://start.aliyun.com 來創建 Spring Cloud Alibaba Nacos 項目，點擊下一步 Next，如下圖所示：

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

再添加 Spring Web(Spring MVC)框架的支持，最后點擊 Finish 完成項目創建。

4.1 項目依賴

Spring Cloud Alibaba Nacos 項目主要有兩個依賴項，如下內容所示：

<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>

4.2 修改配置文件

在配置文件 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=mse-6d50f4f0-p.nacos-ans.mse.aliyuncs.com:8848
# 注冊到 nacos 的指定 namespace，默認為 public
spring.cloud.nacos.discovery.namespace=public

4.3 添加代碼

接下來添加一個 Restful API 的接口，給后面的服務調用者使用，具體實現代碼如下：

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
@EnableDiscoveryClient
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 中的服務列表就可以看到此項目，如下圖所示：

經過以上操作，我們創建的 Spring Cloud Alibaba 的項目就被注冊到 Nacos 中了，其他程序也可以通過 Nacos 對它進行調用了。

5.Spring Cloud Alibaba 服務發現

與上面創建方式類似，接下來我們再創建一個服務調用者，也叫做消費者來調用上面框架中的 sayhi 方法，具體操作步驟如下。

5.1 創建項目

5.2 修改配置文件

# 應用名稱
spring.application.name=springcloud-nacos-consumer
# 應用服務 WEB 訪問端口
server.port=8082
# Nacos幫助文檔: https://nacos.io/zh-cn/docs/concepts.html
# Nacos認證信息
spring.cloud.nacos.discovery.username=nacos
spring.cloud.nacos.discovery.password=nacos
# Nacos 服務發現與注冊配置，其中子屬性 server-addr 指定 Nacos 服務器主機和端口
spring.cloud.nacos.discovery.server-addr=82.157.146.10:8848
# 注冊到 nacos 的指定 namespace，默認為 public
spring.cloud.nacos.discovery.namespace=public

5.3 添加代碼

消費者的實現代碼有兩個類，在啟動類中添加一個 RestTemplate 的 Bean 對象，用于提供 Restful API 的請求，啟動類的具體實現代碼如下：

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() {
        return new RestTemplate();
    }
}

消費者的具體實現代碼如下：

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("http://spring-cloud-nacos-producer/sayhi/" + name,
                String.class);
    }
}

添加完代碼之后，運行程序，在 Nacos 的服務列表中可看到以下內容：

之后訪問消費者的 hi 方法，讓其調用生產者的實現效果如下：

從上述結果可以看出，消費者通過 Nacos 已經成功的調用到了生產者

spring-cloud-nacos-producer 中的 sayhi 方法了。

小結

Nacos 提供了兩個重要的功能：服務注冊與發現和統一配置中心的功能，它提供了 3 種部署方式：單機部署、集群部署和多集群部署，以及兩種安裝方式：源碼安裝和安裝包安裝。我們使用的是 Docker 加 Nacos 源碼的方式來安裝和部署 Nacos 的。Nacos 服務注冊和發現都需要添加 Nacos Service Discovery 框架的支持，且在配置文件中配置相應的 Nacos 信息，才可以正確的實現服務的注冊和發現功能。

參考&鳴謝

《Nacos框架與原理》

責任編輯：武曉燕來源： Java中文社群

服務注冊功能