深度解析nacos源码之注册中心（服务发现上篇）

素颜马尾好姑娘i 2022-12-28 12:42 167阅读 0赞

> 原创不易，转载请注明出处  
> 本文基于nacos1.4.0

**深度解析nacos源码系列文章目录**

1.  《[深度解析nacos源码之注册中心（服务注册）][nacos]》
2.  《[深度解析nacos源码之注册中心（服务注册流程图补充）][nacos 1]》
3.  《[深度解析nacos源码之注册中心（服务主动下线）][nacos 2]》
4.  《[深度解析nacos源码之注册中心（服务续约与故障下线）][nacos 3]》

### 文章目录 ###

*   *   *  前言
         *  1. 直接拉取方式
         *   *  1.1 直接拉取客户端源码
             *  1.2 直接拉取服务端处理源码
         *  2. 订阅通知方式
         *   *  2.1 客户端发起订阅
             *   *  2.1.1 HostReactor\#getServiceInfo
                 *  2.1.2 HostReactor\#updateServiceNow
                 *  2.1.3 UpdateTask\#run
             *  2.2 服务端处理订阅
         *  总结

--------------------

### 前言 ###

本文将解析下nacos的服务发现源码实现，nacos支持两种服务发现方式，一种是直接去nacos服务端拉取某个服务的实例列表，就像eureka那样定时去拉取注册表信息，另一种是服务订阅的方式，就是订阅某个服务，然后这个服务下面的实例列表一旦发生变化，nacos服务端就会使用udp的方式通知客户端，并将实例列表带过去，在上篇中我们主要先看下 直接拉取服务实例列表的实现与订阅，对于订阅服务实例列表发生变化，nacos服务端通知订阅的客户端这部分代码我们在下篇详细介绍。

### 1. 直接拉取方式 ###

#### 1.1 直接拉取客户端源码 ####

Properties properties = new Properties();
    properties.setProperty("serverAddr", "10.0.8.247:8825");
    properties.setProperty("namespace","public");
    
    NamingService naming = NamingFactory.createNamingService(properties);
    naming.registerInstance("userService", "11.11.11.11", 8888, "DEFAULT");
    List<Instance> userService = naming.getAllInstances("userService");

上面这段代码，先是创建一个NamingService ，接着注册了一个服务实例，最后是调用了getAllInstances方法获取某个服务的实例列表。  
我们来看下这个getAllInstances 方法实现。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70]  
前面一堆重载方法，就是设置默认的group 与 cluster 我们跳过去，直接到这个参数最全的方法来，重要的是中间红框框的这个，然后判断是否订阅，到这里默认是订阅的，也就是subscribe =true， 不过可以指定，我们就先看下这个不订阅的是怎么实现的吧，调用了getServiceInfoDirectlyFromServer 这个方法，从方法名上也能看出来，就是直接从server上获取serviceInfo。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 1]  
这里直接是调用了serverProxy组件的queryList 方法，需要主要的是这个udp端口是0 ，因为咱们这里是不订阅的，这个upd是给订阅的接收通知用的  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 2]  
这个方法就是封装请求参数，udpPort，clientIP，healthyOnly 这几个参数需要注意下，接着调用reqApi 选择server 发送请求了，请求uri是 /nacos/v1/ns/instance/list ，请求方法是get。后面的选择server发送请求我们就不看了，在服务注册，服务发现里面我们看了无数次了。

#### 1.2 直接拉取服务端处理源码 ####

