关于Springcloud Alibaba Nacos服务注册和配置中心的使用小结

刺骨的言语ヽ痛彻心扉 2022-10-28 14:27 45阅读 0赞

**目录**

1. SpringCloud Alibaba概述

2. Nacos概述

2.1 Nacos简介

2.2 Nacos安装配置

3. Nacos作为服务注册中心的案例

3.1 基于Nacos的服务提供者

3.2 基于Nacos的服务消费者

3.3 服务注册中心对比

3.4 Nacos支持AP和CP模式的切换

4. Nacos作为服务配置中心的案例

4.1 服务中心配置

4.2 Nacos匹配规则

4.3 案例测试

4.4 Nacos分类配置

--------------------

# 1. SpringCloud Alibaba概述 #

> Spring Cloud Alibaba 致力于提供微服务开发的一站式解决方案。此项目包含开发分布式应用微服务的必需组件，方便开发者通过 Spring Cloud 编程模型轻松使用这些组件来开发分布式应用服务。

依托 [Spring Cloud Alibaba][]，只需要添加一些注解和少量配置就可以将 Spring Cloud 应用接入阿里微服务解决方案，通过阿里中间件来迅速搭建分布式应用系统。

上面的官网链接首页大概讲述了SpringCloud Alibaba的**主要功能、组件**。以下是我对于**SpringCloud Alibaba Nacos**使用过程的一些小结。

# 2. Nacos概述 #

## 2.1 Nacos简介 ##

[Nacos][]（Dynamic Naming and Configuration Service），作为一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台，简单来说就是Nacos就是注册中心 + 配置中心的组合（Eureka + Config + Bus）。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70][]

## 2.2 Nacos安装配置 ##

前提是已经安装了java8和maven。

1) 下载[Nacos][Nacos 1]的nacos-server-1.1.4.zip。

2) 解压安装包，然后直接运行bin目录下的startup.cmd。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 1][]

3) 访问Nacos（localhost:8848/nacos）。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 2][]

# 3. Nacos作为服务注册中心的案例 #

以下案例代码的[Github地址][Github]。

三个modules分别是：cloudalibaba-provider-payment9001，cloudalibaba-provider-payment9002，cloudalibaba-consumer-nacos-order83。

## 3.1 基于Nacos的服务提供者 ##

1) 父pom添加SpringCloud Alibaba依赖。

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

2) cloudalibaba-provider-payment9001添加Nacos依赖。

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

3) 配置Nacos。

server:
      port: 9001
    
    spring:
      application:
        name: nacos-payment-provider
      cloud:
        nacos:
          discovery:
            server-addr: localhost:8848 #配置Nacos地址
    
    management:
      endpoints:
        web:
          exposure:
            include: '*'

4) 添加接口：

@GetMapping(value = "/payment/nacos/{id}")
    public String getPayment(@PathVariable("id") Integer id) {
    	return "Hello Nacos Discovery: " + serverPort + "\t id: " + id;
    }

5) 同样的操作创建cloudalibaba-provider-payment9002（注意修改application.yml的端口为9002）。

6) 案例测试：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 3][]

7) 访问Nacos（localhost:8848/nacos/\#/serviceManagement?dataId=&group=&appName=&namespace=）。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 4][]

## 3.2 基于Nacos的服务消费者 ##

1) cloudalibaba-consumer-nacos-order83添加Nacos依赖。

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

2) 配置Nacos。

server:
      port: 83
    
    spring:
      application:
        name: nacos-order-consumer
      cloud:
        nacos:
          discovery:
            server-addr: localhost:8848 #配置Nacos地址
    
    #消费者将去访问的微服务名称（注册成功进nacos的微服务提供者）
    service-url:
      nacos-user-service: http://nacos-payment-provider

3) 添加接口：

@GetMapping(value = "/consumer/payment/nacos/{id}")
    public String paymentInfo(@PathVariable("id") Integer id) {
    	return restTemplate.getForObject(serverURL + "/payment/nacos/" + id,String.class);
    }

4) 案例测试（RestTemplate加上了@LoadBalanced，集成了ribbon的负载均衡）。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 5][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 6][]

## 3.3 服务注册中心对比 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 7][]

## 3.4 Nacos支持AP和CP模式的切换 ##

一般来说，如果不需要存储服务级别的信息且通过nacos-client注册，并能够保持心跳上报那么就可以选择AP。

如果需要在服务级别编辑或存储配置信息，那么CP是必须的，CP模式下支持注册持久化实例，此时则是以Raft协议为集群运行模式，该模式下注册实例前必须先注册服务，如果服务不存在则会返回错误。

# 4. Nacos作为服务配置中心的案例 #

以下案例代码的[Github地址][Github]。

这个modules是：cloudalibaba-config-nacos-client3377。

## 4.1 服务中心配置 ##

1) 添加Nacos config依赖。

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

2) 配置bootstrap.yml

server:
      port: 3377
    
    spring:
      application:
        name: nacos-config-client
      cloud:
        nacos:
          discovery:
            server-addr: localhost:8848 #Nacos服务注册中心地址
          config:
            server-addr: localhost:8848 #Nacos作为配置中心地址
            file-extension: yaml #指定yaml格式配置

3) 配置application.yml

spring:
      profiles:
        active: dev #表示开发环境

4) 配置动态刷新的接口：

