Dubbo服务自省在消费端的体现

Dubbo通常使用@Reference来引用服务，通过ReferenceAnnotationBeanPostProcessor类，我们可以扫描被@Reference注解标注的对象，实现服务引用。当引入服务自省后，服务引用过程部分内容与之前的原理有所不同，在本文中着重解释不同的地方，相同的地方不做具体解释。

在服务引用时，最终会调用 ReferenceConfig.get() 方法。

code1.png

然后在ReferenceConfig.init()方法中调用createProxy方法创建代理对象。

code2.png

在createProxy方法中调用Protocol.refer方法进行服务引用。

因为开启了服务自省，所以协议为service-discovery-registry

code3.png

由于Protocol运用了SPI机制，最后一步使用装饰者模型将创建的对象封装到对应的Wrapper对象中，

所以，在该处会调用ProtocolFilterWrapper.refer方法

code4.png

接着调用ProtocolListenerWrapper.refer方法，然后由于开启了服务自省，所以就

调用ServiceDiscoveryRegistryProtocol.refer方法，ServiceDiscoveryRegistryProtocol是RegistryProtocol的子类。

在该方法中，首先对url进行处理，当开启了服务自省时，忽略这一步

ServiceDiscoveryRegistryProtocol类
protected URL getRegistryUrl(URL url) {
        return "service-discovery-registry".equals(url.getProtocol()) ? url : super.getRegistryUrl(url);
}

RegistryProtocol类
protected URL getRegistryUrl(URL url) {
        return URLBuilder.from(url).setProtocol(url.getParameter("registry", "dubbo")).removeParameter("registry").build();
    }

列举一个url样例：

service-discovery-registry://127.0.0.1:2181/org.apache.dubbo.registry.RegistryService?application=dubbo-zookeeper-service-introspection-consumer-sample&dubbo=2.0.2&file=C:\Users\HP/dubbo-cache/dubbo-zookeeper-service-introspection-consumer-sample/dubbo.cache&pid=5304&qos.enable=false&refer=application%3Ddubbo-zookeeper-service-introspection-consumer-sample%26dubbo%3D2.0.2%26init%3Dfalse%26interface%3Dorg.apache.dubbo.spring.boot.sample.consumer.DemoService%26metadata-type%3Dremote%26methods%3DsayHello%26pid%3D5304%26qos.enable%3Dfalse%26register.ip%3D192.168.5.105%26release%3D2.7.8%26revision%3D1.0.0%26side%3Dconsumer%26sticky%3Dfalse%26timestamp%3D1613440867429%26version%3D1.0.0&registry=zookeeper&registry-type=service&release=2.7.8&timestamp=1613440867459

然后获取一个注册实例，即ServiceDiscoveryRegistry，url换成：

zookeeper://127.0.0.1:2181/org.apache.dubbo.registry.RegistryService?application=dubbo-zookeeper-service-introspection-consumer-sample&dubbo=2.0.2&file=C:\Users\HP/dubbo-cache/dubbo-zookeeper-service-introspection-consumer-sample/dubbo.cache&interface=org.apache.dubbo.registry.RegistryService&pid=5304&qos.enable=false&registry-type=service&release=2.7.8&timestamp=1613440867459

code5.png

根据字段获取Cluster，用于后续的集群处理，默认是FailoverCluster

接着调用RegistryProtocol.doRefer方法，这是很重要的一步。

code6.png

在该方法中，首先创建一个RegistryDirectory，赋值注册实例和协议。

然后订阅url，url样例为：

consumer://192.168.5.105/org.apache.dubbo.spring.boot.sample.consumer.DemoService?application=dubbo-zookeeper-service-introspection-consumer-sample&category=providers,configurators,routers&dubbo=2.0.2&init=false&interface=org.apache.dubbo.spring.boot.sample.consumer.DemoService&metadata-type=remote&methods=sayHello&pid=3416&qos.enable=false&release=2.7.8&revision=1.0.0&side=consumer&sticky=false&timestamp=1613448501648&version=1.0.0

设置此RegistryDirectory为监听器，RegistryDirectory实现了NotifyListener接口。