InstanceController 的list 方法是处理这个请求的，我们来看下  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 3]  
上面这一堆就是解析参数，我们不过多关注，主要看下doSrvIpxt这个方法。方法太长了我们分段看。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 4]  
这一部分代码，其实就干了2件事，1是根据namespace与serviceName 到ServiceManager下面的serviceMap获取对应的service对象。  
2是判断upd端口与这个客户端版本啥的，看看适不适合推送，我们这里udp端口是0 ，很显然不适合。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 5]  
上面有一段代码没有截取，就是service是null的时候，是null的时候组装响应参数返回给客户端了，我们看下这段代码，先是检查service 可不可用，接着就是根据cluster 获取这个service 下面的instance列表了，根据cluster获取这个服务下面对应的实例集合。  
接着就是获取这个selector ，使用selector 来过滤实例集合。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 6]  
接着就是 创建一个map，然后用来区分健康的实例与不健康的实例，健康的实例key就是 Boolean.TRUE 不健康的就是Boolean.FALSE ，遍历区分开，接着就是判断是否检查，默认是false的，获取服务保护的阈值，默认是0 ， 如果健康的服务实例数量占比小于这个阈值的话，他就会将不健康的实例也放到健康的里面，这就是nacos的服务保护机制，可以联想下eureka的服务保护机制，为啥要把不健康的放到健康里面，因为后面返回给客户端的时候，只返回健康的这个key下面，这样就达到了活着实例数量低于某个阈值后不进行服务摘除的效果。  
后面就是遍历那个map只要Boolean.TRUE 与可用的服务，然后塞到hosts 这个map中  
最后就是封装返回结果，然后返回给客户端。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 7]  
好了我们直接去服务端来去服务是列表的源码就看完了。

### 2. 订阅通知方式 ###

#### 2.1 客户端发起订阅 ####

serviceInfo = hostReactor.getServiceInfo(NamingUtils.getGroupedName(serviceName, groupName),
                        StringUtils.join(clusters, ","));

接着1.2小节getAllInstances 这个方法分析，这次我们看下订阅是怎么弄的

##### 2.1.1 HostReactor\#getServiceInfo #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 8]  
先是根据clusters与serviceName生成一个订阅key，接着就是调用getServiceInfo0 方法获取本地的一个缓存  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 9]  
其实就是与上面生成那个key一样，然后去serviceInfoMap 这个map中获取，它你可以理解成一个本地的缓存。  
如果没有的话，就创建一个ServiceInfo 对象，放到serviceInfoMap 这个map中，然后在updatingMap 中插入这serviceName ，表示这个serviceName正在更新。调用updateServiceNow这个方法立即更新，这个其实就是立即发送请求去客户端端获取。我们看下

##### 2.1.2 HostReactor\#updateServiceNow #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 10]  
这里它又从缓存中获取了一次老的，接着就是调用serverProxy 这个组件的queryList 方法来获取服务实例列表了，这个方法很熟悉，我们在1.2 小节见过它，需要注意的是pushReceiver.getUdpPort() ，就是获取了一个upd端口，这个pushReceiver 组件就是用来接收nacos服务端推送的，后面我们在看下，关于serverProxy.queryList 往后的代码我们就不看了。这里推荐看 `2.2 服务端处理订阅` 章节内容。看完之后再回来。

回到HostReactor\#getServiceInfo 这个方法中，我们上面介绍完了ServiceInfo 是null的情况，接着就是介绍updatingMap里面有serviceName，就是说明这个正在更新着，不要着急，等待5s在获取，如果如果提前有了数据，会有线程通知然后唤醒这个等待的线程。接着就是调用了 `scheduleUpdateIfAbsent(serviceName, clusters);`这个方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 11]  
先是从futureMap中获取这个key ，如果有了的话直接返回，很显然我们第一次是没有的， 就会接着往下走，调用了addTask方法添加一个task，然后返回一个future，将这个future 缓存到map中去了。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 12]  
将task扔到一个任务调度线程池里面了，然后延迟1s调度。  
我们看下这个任务干啥事情

##### 2.1.3 UpdateTask\#run #####

这个方法比较长，我们一部分一部分看下。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 13]  
这个其实就是从serviceInfoMap这个本地缓存中获取咱们订阅的服务信息ServiceInfo，如果是null的话就走updateService 方法，这个方法就是2.1.2小节介绍的了，直接去服务端拉取。  
如果缓存中ServiceInfo 的最后更新时间小于这个任务里面维护的最后时间值的话，说明serviceInfoMap 缓存中的服务信息有点旧了，也就走updateService 方法去拉取，否则的话就是调用refreshOnly方法，这个方法就是告诉服务端要订阅哪个服务。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 14]  
这里先是更新一下任务里面维护的这个lastRefTime时间值，接着就是判断如果eventDispatcher 组件没有订阅这个服务并且 futureMap（任务集合）里面没有这个的话，就说明被任务被停了，这个任务直接return就可以了， 接着就是计算下延迟时间，然后放到调度线程池中执行，普通情况延迟10s，失败的话就多延迟会，但是不会超过60s。

