乐趣区

关于spring-cloud-alibaba:03篇-Nacos-Client服务发现源码分析

学习不必那么功利,二师兄带你从更高维度轻松浏览源码~

本篇带大家通过源码层面剖析一下 Nacos Client 的服务发现的途程,事实可能并不像你设想的那样简略。

Nacos 服务发现

直观的看,Nacos 客户端的服务发现,就是封装参数、调用服务端接口、取得返回实例列表。

但细化这个流程,会发现不仅包含了通过 NamingService 获取服务列表,在获取服务列表的过程中还波及到通信协议(Http or gRPC)、订阅流程、故障转移逻辑等。上面咱们依据服务发现来捋一下相干的流程。

先说入口程序,仍旧是在 NamingTest 中能够看到:

NamingService namingService = NacosFactory.createNamingService(properties);
namingService.registerInstance("nacos.test.1", instance);

ThreadUtils.sleep(5000L);
// 获取实例列表
List<Instance> list = namingService.getAllInstances("nacos.test.1");

对于 NamingService 的实例化和基本功能,在服务注册时曾经讲过,这里间接看获取实例列表办法 getAllInstances。该办法的参数就是服务的名称。

通过一些列的重载办法调用,真正解决外围逻辑的办法如下:

@Override
public List<Instance> getAllInstances(String serviceName, String groupName, List<String> clusters,
        boolean subscribe) throws NacosException {
    ServiceInfo serviceInfo;
    String clusterString = StringUtils.join(clusters, ",");
    // 是否订阅模式
    if (subscribe) {
        // 先从客户端缓存获取服务信息
        serviceInfo = serviceInfoHolder.getServiceInfo(serviceName, groupName, clusterString);
        if (null == serviceInfo) {
            // 如果本地缓存不存在服务信息,则进行订阅
            serviceInfo = clientProxy.subscribe(serviceName, groupName, clusterString);
        }
    } else {
        // 如果未订阅服务信息,则间接从服务器进行查问
        serviceInfo = clientProxy.queryInstancesOfService(serviceName, groupName, clusterString, 0, false);
    }
    // 从服务信息中获去实例列表
    List<Instance> list;
    if (serviceInfo == null || CollectionUtils.isEmpty(list = serviceInfo.getHosts())) {return new ArrayList<Instance>();
    }
    return list;
}

首先看重载的 getAllInstances 办法,比入口办法多了几个参数,这里不仅有服务名称,还有分组名称(groupName)、集群列表(clusters)、是否订阅(subscribe)。

重载办法中的其余参数曾经设置了默认值。比方,分组名称默认为“DEFAULT_GROUP”、集群列表默认为空数组、是否订阅默认为“订阅”。

上述办法整顿成流程图如下:

上述流程的根本逻辑为:

如果是订阅模式,则间接从本地缓存获取服务信息(ServiceInfo),而后从中获取实例列表,这是因为订阅机制会主动同步服务器实例的变动到本地。如果本地缓存中没有,那阐明是首次调用,则进行订阅,在订阅实现后会取得到服务信息。

如果是非订阅模式,那就间接申请服务器端,取得服务信息。

订阅解决流程

在上述流程中,波及到了订阅逻辑,入口代码为获取实例列表中的如下办法:

serviceInfo = clientProxy.subscribe(serviceName, groupName, clusterString);

上面就来看看该办法外部是如何进行解决的。首先,这里的 clientProxy 是 NamingClientProxy 类的对象。对应的 subscribe 实现如下:

@Override
public ServiceInfo subscribe(String serviceName, String groupName, String clusters) throws NacosException {String serviceNameWithGroup = NamingUtils.getGroupedName(serviceName, groupName);
    String serviceKey = ServiceInfo.getKey(serviceNameWithGroup, clusters);
    // 获取缓存中的 ServiceInfo
    ServiceInfo result = serviceInfoHolder.getServiceInfoMap().get(serviceKey);
    if (null == result) {
        // 如果为 null,则进行订阅逻辑解决,基于 gRPC 协定
        result = grpcClientProxy.subscribe(serviceName, groupName, clusters);
    }
    // 定时调度 UpdateTask
    serviceInfoUpdateService.scheduleUpdateIfAbsent(serviceName, groupName, clusters);
    // ServiceInfo 本地缓存解决
    serviceInfoHolder.processServiceInfo(result);
    return result;
}

在上述代码中,能够看到在获取服务实例列表时(特地是首次),也进行了订阅逻辑的拓展,根本流程图如下:

上图流程中能够看出,订阅办法先通过代理类进行了本地缓存的判断,如果本地缓存存在 ServiceInfo 信息,则间接返回。如果不存在,则默认采纳 gRPC 协定进行订阅,并返回 ServiceInfo。

grpcClientProxy 的 subscribe 订阅办法就是间接向服务器发送了一个订阅申请,并返回后果,就没有做过多解决了。

订阅实现之后,会通过 ServiceInfoUpdateService 开启一个定时工作,这个定时工作次要的作用就是来定时同步服务器端的实例列表信息,并进行本地缓存更新等操作。

最初一步,ServiceInfo 本地缓存解决。这里会将取得的最新 ServiceInfo 与本地内存中的 ServiceInfo 进行比拟,更新,公布变更工夫,磁盘文件存储等操作。其实,这一步的操作,在订阅定时工作中也进行了解决。

对于订阅细节和本地缓存解决,波及内容较多,咱们前面独自拓展开解说。这里晓得整体流程即可。

小结

本文次要梳理了 Nacos 客户端服务发现的外围流程,包含:

第一,如果没有开启订阅模式,则间接通过 /instance/list 接口(默认通过 gRPC 协定)获取服务实例列表信息;

第二,如果开启订阅模式(默认开启),则先会从本地缓存中获取实例信息,如果不存在,则进行订阅获并获取实例信息;

第三,在开启订阅时,会开启定时工作,定时执行 UpdateTask(获取服务器实例信息、更新本地缓存、公布事件);

第四,在第二步取得最新的实例信息之后,也会执行 processServiceInfo 办法来更新内存和本地实例缓存,并公布变更工夫。

第五,至此,与第二步造成循环,每次获取本地缓存,不存在则更新……

对于用来解决订阅相干的 UpdateTask 和用来解决本地缓存的 ServiceInfoHolder#processServiceInfo 办法,咱们前面文章持续解说。

博主简介:《SpringBoot 技术底细》技术图书作者,热爱钻研技术,写技术干货文章。

公众号:「程序新视界」,博主的公众号,欢送关注~

技术交换:请分割博主微信号:zhuan2quan

退出移动版