Spring Cloud 注册中心 Nacos 安装与使用指南

如果第一次使用，未安装 unzip 命令，需要安装一下 apt-get install unzip

解压后目录与 windows 版相同。

2.3.2 单机模式启动

进入 nacos/bin 目录，输入命令：

bash startup.sh -m standalone

上述命令为 Ubuntu 系统的命令 nacos 安装前需要先安装 JDK CentOS 使用：sh startup.sh -m standalone

启动成功后，访问 Nacos 链接：http://IP:port/nacos

Nacos 快速上手

Nacos 是 Spring Cloud Alibaba 的组件，Spring Cloud Alibaba 遵循 Spring Cloud 中定义的服务注册、服务发现规范。因此使用 Nacos 和使用 Eureka 对于微服务来说，并没有太大区别。 主要差异在于：

• Eureka 需要自己搭建一个服务，Nacos 不用自己搭建服务，组件已经准备好了，只需启动即可。
• 对应依赖和配置不同

3.1 服务注册/服务发现

Nacos 的服务注册和服务发现代码一样。

引入 Spring Cloud Alibaba 依赖，在父工程的 pom 文件中引入：

<properties>
    <spring-cloud-alibaba.version>2022.0.0.0-RC2</spring-cloud-alibaba.version>
</properties>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
    <version>${spring-cloud-alibaba.version}</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

注意：Spring Boot 和 Spring Cloud 的版本是有一定对应关系的。Spring Cloud Alibaba 也遵循 Spring Cloud 的标准，在引入依赖时，一定要确认各个版本的对应关系。Spring Cloud Alibaba 和 Spring Cloud 版本对应关系，参考官方文档：https://sca.aliyun.com/zh-cn/docs/2022.0.0.0/overview/version-explain/ 版本在一定范围内可以自由选择

引入 Nacos 依赖：

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

引入 Load Balance 依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-loadbalancer</artifactId>
</dependency>

3.2 配置 Nacos 地址

文章中使用本地服务器地址。

spring:
  application:
    name: product-service
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

3.3 远程调用

1. 修改 IP 为项目名

public OrderInfo selectOrderById(Integer orderId){
    OrderInfo orderInfo = orderMapper.selectOrderById(orderId);
    String url = "http://product-service/product/" + orderInfo.getProductId();
    ProductInfo productInfo = restTemplate.getForObject(url, ProductInfo.class);
    orderInfo.setProductInfo(productInfo);
    return orderInfo;
}

2. 为 restTemplate 添加负载均衡注解 @LoadBalanced

@Configuration
public class BeanConfig {
    @Bean
    @LoadBalanced
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }
}

3.4 启动服务

启动两个服务，观察 Nacos 的管理界面，发现 order-service 和 product-service 都注册在 Nacos 上了。

3.5 启动多个服务，测试负载均衡

启动三个 product-service 服务。

观察 Nacos 控制台：

Nacos 负载均衡

生产环境相对是比较恶劣的，我们需要对服务的流量进行更加精细的控制。Nacos 支持多种负载均衡策略，包括权重、同机房、同地域、同环境等。

4.1 服务下线

当某一个节点上接口的性能较差时，我们可以第一时间对该节点进行下线。 操作步骤：服务详情 -> 下线。

点击下线后，再次请求接口，会发现该服务没有请求进来了。 再次单击上线，该节点会继续收到请求。

4.2 权重配置

除了下线之外，我们也可以配置这个节点的流量权重。

4.2.1 配置权重

操作步骤：找到对应节点 -> 编辑 -> 在弹出的窗口修改权重值。 每个节点默认权重为 1，修改为 0.1。

4.2.2 开启 Nacos 负载均衡策略

由于 Spring Cloud LoadBalance 组件自身有负载均衡配置方式，所以不支持 Nacos 的权重属性配置。我们需要开启 Nacos 的负载均衡策略，让权重配置生效。

# 开启 nacos 的负载均衡策略
spring.cloud.loadbalancer.nacos.enabled=true
spring:
  cloud:
    loadbalancer:
      nacos:
        enabled: true

4.2.3 测试权重配置