#### 2.2 服务端处理订阅 ####

服务端处理订阅还是在InstanceController 的list 方法进行的，因为是一个接口，所以处理逻辑都是一样的，我们这里就不关注了，主要看下判断upd端口那段代码  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 15]  
调用了pushService 组件的addClient 方法，这个pushService 组件主要就是用来进行推送的， 比如我们订阅了某个服务，然后这个服务下面的实例信息发生了变化，pushService组件就会通知所有的订阅客户端，将新的数据给客户端推过去。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 16]  
我们看下这个 pushService组件的addClient方法，首先是创建一个PushClient对象，就是把我们订阅的一些信息封装到了PushClient这个对象中。接着就是调用addClient的重载方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 17]  
这个方法就是先生成一个serviceKey ，然后去clientMap中获取，如果没有这个clients话就创建塞到这个clientMap 中， 最后就是将PushClient 转成字符串当作key，去clients这个map中获取，如果没有，就添加进去，如果有的话就只是刷新一下旧的。好了，到这就把订阅信息添加到PushService这个组件里面了，这个时候服务端就可以返回给客户端了。

### 总结 ###

总结一下，其实不订阅的服务发现非常简单，就是客户端发起请求直接去服务端拉取订阅的服务实例列表就可以了，如果是订阅的话，客户端先去服务端拉取订阅服务列表，并且客户端带上自己本地的udp端口给服务端，服务端会根据udp与客户端版本判断能不能订阅，能的话服务端根据订阅信息生成一个PushClient放到一个clientMap中，到时候服务实例信息改变的时候，就会从这个clientMap 取到这个PushClient信息，然后进行推送。客户端向服务端拉取完服务列表后，接着生成一个更新任务，隔一段时间去服务端刷新下数据啥的。

[nacos]: https://inetyoung.blog.csdn.net/article/details/111227314
[nacos 1]: https://inetyoung.blog.csdn.net/article/details/111252029
[nacos 2]: https://inetyoung.blog.csdn.net/article/details/111290929
[nacos 3]: https://inetyoung.blog.csdn.net/article/details/111299177
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70]: /images/20221120/9f0f2af091f94b4089725a46e5759624.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 1]: /images/20221120/d6f98c64e02d45f8a52c4ca21ff31c89.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 2]: /images/20221120/b278b3db13434b088afbb983abbb2024.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 3]: /images/20221120/981f4f2eacbf470eb8498775cc182e80.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 4]: /images/20221120/4f95f26cb337447d983f08c9100210a2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 5]: /images/20221120/d655a44ae5b142749e068807b6d791d6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 6]: /images/20221120/bf9213c768ee475086cf4a43755ec730.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 7]: /images/20221120/6d24f68e323c4cb7b0312968a7d1adc2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 8]: /images/20221120/0420b713ab804154bc39816ce5b7faaa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 9]: /images/20221120/4622d8170f75415eb9b2f57e16d36fd0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 10]: /images/20221120/3bd31d8871b74ed4a96767b403ccd986.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 11]: /images/20221120/8caeb64a64af4e90a760b79ac3909c18.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 12]: /images/20221120/e7af0ffc3b9c4992ac9bad3919ecb987.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 13]: /images/20221120/519a2be9b9e2444eabc8b718c42429a7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 14]: /images/20221120/f80be46eafd54c0ea64c479d2ed90301.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 15]: /images/20221120/261d525dde5d408d9b2e99c11da23d98.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 16]: /images/20221120/07ec6172af214120be71658f30b6cf6c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3l1YW5zaGFuZ3NoZW5naHVv_size_16_color_FFFFFF_t_70 17]: /images/20221120/db8c6835d7774365a7248222fb30bd5b.png