nacos客户端服务注册源码分析

1. nacos官网以及提供的接口

1.1 官网地址

https://nacos.io/zh-cn/docs/open-api.html

1.2 常用的接口

nacos常用接口

2. 使用方式

2.1 添加依赖

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

2.2 启动类上添加注解

@EnableDiscoveryClient
// 注:在新版的nacos中,可不用手动添加这个注解,而是通过spring.factories中读取配置,自动配置

2.3 配置yml文件

spring:
  application:
    name: base-data
   cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
        group: base-data
        cluster-name: xxx
        metadata:
          current-version: V2

配置注意事项:

  1. 配置了group,则服务只有在同一个group下才能相互调用,
  2. cluster-name,是一个跨机房容灾部署的概念,如:北京集群,南京集群,跨集群是可以互相调用的,但一般要同集群优先调用,减少网络开销。
  3. Metadata.creent-version:指定版本,只有版本号相同才能互相调用。“金丝雀发布”就用到这个配置。如:A,B两个服务,个部署了1000台服务器,在一次升级中,为了确保服务的正确性,一般A,B先各发300台或者500台,指定他们的版本后,等到已发布的能够稳定运行,再升级剩余的服务器。

2.4 nacos数据模型

nacos官网数据模型图

带集群的模型图

带集群的模型图

3. 寻找源码入口

  1. 导入nacos服务发现的包后,可以看到其层级结构如下:

    image-20200315194032861

对于这种引入的jar包,应该找其入口呢?spring.factories就是关键了。

打开这个文件

image-20200315194618390

很明显其中,BootstrapConfiguration是在项目启动时自动加载的配置:

org.springframework.cloud.bootstrap.BootstrapConfiguration=\
com.alibaba.cloud.nacos.discovery.configclient.NacosDiscoveryClientConfigServiceBootstrapConfiguration

打开这个文件:

image-20200315195027295

打开这个文件,发现它其实就做了一件事,引入了两个自动配置的类,

NacosDiscoveryClientAutoConfiguration.class,
NacosDiscoveryAutoConfiguration.class 

这两个类都是包含在spring.factories中的。哪个才是服务注册相关的配置呢?

打开这两个类:

NacosDiscoveryClientAutoConfiguration

image-20200315195524925

4.NacosDiscoveryAutoConfiguration 客户端服务注册入口

NacosDiscoveryAutoConfiguration

image-20200315195725398

在NacosDiscoveryAutoConfiguration 文件中终于看到了几个与注册相关的词,那应该就是它,没错了。

这个自动化配置类,初始化了3个bean,仔细看看应该不难发现,自动注册的功能应该就在NacosAutoServiceRegistration中了。

打开这个类的类图,好像并不能发现什么线索。

image-20200315200212461

这种情况,只有去它的父类找找了,NacosDiscoveryAutoConfiguration的父类实现了一个特殊的接口,值得注意一下,那就是ApplicationListener,这是一个事件监听器。

监听的事件是:WebServerInitializedEvent

这个事件是干嘛的呢?打开这个事件的源码,发现了下面这样一段注释。

大致意思是:这个事件会在上下文刷新后和WebServer已经准备好之后被发布。对于获取一个运行的服务的端口非常有用。

 * Event to be published after the application context is refreshed and the
 * {@link WebServer} is ready. Useful for obtaining the local port of a running server.
image-20200315200325358

看看监听这个事件后究竟做了些什么?

image-20200315200826713
image-20200315201006727
image-20200315201030942

经过,这一连串的调用,似乎终于找到正主了。看看getRegistration()去,发现是一个抽象方法

这应该算一个经典的模板设计模式了

image-20200315201317105

真正的实现在其子类中,也就是:NacosAutoServiceRegistration中

[图片上传失败...(image-681e06-1584276360368)]

NacosRegistration也就是用于读取用户的一些配置,这些细枝末节先放过,还是回到主流程中

也就是

image-20200315201801335

5. 注册和心跳

看看register究竟做了些什么

image-20200315201852206
image-20200315201946120

其中:instance.isEphemeral()这个实例是否是‘临时’的,默认是true

这里涉及到nacos的AP和CP模式,这是后话了

  beatReactor.addBeatInfo(NamingUtils.getGroupedName(serviceName, groupName), beatInfo);
image-20200315202336622
image-20200315203518721
image-20200315203552977

这里发起了一个http请求 ,想必你已经从它的名字看出来它是干嘛的了,没错,它就是一个心跳

image-20200315203630563

完整的地址是:

/nacos/v1/ns/instance/beat

如何验证,是否正确呢?去官网看一下就知道了。

image-20200315203926099

没有问题,它就是心跳

6.服务注册

下面这一行才是真正的发起注册的地方

 serverProxy.registerService(NamingUtils.getGroupedName(serviceName, groupName), groupName, instance);
image-20200315202851557

先拼接了一堆参数,然后发起了一个http请求,地址是:

image-20200315202945748

拼接好后的地址就是:

/nacos//v1/ns/instance

怎么知道是否正确呢?去官方文档看一下就知道了

image-20200315203149301

哈哈,正确的。

客户端发起的注册流程,到这就结束了,服务端接收到注册请求后具体是如何处理的,需要到服务端去查看。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,525评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,203评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,862评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,728评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,743评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,590评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,330评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,244评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,693评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,885评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,001评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,723评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,343评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,919评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,042评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,191评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,955评论 2 355

推荐阅读更多精彩内容