启动服务，访问多次接口，观察结果，会发现 9091 端口号的实例接收的请求明显比另外两个实例少。

整体流量生效，局部流量不是严格按照设置的比例进行分配的

4.2.4 常见问题

修改权重时，可能会报错：

报错信息：caused: errCode: 500, errMsg: do metadata operation failed ;caused:com.alibaba.nacos.consistency.exception.ConsistencyException: The Raft Group[naming_instance_metadata] did not find the Leader node...

原因：Nacos 采用 raft 算法来计算 Leader，并且会记录前一次启动的集群地址，当服务器 IP 改变时会导致 raft 记录的集群地址失效，导致选 Leader 出现问题。(网络环境发生变化时，IP 地址也会发生变化) 解决办法：删除 Nacos 根目录下 data 文件夹下的 protocol 文件夹即可。

4.3 同集群优先访问

Nacos 把同一个机房内的实例，划分为一个集群。所以同集群优先访问，在一定程度上也可以理解为同机房优先访问。 微服务架构中，一个服务通常有多个实例共同提供服务，这些实例可以部署在不同的机器上，这些机器可以分布在不同的机房。

微服务访问时，应尽量访问同机房的实例。当本机房内实例不可用时，才访问其他机房的实例。通常情况下，因为同一个机房的机器属于一个局域网，局域网访问速度更快一点。

4.3.1 给实例配置集群名称

1. 为 product-service 配置名称

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 110.41.51.65:10020
        cluster-name: SH # 集群名称：上海集群

重启服务，观察 Nacos 控制台，SH 集群下多了一个实例。

复制 product-service 启动配置，添加 VM Option。 设置 9091 端口号的实例，机房为 BJ：

-Dserver.port=9091 -Dspring.cloud.nacos.discovery.cluster-name=BJ

设置 9092 端口号的实例，机房为 BJ：

-Dserver.port=9092 -Dspring.cloud.nacos.discovery.cluster-name=BJ

观察 Nacos，BJ 集群下多了一个实例。

2. 为 order-service 配置集群名称：SH

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 110.41.51.65:10020
        cluster-name: SH # 集群名称：上海集群

4.3.2 开启 Nacos 负载均衡策略

同权重配置：

# 开启 nacos 的负载均衡策略
spring.cloud.loadbalancer.nacos.enabled=true
spring:
  cloud:
    loadbalancer:
      nacos:
        enabled: true

4.3.3 测试

启动服务。

1. 对接口访问多次，观察日志，会发现只有 9090 端口的实例收到了请求 (同集群)。
2. 把 9090 端口的实例进行下线 (SH 集群)，再次访问接口，观察日志，发现 9091 端口和 9092 端口的实例收到了请求。

Nacos 健康检查

5.1 两种健康检查机制

Nacos 作为注册中心，需要感知服务的健康状态，才能为服务调用方提供良好的服务。Nacos 中提供了两种健康检查机制：

客户端主动上报机制：

• 客户端通过心跳上报方式告知服务端 (nacos 注册中心) 健康状态，默认心跳间隔 5 秒；
• nacos 会在超过 15 秒未收到心跳后将实例设置为不健康状态，超过 30 秒将实例删除；

服务器端反向探测机制：

• nacos 主动探知客户端健康状态，默认间隔为 20 秒。
• 健康检查失败后实例会被标记为不健康，不会被立即删除。

比如领导管理员工的工作

1. 员工主动汇报：员工每天主动汇报自己工作进度
2. 领导主动问询：领导每周向员工了解工作进度

Nacos 中的健康检查机制不能主动设置，健康检查机制是和 Nacos 的服务实例类型强相关的。

5.2 Nacos 服务实例类

Nacos 的服务实例 (注册的节点) 分为临时实例和非临时实例。

• 临时实例：如果实例宕机超过一定时间，会从服务列表剔除，默认类型。
• 非临时实例：如果实例宕机，不会从服务列表剔除，也可以叫永久实例。

Nacos 对临时实例，采取的是 客户端主动上报机制，对非临时实例，采取服务器端反向探测机制。

配置一个服务实例为永久实例：

