Nacos学习笔记（二）：服务注册源码分析

最新推荐文章于 2023-02-22 09:20:38 发布

你可以叫我仔哥呀

最新推荐文章于 2023-02-22 09:20:38 发布

阅读量427

点赞数

分类专栏：从0开始学Nacos 文章标签：学习 java spring cloud

本文链接：https://blog.csdn.net/weixin_37624903/article/details/128255686

版权

从0开始学Nacos 专栏收录该内容

5 篇文章 1 订阅

订阅专栏

一、前言

在上一篇文章中笔者对Nacos做了一个简单的介绍，今天将对Nacos中的注册流程进行分析。

二、微服务注册中心

我们知道Nacos可以作为微服务的注册中心，用于服务的治理。所谓的注册说白了就是微服务的将信息存储在Nacos中，由Nacos来维护信息。接下来我们搭建一个最简单的Springboot项目作为Demo进行服务的注册（当然了，也可以直接调用API接口进行注册，只不过这样注册的节点由于没有心跳，在一段时间后会被踢出，这放到后面讲）
1、POM文件

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>learn-nacos</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>learn-nacos</name>
  <description>Demo project for Spring Boot</description>

  <properties>
    <java.version>1.8</java.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
    <spring-cloud-alibaba.version>2.2.2.RELEASE</spring-cloud-alibaba.version>
  </properties>

  <dependencies>
    <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-config</artifactId>
    </dependency>
    <dependency>
      <groupId>com.alibaba.cloud</groupId>
      <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
      <exclusions>
        <exclusion>
          <groupId>org.junit.vintage</groupId>
          <artifactId>junit-vintage-engine</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
  </dependencies>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-dependencies</artifactId>
        <version>${spring-boot.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
      <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>
    </dependencies>
  </dependencyManagement>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.1</version>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
          <encoding>UTF-8</encoding>
        </configuration>
      </plugin>
        <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <version>2.3.7.RELEASE</version>
        <configuration>
        <mainClass>com.example.learnnacos.LearnNacosApplication</mainClass>
        </configuration>
        <executions>
        <execution>
        <id>repackage</id>
        <goals>
        <goal>repackage</goal>
        </goals>
        </execution>
        </executions>
        </plugin>
        </plugins>
        </build>

        </project>

2、配置文件

# 应用名称
spring.application.name=learn-nacos
# 应用服务 WEB 访问端口
server.port=8080
# Nacos认证信息
spring.cloud.nacos.discovery.username=nacos
spring.cloud.nacos.discovery.password=nacos
# Nacos 服务发现与注册配置，其中子属性 server-addr 指定 Nacos 服务器主机和端口
spring.cloud.nacos.discovery.server-addr=localhost:8848
# 注册到 nacos 的指定 namespace，默认为 public
spring.cloud.nacos.discovery.namespace=public
spring.cloud.nacos.config.timeout=300000

3、启动服务，在Nacos中观察是否注册成功；可以看到learn-nacos项目成功的注册到了Nacos

三、注册源码分析

通过官网我们可以得知，服务注册到Nacos的接口为 POST http://ip:8848/nacos/v1/ns/instance。我们在源码中找到对应的接口（这里吐槽一下，确实不太好找，笔者是通过全局搜索搜到对应的字符串，才找到接口）
接口位于com.alibaba.nacos.naming.controllers.InstanceController中，这个Controller定义了对Instance（服务实例）的增删改查操作。这里我们找到注册的接口，源码如下

在源码分析之前我们先回顾一下Nacos的数据模型，如下图，最外层是Namespace（命名空间）、接着是Group（分组）、最后是Service

源码分析：
1、首先Nacos收到请求的时候会确认服务要注册的Namespace，默认是注册到Public命名空间。（这一点也可以从上面Nacos后台截图中看出来）
2、接着获取服务名并校验服务名是否合法（具体规则可以参考官网），这个参数也是由要注册的服务自己提供的，没太多说的。
3、构建实例，一个实例就是一个微服务（本文就是learn-nacos服务），简单的来说就是用服务提供的信息来创建一个Instance对象。

4、注册到Nacos中：这一步是重点
getInstanceOperator().registerInstance(namespaceId, serviceName, instance);进入registerInstance方法

从这个方法的注释中我们可以大致了解该方法的作用：创建一个基于IP和端口号的客户端。前面几个步骤没太多说的；这里就有一点可能不太好理解，“是否为临时节点”（短暂节点）；所谓的短暂节点就是服务不会被持久化，Nacos通过心跳机制来维护这一服务，如果没收到心跳则会踢出。这里比较重要的就2个点，创建服务+注册服务；
创建服务：还记得上面的数据模型吗？这个方法就是决定服务是出于那个group中。

注册服务：

前面的代码就是做一些注册前的校验，addServiceInstance方法才是注册的逻辑。

这里的代码也很好理解，直接将服务添加到publishers中；publishers是一个ConcurrentHashMap，这一点和Spring中的IOC容器非常相似。