Dubbo Spring Cloud 逆向分析服务注册事件变化的处理过程

柔情只为你懂 2022-12-23 13:28 122阅读 0赞

这篇介绍了如何从接收事件的方法逆向推出完整的事件处理过程，这个方法适合在解决具体问题或学习源码时，倒着把处理过程理顺。

## 起因 ##

原来用的 Spring Boot + Dubbo 开发架构，在架构中有一个特殊的功能用到了 `NotifyListener` 来监听指定接口变化的信息。现在要将架构升级为 Spring Cloud Alibaba，升级后发现官方对 `NotifyListener` 的支持还不完整。

`DubboCloudRegistry` 类中的如下方法：

@Override
    public final void doSubscribe(URL url, NotifyListener listener) { 
    	if (isAdminURL(url)) { 
    		// TODO in future
    		if (logger.isWarnEnabled()) { 
    			logger.warn("This feature about admin will be supported in the future.");
    		}
    	}
    	else if (isDubboMetadataServiceURL(url)) {  // for DubboMetadataService
    		subscribeDubboMetadataServiceURLs(url, listener);
    	}
    	else {  // for general Dubbo Services
    		subscribeURLs(url, listener);
    	}
    }

原来用的 `ADMIN_PROTOCOL = "admin"` 不支持了，因此项目卡在了一个非常重要的功能上。

经过查看 `spring-cloud-starter-dubbo` 代码，发现一些不完美的替代方案，就是 `com.alibaba.cloud.dubbo.registry.event` 包下提供的事件类：

*  `ServiceInstancePreRegisteredEvent`
 *  `ServiceInstanceRegisteredEvent`
 *  `ServiceInstancesChangedEvent`
 *  `SubscribedServicesChangedEvent`

这里的 `ServiceInstancesChangedEvent` 可以代替对服务监听的变化：

public class ServiceInstancesChangedEvent extends ApplicationEvent { 
    
    	private final String serviceName;
    
    	private final List<ServiceInstance> serviceInstances;

为了测试监听的功能，在官方 `spring-cloud-dubbo-client-sample` 的示例代码中，添加了如下代码：

@EventListener
    public void serviceInstancesChangedEventListener(ServiceInstancesChangedEvent event) { 
      logger.info("ServiceName: " + event.getServiceName());
      for (ServiceInstance instance : event.getServiceInstances()) { 
        logger.info("URI: " + instance.getUri());
      }
    }

在官方示例中运行良好，但是在我自己项目中这么写时，这个方法一直没触发。为了了解这里事件的触发过程，就有了下面的操作。

## 特别提示 ##

我使用 Zookeeper 作为注册中心，因此其他情况不一定存在本文遇到的问题。

官方示例改为 zookeeper 注册中心，按下面方式修改依赖：

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-zookeeper-all</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.apache.zookeeper</groupId>
                <artifactId>zookeeper</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>org.apache.zookeeper</groupId>
        <artifactId>zookeeper</artifactId>
        <version>3.4.12</version>
        <exclusions>
            <exclusion>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-log4j12</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

注释 nacos 依赖，添加 zookeeper 依赖即可。

在 `bootstrap.yaml` 中修改注册配置：

spring:
      application:
        name: spring-cloud-alibaba-dubbo-client
      main:
        allow-bean-definition-overriding: true
      cloud:
    # nacos:
    # username: nacos
    # password: nacos
    # discovery:
    # server-addr: 127.0.0.1:8848
        zookeeper:
          connect-string: 127.0.0.1:2181

同样注释 nacos，配置 zookeeper。

**按照同样的方式修改服务提供者 `DubboSpringCloudServerBootstrap`**。调试过程中，通过该服务的启动关闭来触发事件监听。

## 逆向分析 ##

想要找到为什么能调用，肯定要先在功能正常的官方示例中运行，由于 Spring 框架中的 IOC、AOP以及各种为了扩展性使用的设计模式、解耦和异步调用的逻辑，导致想直接看源码是很难找到联系的。

因此对框架的分析或者学习时，最好的办法就是 **DEBUG**！！！

## 断点调试 ##

在监听代码处添加断点，然后DEBUG运行 `DubboSpringCloudClientBootstrap`：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center]  
完全启动后，在直接运行方式（Run）方式启动 `DubboSpringCloudServerBootstrap`，很快就会进入上面项目中的断点，此时断点变量和堆栈信息如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 1]  
变量信息可以看出这个刚刚启动的 `DubboSpringCloudServerBootstrap` 对应的实例，重点关注线程堆栈信息。浅黄色背景部分的主要代码是 Java 和 Spring 框架的，中间夹杂3行白色的是 Spring Cloud Alibaba 的代码，这3行如下：

dispatchServiceInstancesChangedEvent:175, DubboServiceDiscoveryAutoConfiguration (com.alibaba.cloud.dubbo.autoconfigure)
    access$200:108, DubboServiceDiscoveryAutoConfiguration (com.alibaba.cloud.dubbo.autoconfigure)
    beforeChildEvent:446, DubboServiceDiscoveryAutoConfiguration$ZookeeperConfiguration (com.alibaba.cloud.dubbo.autoconfigure)

