註冊中心/配置管理 —— SpringCloud Alibaba Nacos

Nacos 簡介

Nacos 是一個易於使用的動態服務發現、配置和服務管理平臺，用於構建雲原生的應用程序

Nacos 的關鍵特性包括以下幾項：

• 服務發現和服務健康監測：服務提供者使用原生 SDK、OpenAPI 等註冊服務後，服務消費者可以使用 HTTP&API 查找和發現服務。Nacos 提供對服務的實時健康檢查，阻止向不健康的主機或服務實例發送請求
• 動態配置服務：動態配置服務可以讓你以中心化、外部化和動態化的方式管理所有環境的應用配置和服務配置。動態配置消除了配置變更時重新部署應用和服務的需要，讓配置管理變得更加高效和敏捷
• 動態 DNS 服務：動態 DNS 服務支持權重路由，讓你更容易實現中間層負載均衡、更靈活的路由策略、流量控制以及數據中心內網的簡單 DNS 解析服務
• 服務及其元數據管理：Nacos 從微服務平臺建設的視角管理數據中心的所有服務及元數據，包括管理服務的描述、生命週期、服務的靜態依賴分析、服務的健康狀態、服務的流量管理、路由及安全策略、服務的 SLA 以及首要的 metrics 統計數據

Nacos 快速開始

1. Nacos Server 單機模式

在使用 Nacos 之前，需要先下載 Nacos 並啓動 Nacos Server，Nacos Server 有兩種運行模式：standalone（單機）和 cluster（集羣），這裏以 2.2.3.release，windows 環境爲例

前往 Github 下載 Nacos Server：GitHub - alibaba/nacos: an easy-to-use dynamic service discovery, configuration and service management platform for building cloud native applications.

解壓壓縮包，在 bin 目錄下執行命令 .\startup.cmd -m standalone

在瀏覽器中訪問：http://localhost:8848/nacos，輸入用戶名和密碼 Nacos/Nacos 便可進入 Nacos 首頁

如要關閉 Nacos，在 bin 目錄下執行命令 .\shutdown.cmd

0.7 版本之前的 Nacos 在單機模式時使用入式數據庫實現數據的存儲，不方便觀察數據存儲的基本情況，0.7 版本之後支持 MySQL 數據源能力，具體的操作步驟如下：

• 安裝 MySQL 數據庫（版本要求5.6.5+）

• 創建數據庫 nacos_config，在 conf 目錄下找到 mysql-schema.sql 初始化文件並進行初始化

• 修改 conf/applicationproperties 文件，增加 MySQL 數據源配置

  ### Count of DB:
  db.num=1
  ### Connect URL of DB:
  db.url.0=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
  db.user.0=root
  db.password.0=123
  

• 之後 Nacos 所有的數據都會保存到 MySQL

2. Nacos Server 集羣模式

Nacos 單機模式僅僅適用於測試和單機適用，生產環境大多適用集羣模式以確保高可用

接下來講解如何搭建 Nacso 集羣環境，具體步驟如下：

• 將下載的 Nacos 安裝包複製兩份，分別命名爲 Nacos-01，Nacos-02、Nacos-03，注意，集羣模式必須使用配置數據庫（如 MySQL）

• 修改 Nacos-02、Nacos-03 的配置文件 conf/applicationproperties，將服務啓動端口分別改爲 8850 和 8852

  #*************** Config Module Related Configurations ***************#
  ### If use MySQL as datasource:
  ### Deprecated configuration property, it is recommended to use `spring.sql.init.platform` replaced.
  spring.datasource.platform=mysql
  spring.sql.init.platform=mysql
  #*************** Spring Boot Related Configurations ***************#
  ### Default web context path:
  server.servlet.contextPath=/nacos
  ### Include message field
  server.error.include-message=ALWAYS
  ### Default web server port:
  server.port=8850
  

  注意：nacos 在 2.0 版本以後，除對外的端口外，還佔用另外三個端口：

  • raft port: ${server.port} - 1000
  • grpc port: ${server.port} + 1000
  • grpc port for server: ${server.port} + 1001

  假設對外端口爲 8848，即總共會有4個端口被佔用，分別爲 7848、8848、9848、9849，因此，在同一臺機啓動多個 nacos 節點時要注意避開所有佔用的端口

• 在 Nacos-01、Nacos-02、Nacos-03 的 conf 目錄下添加 cluster.conf 集羣配置文件

  ### 這裏簡單將3個nacos實例部署在同一個機器下
  # 
  127.0.0.1:8848
  127.0.0.1:8850
  127.0.0.1:8852
  

• 分別進入 Nacos-01、Nacos-02、Nacos-03 的 bin 目錄執行命令 .\startup.cmd，沒有參數默認就是集羣模式

3. Nacos+Nginx 集羣模式

在 Nginx 核心配置文件 nginx.conf 添加如下配置

server {
	listen       8847;
	server_name  localhost;

	location /nacos {
		proxy pass http://nacos-server/nacos;
	}

	upstream nacos-server {
		server 127.0.0.1:8848;
		server 127.0.0.1:8850;
		server 127.0.0.1:8852;
	}
}

