Nacos使用和注册部分源码介绍

Nacos简单介绍

Nacos致力于帮助您发现、配置和管理微服务。Nacos提供了一组简单易用的特性集,帮助您快速实现动态服务发现、服务配置、服务元数据及流量管理。Nacos帮助您更敏捷和容易地构建、交付和管理微服务平台。Nacos是构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施。
接下来主要介绍Nacos作为注册中心的使用和注册部分的源码解析。

Nacos安装

Nacos预装环境

Nacos 依赖 Java 环境来运行。如果您是从代码开始构建并运行Nacos,还需要为此配置 Maven环境这里就不介绍Maven和Java安装,大家自行安装一下。

安装的方式主要有两种:
  1. 从GitHub上下载源码安装:
//下载源码的地址
git clone https://github.com/alibaba/nacos.git
cd nacos/
//编译源码
mvn -Prelease-nacos -Dmaven.test.skip=true clean install -U  
ls -al distribution/target/
//进入编译包
cd distribution/target/nacos-server-$version/nacos/bin

2.下载安装包的形式:

tar -xvf nacos-server-$version.tar.gz
cd nacos/bin
启动服务器

启动命令(standalone代表着单机模式运行,非集群模式):

sh startup.sh -m standalone
关闭服务器
sh shutdown.sh
单机环境下使用Mysql:

在0.7版本之前,在单机模式时nacos使用嵌入式数据库实现数据的存储,不方便观察数据存储的基本情况。0.7版本增加了支持mysql数据源能力,具体的操作步骤:

  1. 安装数据库,版本要求:5.6.5+
  2. 初始化mysql数据库,数据库初始化文件:nacos-mysql.sql
  3. 修改conf/application.properties文件,增加支持mysql数据源配置(目前只支持mysql),添加mysql数据源的url、用户名和密码。
spring.datasource.platform=mysql
db.num=1
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=root
db.password=123456

对于单机来说我们就是玩个demo是够的,但是对于生产来说我们就要考虑高可用的方案了:
对于集群部署的方式如果在虚拟机环境就采用Nagix负载3台虚拟机,对于K8S的环境通过Service负载3台Pod的形式搭建高可用环境,对于数据库选择来说最好采用主从结构,保证数据库的高可用。
整体的部署可能如下;

Nacos使用和注册部分源码介绍

下图就是搭建好以后的整体界面:


Nacos使用和注册部分源码介绍

Nacos使用

1.创建一个Spring Boot空应用

2.编辑pom.xml文件

    <properties>
        <springboot.vetsion>2.2.11.RELEASE</springboot.vetsion>
        <spring-cloud-version>Hoxton.SR9</spring-cloud-version>
        <spring-cloud-alibaba-version>2.2.3.RELEASE</spring-cloud-alibaba-version>
    </properties>
<dependencyManagement>
    <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${springboot.vetsion}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud-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>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
</dependencies>

3.创建应用的启动项目