点开上面 `dispatchServiceInstancesChangedEvent:175` 对应的代码和堆栈变量信息如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 2]  
可以看到这个事件就是在这里创建的。似乎一下子就找到头了…

事实远非如此，我们继续找事件的源头。

再点第三行 `beforeChildEvent:446` 查看，如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 3]  
这里可以看到接收到了 Zookeeper 的 `TreeCacheEvent` 事件，在当前方法中，有如下注解：

@Before("execution(void org.springframework.cloud.zookeeper.discovery \ .ZookeeperServiceWatch.childEvent(..)) && args(client,event)")

这里通过 AOP 监听了 `ZookeeperServiceWatch` 类的 `childEvent` 方法：

@Override
    public void childEvent(CuratorFramework client, TreeCacheEvent event)
    		throws Exception { 
    	if (event.getType().equals(TreeCacheEvent.Type.NODE_ADDED)
    			|| event.getType().equals(TreeCacheEvent.Type.NODE_REMOVED)
    			|| event.getType().equals(TreeCacheEvent.Type.NODE_UPDATED)) { 
    		long newCacheChange = this.cacheChange.incrementAndGet();
    		this.publisher.publishEvent(new HeartbeatEvent(this, newCacheChange));
    	}
    }

这里能监听到 Zookeeper 节点的变化信息，当前方法下的线程堆栈信息如下：

beforeChildEvent:446, DubboServiceDiscoveryAutoConfiguration$ZookeeperConfiguration (com.alibaba.cloud.dubbo.autoconfigure)
    invoke0:-1, NativeMethodAccessorImpl (jdk.internal.reflect)
    invoke:62, NativeMethodAccessorImpl (jdk.internal.reflect)
    invoke:43, DelegatingMethodAccessorImpl (jdk.internal.reflect)
    invoke:566, Method (java.lang.reflect)
    invokeAdviceMethodWithGivenArgs:644, AbstractAspectJAdvice (org.springframework.aop.aspectj)
    invokeAdviceMethod:626, AbstractAspectJAdvice (org.springframework.aop.aspectj)
    before:44, AspectJMethodBeforeAdvice (org.springframework.aop.aspectj)
    invoke:55, MethodBeforeAdviceInterceptor (org.springframework.aop.framework.adapter)
    proceed:175, ReflectiveMethodInvocation (org.springframework.aop.framework)
    proceed:749, CglibAopProxy$CglibMethodInvocation (org.springframework.aop.framework)
    invoke:95, ExposeInvocationInterceptor (org.springframework.aop.interceptor)
    proceed:186, ReflectiveMethodInvocation (org.springframework.aop.framework)
    proceed:749, CglibAopProxy$CglibMethodInvocation (org.springframework.aop.framework)
    intercept:691, CglibAopProxy$DynamicAdvisedInterceptor (org.springframework.aop.framework)
    childEvent:-1, ZookeeperServiceWatch$$EnhancerBySpringCGLIB$$2aa71b3b (org.springframework.cloud.zookeeper.discovery)
    apply:749, TreeCache$2 (org.apache.curator.framework.recipes.cache)

此时可以看到往下最近的就是 java 反射代码，再往下就是 Spring AOP 代码，AOP的尽头就是被代理（AOP）的 `childEvent:-1, ZookeeperServiceWatch$$EnhancerBySpringCGLIB$$2aa71b3b`，在往前一行 `apply:749, TreeCache$2` 就是被代理方法的调用位置：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 4]  
当前堆栈下的 `event` 变量值为：

"TreeCacheEvent{type=NODE_ADDED, \ data=ChildData{path='/services/spring-cloud-alibaba-dubbo-server/\ d4cb6d36-235c-42ca-862f-d989ea96c958', /*隐藏部分内容*/ }}"

这就是刚刚注册的实例节点。从代码来看这里是在对所有监听的 `this.listeners` 迭代执行，从这儿在往上的代码都是 Zookeeper 的内部逻辑了，此时我们关注的目标变成了 **`ZookeeperServiceWatch` 在什么时候添加到 `TreeCache` 的 `listeners` 中的？**

在 `TreeCache` 中，对外公开的 `listeners` 方法只有下面这一个：

public Listenable<TreeCacheListener> getListenable() { 
      return this.listeners;
    }

通过 `getListenable()` 就可以把自己的实现加入到这个列表中，搜索一下所有调用该方法的地方（IDEA 可以在方法名上按**鼠标滚轮**进行查找，也可以**Alt+F7**）。  
![在这里插入图片描述][2020112514034655.png_pic_center]  
我们想要查找的正是倒数第二个 `ZookeeperServiceWatch`，点击方法进入：