啓動 Nginx，訪問：http://localhost:8847/nacos，至此我們完成 Nacos+Nginx 的搭建

SpringBoot 註冊到 Nacos

1. Nacos 配置管理

以 SpringBoot 2.3.12.RELEASE 爲例，在項目的 pom.xml 文件添加如下依賴：

<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-config-spring-boot-starter</artifactId>
    <version>0.2.12</version>
</dependency>

在 application.properties 中配置 Nacos Server 的地址

# 如果搭建了集羣只需要填其中一個節點的ip:port即可
nacos.config.server-addr=127.0.0.1:8848
# 如果配置了Nginx,則輸入配置的地址,如上面我配置的
# nacos.config.server-addr=127.0.0.1:8847/nacos

在啓動類中使用 @NacosPropertySource 加載 dataId 爲 springboot-nacos-config 的配置源，並開啓自動更新

@SpringBootApplication
@NacosPropertySource(dataId = "springboot-nacos-config", autoRefreshed = true)
public class SpringbootNacosApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootNacosApplication.class, args);
    }
}

當然，我們需要在 Nacos 的配置列表中添加 Data-Id: springboot-nacos-config 的配置文件

test.name=hahaha

通過 Nacos 的 @NacosValue 註解設置屬性值

@RestController("config")
public class ConfigCon {

    @NacosValue(value = "${test.name}", autoRefreshed = true)
    private String name;


    @GetMapping("get")
    public String get() {
        return name;
    }
}

2. Nacos 服務註冊

在項目的 pom.xml 文件添加如下依賴：

<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-discovery-spring-boot-starter</artifactId>
    <version>0.2.12</version>
</dependency>

在 application.properties 中配置 Nacos Server 的地址

spring.application.name=springboot-nacos
server.port=8080
server.address=127.0.0.1

# 如果搭建了集羣只需要填其中一個節點的ip:port即可
nacos.discovery.server-addr=127.0.0.1:8848
# 如果配置了Nginx,則輸入配置的地址,如上面我配置的
nacos.discovery.server-addr=127.0.0.1:8847/nacos

修改啓動類，運行即可

@SpringBootApplication
@NacosPropertySource(dataId = "springboot-nacos-config", autoRefreshed = true)
public class SpringbootNacosApplication implements CommandLineRunner {

    // 使用@NacosInjected注入Nacos的NamingService實例
    // NamingService是Nacos對外提供給使用者的接口
    @NacosInjected
    private NamingService namingService;

    @Value("${spring.application.name}")
    private String applicationName;

    @Value("${server.port}")
    private Integer serverPort;

    @Value("${server.address}")
    private String serverAddress;

    public static void main(String[] args) {
        SpringApplication.run(SpringbootNacosApplication.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        //應用啓動時，將服務註冊到Nacos
        namingService.registerInstance(applicationName, serverAddress, serverPort);
    }
}

Nacos SpringCloud

本節主要講解 SpringCloud 的如何通過 Nacos 實現配置管理和服務發現，以 SpringBoot 2.3.12.RELEASE 爲例

1. Nacos 配置管理

在項目的 pom.xml 文件添加如下依賴：

<dependencies>

    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>

</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>2.2.10-RC1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

在 application.properties 中配置 Nacos Server 的地址

server.port=8080
spring.application.name=springcloud-nacos

spring.cloud.nacos.config.server-addr=127.0.0.1:8848
# spring.cloud.nacos.config.server-addr=127.0.0.1:8847/nacos

spring.application.name 之後會構成 Nacos 配置管理 datald 字段的一部分，在 Nacos Spring Cloud中，datald 的完整格式如下：${prefix}-${spring.profile.active}.${file-extension}

• ${prefix}：默認爲 spring.application.name 的值，也可以通過 spring.cloud.Nacos.config.prefix 配置項來配置
• ${spring.profile.active}：當前環境對應的 profile，當 spring.profile.active 爲空時，對應的連接符 - 也將不存在，datald 的拼接格式變成 ${prefix}.${file-extension}
• ${file-extension}：配置內容的數據格式，可以通過 `spring.cloud.Nacos.config.file-extension· 來配置 properties 或 yaml 類型

在 Nacos 配置列表中創建 springcloud-nacos.properties 配置文件

test.name=hahah

開發 Controller 獲取配置

@RefreshScope
@RestController("config")
public class ConfigCon {

    @Value("${test.name}")
    private String name;

    @GetMapping("get")
    public String get() {
        return name;
    }
}

2. Nacos 服務註冊

在項目的 pom.xml 文件添加如下依賴：

<dependencies>

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

</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>2.2.10-RC1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

在 application.properties 中配置 Nacos Server 的地址

server.port=8080
spring.application.name=springcloud-nacos

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8847/nacos

在啓動類上添加 @EnableDiscoveryClient 註解開啓服務註冊發現功能

@EnableDiscoveryClient
@SpringBootApplication
public class SpringcloudNacosApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringcloudNacosApplication.class, args);
    }
}

在 Nacos 管理頁面查看服務列表，發現服務已經註冊到 Nacos，服務提供端和消費端都用這種方式進行註冊，之後消費端可直接通過服務名直接調用提供端的接口