spring:
  cloud:
    nacos:
      discovery:
        ephemeral: false # 设置为非临时实例

重启服务，观察 Nacos 控制台。 停止服务，再观察控制台：节点依然不会消失。

5.3 常见问题

5.3.1 Nacos 服务实例类型不允许改变

设置服务实例类型，重新启动 Nacos 可能会报错。 原因：Nacos 会记录每个服务实例的 IP 和端口号，当发现 IP 和端口都没有发生变化时，Nacos 不允许一个服务实例类型发生变化，比如从临时实例，变为非临时实例，或非临时实例，变成临时实例。

解决办法：

1. 停掉 nacos
2. 删除 nacos 目录下 /data/protocol/raft 信息，里面会保存应用实例的元数据信息。

Nacos 环境隔离

企业开发中，一个服务会分为开发环境，测试环境和生产环境。

1. 开发环境：开发人员用于开发的服务器，是最基础的环境。一般日志级别设置较低，可能会开启一些调试信息。
2. 测试环境：测试人员用来进行测试的服务器，是开发环境到生产环境的过渡环境。
3. 生产环境：正式提供对外服务的环境，通常关掉调试信息。

通常情况下，这几个环境是不能互相通信的。Nacos 提供了 namespace(命名空间) 来实现环境的隔离。不同的 namespace 的服务不可见。

6.1 创建 Namespace

默认情况下，所有服务都在同一个 namespace，名为 public。 点击左侧命名空间，可以对 namespace 进行操作。 新增命名空间。

6.2 配置 namespace

namespace 创建完成后，对服务进行配置。

修改 order-service 的命名空间：

spring:
  cloud:
    nacos:
      discovery:
        namespace: 51152a13-7911-49e3-bbdc-16fd5670a257

6.3 测试远程调用

1. 启动服务，观察 Nacos 控制台 public 命名空间下只有 product-service 服务。 order-service 在 dev 命名空间下。

2. 访问接口，测试远程调用。

3. 修改 product-service 的一个实例，命名空间改为 dev：

spring:
  cloud:
    nacos:
      discovery:
        namespace: 51152a13-7911-49e3-bbdc-16fd5670a257

4. 启动服务 观察 Nacos 控制台。 再次访问接口 http://127.0.0.1:8080/order/3，发现远程调用成功。

Nacos 配置中心

除了注册中心和负载均衡之外，Nacos 还是一个配置中心，具备配置管理的功能。Namespace 的常用场景之一是不同环境的配置区分隔离。例如开发测试环境和生产环境的配置隔离。

7.1 为什么需要配置中心

当前项目的配置都在代码中，会存在以下问题：

1. 配置文件修改时，服务需要重新部署。微服务架构中，一个服务可能有成百个实例，挨个部署比较麻烦，且容易出错。
2. 多人开发时，配置文件可能需要经常修改，使用同一个配置文件容易冲突。

配置中心就是对这些配置项进行统一管理。通过配置中心，可以集中查看、修改和删除配置，无需再逐个修改配置文件。提高效率的同时，也降低了出错的风险。

1. 服务启动时，从配置中心读取配置项的内容，进行初始化。
2. 配置项修改时，通知微服务，实现配置的更新加载。

7.2 快速上手

通过以下操作，我们先来感受下 Nacos 配置中心的使用。 参考文档：https://nacos.io/docs/next/ecology/use-nacos-with-spring-cloud/

7.2.1 添加配置

在 Nacos 控制台添加配置项。 新建配置项。 配置内容：

nacos.test.num=5

说明：

1. Data ID 设置为项目名称
2. 配置内容的数据格式，目前只支持 properties 和 yaml 类型
3. 设置配置内容

7.2.2 获取配置

1. 引入 Nacos Config 依赖：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<!-- SpringCloud2020.*之后版本需要引入 bootstrap-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>

2. 配置 bootstrap.properties 微服务启动前，需要先获取 nacos 中配置，并与 application.yml 配置合并。在微服务运行之前，Nacos 要求必须使用 bootstrap.properties 配置文件来配置 Nacos Server 地址。

spring.application.name=product-service
spring.cloud.nacos.config.server-addr=110.41.51.65:10020