@Override
    public void onApplicationEvent(InstanceRegisteredEvent<?> event) { 
      this.cache = TreeCache.newBuilder(this.curator, this.properties.getRoot())
          .build();
      this.cache.getListenable().addListener(this);
      try { 
        this.cache.start();
      }
      catch (Exception e) { 
        ReflectionUtils.rethrowRuntimeException(e);
      }
    }

这是在一个实现了 `ApplicationListener` 的接口方法中调用的，Spring 中的事件由于和产生事件的代码进行了解耦，因此这里无法直接看出是哪儿触发的这里，通过直接查找 `new InstanceRegisteredEvent` 的地方可以找到，有时搜索不一定能找到，还可以使用更简单的方法。

在上面方法加断点，DEBUG重启，等待进入此断点：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 5]  
进入断点时的堆栈信息如上，红框中的内容是动态代理AOP的内容，直接忽略，查找下面最近一个堆栈 `doInvokeListener:172, SimpleApplicationEventMulticaster`，一层层往上找，直到下面的位置：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 6]

1.  可以看到这里创建 `new InstanceRegisteredEvent`
2.  当前执行代码在抽象类 `AbstractAutoServiceRegistration` 中 `start` 方法
3.  当前的实现类为 `ZookeeperAutoServiceRegistration`

> 此处还有另一个【简单分支】，后文分析。

继续看 `AbstractAutoServiceRegistration`，发现是从当前类中按照下面的方法顺序调用的：

1.  `void onApplicationEvent(WebServerInitializedEvent event)`
2.  `void bind(WebServerInitializedEvent event)`
3.  `void start()`

事件触发的源头是 `WebServerInitializedEvent`，再一层层往上找到如下位置：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 7]  
继续往上查找最终看到项目中使用的 `AnnotationConfigServletWebServerApplicationContext`，当项目使用 `SERVLET` 时创建的这个类型：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 8]  
`this.webApplicationType` 在启动时判断的：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 9]  
当项目中存在这两个类时，就认为是 `SERVLET`。想要有这两个类，最简单的方法就是添加下面的依赖：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

这个依赖会引入 `tomcat`，里面包含了 `javax.servlet.Servlet`，在 `spring-web` 中存在 `ConfigurableWebApplicationContext` 类。

`spring-boot-starter-web` 部分依赖树如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 10]

**发现问题的原因：** 到这里时已经找到了为什么我自己代码中无法监听了，是因为改造的代码中只需要 Dubbo 服务，不需要 Web，因此没有添加上面的依赖，因此就无法将 `ZookeeperServiceWatch` 添加到监听列表中，也就收不到后续的任何事件了。

### 简单分支 ###

前面提到了一个简单的分支，对整个过程也到了重要的作用，就是下面的类：

public class ZookeeperAutoServiceRegistration
    		extends AbstractAutoServiceRegistration<ZookeeperRegistration> {

前面说到通过 `AbstractAutoServiceRegistration` 中 `start` 方法将自己添加到了监听列表。这个类本身是通过下面的方式注册的：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 11]  
当没有实例 `"org.springframework.cloud.zookeeper.discovery.ZookeeperLifecycle"`，没有配置 `"spring.cloud.service-registry.auto-registration.enabled"` 或者配置为 `true` 时，这个类都会生效。

## 总结 ##

通过本文逆向分析的过程解决了遇到的问题，同时也了解了事件的部分处理过程。本文分析的这个过程是最重要的，*由于 Spring 框架中的 IOC、AOP以及各种为了扩展性使用的设计模式、解耦和异步调用的逻辑*，直接通过源码看调用时不知道具体的实现是哪一个， **但是逆向分析时，你看到的都是具体的某一个实例的执行。** 通过具体实例的执行，看到的也许只是正向过程的一个分支。通过逆向得到的执行路径，反着来看就是一个正向的路径，知道一个正向路径后就可以在正向分析时，再探索其他的分支路径。通过逆向和正向的反复结合，最终弄清理解代码，解决问题，实现扩展等方面的需求。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/f261942d203d418aab7b8f5c34b1c509.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/2020112513354657.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/20201125134023396.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 3]: https://img-blog.csdnimg.cn/20201125134410613.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 4]: https://img-blog.csdnimg.cn/20201125135312578.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center
[2020112514034655.png_pic_center]: https://img-blog.csdnimg.cn/2020112514034655.png#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 5]: https://img-blog.csdnimg.cn/20201125141333387.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 6]: https://img-blog.csdnimg.cn/20201125141758169.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 7]: https://img-blog.csdnimg.cn/20201125142500675.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 8]: https://img-blog.csdnimg.cn/20201125142952478.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 9]: https://img-blog.csdnimg.cn/20201125143123456.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 10]: https://img-blog.csdnimg.cn/20201125143726806.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM_size_16_color_FFFFFF_t_70_pic_center 11]: https://img-blog.csdnimg.cn/20201125145352757.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2lzZWE1MzM=,size_16,color_FFFFFF,t_70#pic_center