@RestController
    @RefreshScope // 支持Nacos的动态刷新功能
    public class ConfigClientController {
    
        @Value("${config.info}")
        private String configInfo;
    
        @GetMapping("/config/info")
        public String getConfigInfo() {
            return configInfo;
        }
    }

## 4.2 Nacos匹配规则 ##

1) Nacos界面配置信息。

> $\{spring.application.name\}-$\{spring.profile.active\}.$\{file-extension\}

*  prefix默认为spring.application.name的值。
 *  spring.profile.active即为当前环境对应的profile，可以通过配置项 spring.profile.active来配置。
 *  file-exetension为配置内容的数据格式，可以通过配置项spring.cloud.nacos.config.file-extension来配置。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 8][]

2）进入[Nacos][Nacos 2]控制台新建配置(nacos-config-client-dev.**yaml**)。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 9][]

*  nacos-config-client-dev.yaml
 *  config:  
      info: this is my Springcloud config test version 1.0.

注：Data ID 的后缀是**yaml**。

## 4.3 案例测试 ##

启动前需要在nacos客户端-配置管理-配置管理栏目下有对应的yaml配置文件。

1) 访问接口（localhost:3377/config/info）。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 10][]

2) 修改config信息（version改成2.0）。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 11][]

3) 访问接口，信配置息已经刷新了。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 12][]

## 4.4 Nacos分类配置 ##

最外面的namespace是可以用于区分部署环境的，Group和DataID逻辑上区分两个目标对象。

默认情况下，Namespace=public ，Group=DEFAULT\_GROUP。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 13][]

1) DataID的案例（**指定spring.profile.active和配置文件的DataID来使不同环境下读取不同的配置**）。

*  新建DataID。
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 14][]
 *  nacos-config-client-test.yaml
 *  config:  
      info: this is my Springcloud config(nacos-config-client-test.yaml) test version 1.0.
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 15][]
 *  通过spring.profile.active属性就能进行多环境下配置文件的读取。
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 16][]
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 17][]

2) Group的案例（通过Group实现环境区别）。

*  新建DataID：nacos-config-client-info.yaml(Group=DEV\_GROUP)，nacos-config-client-info.yaml(Group=TEST\_GROUP)
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 18][]
 *  在config下增加一条group的配置即可，可配置为DEV\_GROUP或TEST\_GROUP。
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 19][]
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 20][]

3) Namespace的案例。

*  新建dev/test的Namespace。
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 21][]
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 22][]
 *  在dev的namespace下创建配置信息。
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 23][]
 *  修改bootstrap.yml添加namespace配置。
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 24][]
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 25][]

**附**：

1) 要部署Nacos集群可以参考：[Nacos集群部署][Nacos 3]。

[Spring Cloud Alibaba]: https://github.com/alibaba/spring-cloud-alibaba/blob/master/README-zh.md
[Nacos]: https://github.com/alibaba/Nacos
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70]: /images/20221024/d51525b9103b4972819b44bea9c5b8d0.png
[Nacos 1]: https://github.com/alibaba/nacos/releases/tag/1.1.4
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 1]: /images/20221024/f46013e205334a15a92c08dc27039442.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 2]: /images/20221024/cd7f1e3d2bcc4207913bcc6f941951c6.png
[Github]: https://github.com/BAStriver/springcloud-test
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 3]: /images/20221024/2d29ccb6d9854beeb9759ca28386aef2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 4]: /images/20221024/be930956cb25424a8f5ee51d2a9a7538.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 5]: /images/20221024/eb6bc294752b460f9112989387dbc77c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 6]: /images/20221024/6cc828613f3341dd8a48cca319927067.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 7]: /images/20221024/b192b428bb1d41669ad305c76f86ac0b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 8]: /images/20221024/d8e4a861ef9a4937b89310b725a7ebe7.png
[Nacos 2]: http://localhost:8848/nacos/#/newconfig?serverId=center&namespace=&edasAppName=&edasAppId=&searchDataId=&searchGroup=
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 9]: /images/20221024/c369927418cb4ac1ae6dcc7017fb056c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 10]: /images/20221024/87538cc3baa84f47accc8d2b2b237be0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 11]: /images/20221024/b08d967c60664060b35f4cdc35d11729.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 12]: /images/20221024/5af28e31e0f041d1950b98ebdcb2b2eb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 13]: /images/20221024/c1a8be0c6521492db8dff8891301e662.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 14]: /images/20221024/e2c07394b8604ef6b5e93c03a343ba6e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 15]: /images/20221024/db255db4480e492baa8bc98969fc95ce.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 16]: /images/20221024/5df8295ddbe34cef9e62ed3dacfca102.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 17]: /images/20221024/7ac18eccec7f4e2caf968fdd06580c96.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 18]: /images/20221024/a4af519891064bb386ef685d61beda7b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 19]: /images/20221024/43391069a0a24446830b1e018ef9fd63.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 20]: /images/20221024/d79f20bd60fc4456803cbd5392a5d433.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 21]: /images/20221024/a713bff325604399bdb73bf35bcf2f89.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 22]: /images/20221024/8edbc12aab9b44078a27b7b350cbc5d2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 23]: /images/20221024/55c6bfb0a905409c801a29535e7559d6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 24]: /images/20221024/d38ee00f95f041eea652681620d1dd91.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBU3RyaXZlcg_size_16_color_FFFFFF_t_70 25]: /images/20221024/90938eee50ed4119b5d871ec16d09243.png
[Nacos 3]: https://nacos.io/zh-cn/docs/cluster-mode-quick-start.html