或者使用 bootstrap.yml：

spring:
  application:
    name: product-service
  cloud:
    nacos:
      config:
        server-addr: 110.41.51.65:10020

spring.application.name 需要和 nacos 配置管理的 Data ID 一致。 spring.cloud.nacos.config.server-addr 为 Nacos Server 的地址。

配置中心和注册中心的配置是隔离的 Nacos 配置中心：spring.cloud.nacos.config.server-addr Nacos 注册中心：spring.cloud.nacos.discovery.server-addr

3. 编写程序

@RequestMapping("/config")
@RefreshScope
@RestController
public class NacosController {
    @Value("${nacos.test.num:0}")
    private Integer nacosNum;

    @RequestMapping("/get")
    public Integer get(){
        return nacosNum;
    }
}

• @Value 读取配置
• @RefreshScope 配置进行热更新

4. 测试 启动程序，访问接口：http://127.0.0.1:9090/config/get

7.2.3 常见问题

1. 读取不到配置项 可能原因：

• 配置错误：检查配置 Data ID, 配置格式，配置空间等
• 未引入依赖

2. No spring.config.import property has been defined 原因：bootstrap.properties 是系统级的资源配置文件，用于程序执行更加早期配置信息读取。但是 SpringCloud 2020.* 之后的版本把 bootstrap 禁用了，导致在读取文件的时候读取不到而报错，所以需要重新导入 bootstrap 包进来就可以了。

7.3 配置中心详解

7.3.1 设置命名空间

Nacos 配置管理的命名空间和服务列表的命名空间是分别设置的。默认是 public。 Nacos 命名空间配置依然在 bootstrap.properties 中进行配置。

spring.cloud.nacos.config.namespace=51152a13-7911-49e3-bbdc-16fd5670a257

对应 bootstrap.yml 配置：

spring:
  cloud:
    nacos:
      config:
        namespace: 51152a13-7911-49e3-bbdc-16fd5670a257

value 对应 命名空间的 ID。 如果设置命名空间后，项目启动时，会从该命名空间下找对应的配置项。

7.3.2 Data Id

Data Id 格式介绍 在 Nacos Spring Cloud 中，dataId 的完整格式如下： ${prefix}-${spring.profiles.active}.${file-extension}

• prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix 来配置。
• spring.profiles.active 即为当前环境对应的 profile。当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 ${prefix}.{file-extension}。
• file-extension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。默认为 properties。

微服务启动时，会从 Nacos 读取多个配置文件：

1. ${prefix}-${spring.profiles.active}.${file-extension} 如：product-servicedev.properties
2. ${prefix}.${file-extension} , 如：product-service.properties
3. ${prefix} 如 product-service

${spring.application.name}, ${spring.profiles.active} 等通过配置文件来指定时，必须放 bootstrap.properties 文件中。

在 bootstrap.yml 中添加 spring.profiles.active 值：

spring:
  profiles:
    active: dev

三个文件的优先级为：product-service-dev.properties > product-service.properties > product-service。 也就是说 接口：http://127.0.0.1:9090/config/get 会以上面的优先级顺序读取对应文件中的值。

Nacos 与 Eureka 的区别

共同点：

• 都支持服务注册和服务拉取

区别：

1. 功能 Nacos 除了服务发现和注册之外，还提供了配置中心、流量管理和 DNS 服务等功能。
2. CAP 理论 Eureka 遵循 AP 原则，Nacos 可以切换 AP 和 CP 模式，默认 AP。 Nacos 根据配置识别 CP 或者 AP 模式。如果注册 Nacos 的 Client 的节点是临时节点，那么 Nacos 对这个 Client 节点的效果就是 AP，反之是 CP。AP 和 CP 可以同时混合存在。
3. 服务发现 Eureka：基于拉模式。Eureka Client 会定期从 Server 拉取服务信息，有缓存，默认每 30 秒拉取一次。 Nacos：基于推送模式。服务列表有变化时实时推送给订阅者，服务端和客户端保持心跳连接。

总结

本文介绍了 Nacos 作为注册中心与配置中心的核心功能及实践方法。