code7.png

调用FailbackRegistry.subscribe方法，然后调用ServiceDiscoveryRegistry.doSubscribe方法

code9.png

writableMetadataService的默认实现类是InMemoryWritableMetadataService，先记录下订阅的url

然后获取服务应用名，主要有三种查找方法，1）通过参数"provider-by"指定，2）访问配置中心，3）通过参数“subscribed-services”指定

遍历提供该服务的应用，调用subscribleURLs方法订阅

code10.png

从注册中心根据应用名获取serviceInstance，serviceInstance记录了服务端的host和port，和存储元数据方式等信息。

调用ServiceDiscoveryRegistry.getExportedURLs方法获取该应用所提供的所有服务。

调用ServiceDiscovryRegistry.expungeStaleRevisionExportedURLs方法。

private final Map<String, Map<String, List<URL>>> serviceRevisionExportedURLsCache = new LinkedHashMap();

从serviceRevisionExportedURLsCache中根据key获取该应用提供的服务，key为应用名。

如果获取的内容不为空，执行下面的方法。

private void expungeStaleRevisionExportedURLs(List<ServiceInstance> serviceInstances) {
        String serviceName = ((ServiceInstance)serviceInstances.get(0)).getServiceName();
        Map<String, List<URL>> revisionExportedURLsMap = this.getRevisionExportedURLsMap(serviceName);
        if (!revisionExportedURLsMap.isEmpty()) {
            Set<String> existedRevisions = revisionExportedURLsMap.keySet();
            Set<String> currentRevisions = (Set)serviceInstances.stream().map(ServiceInstanceMetadataUtils::getExportedServicesRevision).collect(Collectors.toSet());
            Set<String> staleRevisions = new HashSet(existedRevisions);
            staleRevisions.removeAll(currentRevisions);
            staleRevisions.forEach(revisionExportedURLsMap::remove);
        }
    }

然后调用ServiceDiscoveryRegistry.initializeRevisionExportedURLs方法。

code11.png code12.png

随机选择一个ServiceInstance，然后‘获取该应用下提供的所有服务。下述代码去除一些非重要部分。

先从serviceRevisionExportedURLsCache缓存中获取，key为应用名，value是一个Map，其中的key为revision，

如果获取不到，则调用getExportedURLs方法利用MetadataService服务获取该服务端提供的所有服务。

private List<URL> initializeRevisionExportedURLs(ServiceInstance serviceInstance) {
            String serviceName = serviceInstance.getServiceName();
            String revision = ServiceInstanceMetadataUtils.getExportedServicesRevision(serviceInstance);
            Map<String, List<URL>> revisionExportedURLsMap = this.getRevisionExportedURLsMap(serviceName);
            List<URL> revisionExportedURLs = (List)revisionExportedURLsMap.get(revision);
            boolean firstGet = false;
            if (revisionExportedURLs == null) {
                if (!revisionExportedURLsMap.isEmpty()) {
                } else {
                    firstGet = true;
                }
                revisionExportedURLs = this.getExportedURLs(serviceInstance);
                if (revisionExportedURLs != null) {
                    revisionExportedURLsMap.put(revision, revisionExportedURLs);
                }
            } 
            return revisionExportedURLs;
        }
    }

调用metadataService.getExportedURLs()方法发起远程调用。

code13.png

在样例中，该服务端提供了两个服务，所以返回两个url

code14.png

调用cloneExportedURLs方法克隆剩余ServiceInstance，只修改了host和port。

设置监听器监听目录/services/应用名，当该目录下数据发生变化时，通过调用subscribeURLs方法 重新建立对远程服务的引用

调用notifyAllSubscribedURLs方法通知所设置的监听器。

并调用Invoker<T> invoker = cluster.join(directory);方法生成invoker。

之后调转到ReferenceConfig类中，根据metadata类型，获取对应的 WritableMetadataService，在本样例中为RemoteWritableMetadataService，发布ServiceDefinition

最后将invoker创建为一个代理对象。
并将相关信息存储在ConsumerModel中

code15.png

发布ReferenceConfigInitializedEvent事件。

至此，在消费端的分析就结束了。