03篇 Nacos Client服务发现源码分析

本篇带大家通过源码层面分析一下Nacos Client的服务发现的路程，事实可能并不像你想象的那样简单。

Nacos服务发现

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

naocos但细化这个流程，会发现不仅包括了通过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”、集群列表默认为空数组、是否订阅默认为“订阅”。

上述方法整理成流程图如下：

naocos

上述流程的基本逻辑为：

如果是订阅模式，则直接从本地缓存获取服务信息（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;
}

在上述代码中，可以看到在获取服务实例列表时（特别是首次），也进行了订阅逻辑的拓展，基本流程图如下：

naocos

上图流程中可以看出，订阅方法先通过代理类进行了本地缓存的判断，如果本地缓存存在ServiceInfo信息，则直接返回。如果不存在，则默认采用gRPC协议进行订阅，并返回ServiceInfo。

grpcClientProxy的subscribe订阅方法就是直接向服务器发送了一个订阅请求，并返回结果，就没有做过多处理了。

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

最后一步，ServiceInfo本地缓存处理。这里会将获得的最新ServiceInfo与本地内存中的ServiceInfo进行比较，更新，发布变更时间，磁盘文件存储等操作。其实，这一步的操作，在订阅定时任务中也进行了处理。

关于订阅细节和本地缓存处理，涉及内容较多，我们后面单独拓展开讲解。这里知道整体流程即可。

小结

本文主要梳理了Nacos客户端服务发现的核心流程，包括：

第一，如果没有开启订阅模式，则直接通过/instance/list接口（默认通过gRPC协议）获取服务实例列表信息；

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

第三，在开启订阅时，会开启定时任务，定时执行UpdateTask（获取服务器实例信息、更新本地缓存、发布事件）；

第四，在第二步获得最新的实例信息之后，也会执行processServiceInfo方法来更新内存和本地实例缓存，并发布变更时间。

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