@SpringBootApplication(scanBasePackages = {"com.springcloud.study"})
@EnableDiscoveryClient
public class SystemApplication {

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

4.配置application.yaml文件

server:
  port: 8081
spring:
  application:
    name: system
  # 数据源配置项
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/study_user?useSSL=false&useUnicode=true&characterEncoding=UTF-8
    driver-class-namecom.mysql.jdbc.Driver
    username: root
    password: 123456
  #nacos基础配置
  cloud:
    nacos:
      discovery:
        server-addr: 10.226.73.115:8886
        #环境选择
        #namespace: b7d341fc-df29-45ce-b3cd-4415f66b1ee0

5.启动项目

Nacos使用和注册部分源码介绍

Nacos注册部分源码分析

客户端通过Rest接口式向Nacos Server注册自己的服务,提供自身的元数据,比如ip地址、端口等信息。 Nacos Server接收到注册请求后,就会把这些元数据信息存储在一个双层的内存Map中。对于注册部分的源码整体上分为两部分:

客户端注册源码

按照Spring Boot Starter的习惯,我们首先找到spring-cloud-starter-alibaba-nacos-discovery启动项,如下图所示:

Nacos使用和注册部分源码介绍

标红部分的NacosServiceRegistryAutoConfiguration是我们注册部分关注的类,首先我们看下该类的整体的继承结构:


Nacos使用和注册部分源码介绍

重点关注AbstractAutoServiceRegistration接口,NacosAutoServiceRegistration该Bean的注入就是我们注入开始的:


Nacos使用和注册部分源码介绍

整体看下该类,基本上是对AbstractAutoServiceRegistration继承和实现,该类位于spring-cloud-common这个jar下面,Spring Cloud Commons模块是为了对微服务中的服务注册与发现、负载均衡、熔断器等功能提供一个抽象层代码,这个抽象层与具体的实现无关。这样这些功能具体的实现上可以采用不同的技术去实现,并可以做到在使用时灵活的更换。

NacosAutoServiceRegistration内部存在一个@EventListener注解,@EventListener是一种事件驱动编程在spring4.2的时候开始有的,可以理解为ApplicationListener接口的扩展,方便我们使用,可以理解为Spring为我们提供的一个事件监听、订阅的实现,内部实现原理是观察者设计模式;为的就是业务系统逻辑的解耦,提高可扩展性以及可维护性。事件发布者并不需要考虑谁去监听,监听具体的实现内容是什么,发布者的工作只是为了发布事件而已。


Nacos使用和注册部分源码介绍

接下来我们重点看下AbstractAutoServiceRegistration内部start方法,


Nacos使用和注册部分源码介绍

register的具体的实现类是NacosServiceRegistry,内部调用NacosNamingService的registerInstance方法,该方法内部通过调用NamingProxy的reqApi,通过NacosRestTemplate请求服务端的/instance方法注册到服务端。


Nacos使用和注册部分源码介绍


Nacos使用和注册部分源码介绍

至此完成了客户端注册到服务端,下图是整体的时序图:


Nacos使用和注册部分源码介绍

服务端注册部分

服务端注册相对比较复杂一点,这块需要将Nacos源码下载一下,找到naming模块,InstanceController就是我们调用服务端的接口,如下图所示:

Nacos使用和注册部分源码介绍

接下来重点看下ServiceManager的registerInstance的方法,如下图:


Nacos使用和注册部分源码介绍

首先看下createEmptyService方法,该方法目的双肩一个双层的Map对象,用于存储注册应用的信息,整体的结构Map(namespace, Map(group::serviceName, Service)),这里正好对应注册中心介绍时候的张图,我们整体在看一下:


Nacos使用和注册部分源码介绍


Nacos使用和注册部分源码介绍

初始化的注册表结构以后,接下来就是将应用的信息注册添加到注册表中,主要分为两步如下图:


Nacos使用和注册部分源码介绍

addIpAddresses就是获取当前注册服务的所有ip,整体的流程如下图:


Nacos使用和注册部分源码介绍

这里的主要的重点是put方法,这里我们全部按照CP的场景去解释,AP的场景在未来的章节补充,CP的实现类是DistroConsistencyServiceImpl,如下图:


Nacos使用和注册部分源码介绍

通过把需要注册到注册表的服务添加到阻塞队列当中,Notifier本质上一个线程,然后通过执行run内部的hander方法,如下图:


Nacos使用和注册部分源码介绍

通过调用Service的onChange方法来变更注册表的信息,内部主要通过updateIPs完成注册表信息的表更,主要也是采用CopyOnWrite的思想,如下图:


Nacos使用和注册部分源码介绍

到此服务端的注入就完成了,这个里面整体上有三处亮点:

1.CopyOnWrite的思想的广泛应用;

2.通过阻塞队列实现异步任务提升系统性能,并且解决并发写入问题;

3.观察者设计的广泛应用;


Nacos使用和注册部分源码介绍

结束

欢迎大家点点关注,点点赞,感谢!

Nacos使用和注册部分源码介绍

发表评论

评论已关闭。

相关文章