“

摘要: 原创出处 http://www.iocoder.cn/Spring-Boot/registry-nacos/ 「芋道源码」欢迎转载，保留摘要，谢谢！

  • 1. 概述
  • 2. 注册中心原理
  • 3. 快速入门
  • 666. 彩蛋
“

本文在提供完整代码示例，可见 https://github.com/YunaiV/SpringBoot-Labs 的 lab-44 目录。

原创不易，给点个 Star 嘿，一起冲鸭！

1. 概述

在《Nacos 极简入门》中，我们已经学习了如何搭建一个 Nacos 服务。如果还没有的胖友，赶紧先去简单学习下，重点是跟着该文「2. 单机部署」小节，自己搭建一个 Nacos 服务。

本文，我们来学习下如何在 Spring Boot 中，将 Nacos 作为一个注册中心，实现分布式环境下的服务注册与发现。

“

友情提示：对 Nacos 作为配置中心感兴趣的胖友，可以看看《芋道 Spring Boot 配置中心 Nacos 入门》文章。

2. 注册中心原理

在使用注册中心时，一共有三种角色：服务提供者（Service Provider）、服务消费者（Service Consumer）、注册中心（Registry）。

“

在一些文章中，服务提供者被称为 Server，服务消费者被称为 Client。胖友们知道即可。

三个角色交互如下图所示：图片

  • Provider：

    • 启动时，向 Registry 注册自己为一个服务（Service）的实例（Instance）。
    • 同时，定期向 Registry 发送心跳，告诉自己还存活。
    • 关闭时，向 Registry 取消注册。

  • Consumer：

    • 启动时，向 Registry 订阅使用到的服务，并缓存服务的实例列表在内存中。
    • 后续，Consumer 向对应服务的 Provider 发起调用时，从内存中的该服务的实例列表选择一个，进行远程调用。
    • 关闭时，向 Registry 取消订阅。

  • Registry：

    • Provider 超过一定时间未心跳时，从服务的实例列表移除。
    • 服务的实例列表发生变化（新增或者移除）时，通知订阅该服务的 Consumer，从而让 Consumer 能够刷新本地缓存。

当然，不同的注册中心可能在实现原理上会略有差异。例如说，Eureka 注册中心，并不提供通知功能，而是 Eureka Client 自己定期轮询，实现本地缓存的更新。

另外，Provider 和 Consumer 是角色上的定义，一个服务同时即可以是 Provider 也可以作为 Consumer。例如说，优惠劵服务可以给订单服务提供接口，同时又调用用户服务提供的接口。

3. 快速入门

“

示例代码对应仓库：lab-44-nacos-discovery-demo。

本小节，我们来搭建一个 Spring Boot 示例，注册到 Nacos 服务器上。

3.1 引入依赖

在 pom.xml 文件中，引入相关依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>lab-44-nacos-discovery-demo</artifactId>

    <dependencies>
        <!-- 实现对 SpringMVC 的自动化配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- 实现对 Nacos 作为注册中心的自动化配置 -->
        <dependency>
            <groupId>com.alibaba.boot</groupId>
            <artifactId>nacos-discovery-spring-boot-starter</artifactId>
            <version>0.2.4</version>
        </dependency>
    </dependencies>

</project>
  • 重点是引入 nacos-discovery-spring-boot-starter 依赖，实现对 Nacos 作为注册中心的自动化配置。

3.2 配置文件

在 application.yml 中，添加 Nacos 配置，如下：

spring:
  application:
    name: demo-application # 应用名

nacos:
  # Nacos 配置中心的配置项，对应 NacosDiscoveryProperties 配置类
  discovery:
    server-addr: 127.0.0.1:18848 # Nacos 服务器地址
    auto-register: true # 是否自动注册到 Nacos 中。默认为 false。
    namespace: # 使用的 Nacos 的命名空间，默认为 null。
    register:
      service-name: ${spring.application.name} # 注册到 Nacos 的服务名
      group-name: DEFAULT_GROUP # 使用的 Nacos 服务分组，默认为 DEFAULT_GROUP。
      cluster-name: # 集群名，默认为空。

spring.application.name 配置项，应用名。默认情况下，如果我们不设置 nacos.discovery.register.service-name 配置项，Spring Boot 注册到 Nacos 的服务名为它。

nacos.discovery 配置项，为 Nacos 作为注册中心的配置，对应 NacosDiscoveryProperties 配置类。