Dubbo——过滤器概述

妖狐艹你老母 2021-08-30 18:56 529阅读 0赞

### Dubbo过滤器概述 ###

Dubbo中的过滤器和Web应用中的过滤器的概念是一样的，提供了在服务调用前后插入自定义逻辑的途径。过滤器是整个Dubbo框架中非常重要的组成部分，Dubbo中很多功能都是基于过滤器扩展而来的。过滤器提供了服务提供者和消费者调用过程的拦截，即每次都执行RPC调用的时候，对应的过滤器都会生效。虽然过滤器的功能强大，但由于每次调用时都会执行，因此在使用的时候需要注意它对性能的影响。

#### 过滤器的使用 ####

*  一种方式是使用@Active注解默认启用；
 *  一种方式是在配置文件中配置；

<dubbo:reference filter="xxx, yyy" />
    
    
    <dubbo:consumer filter="xxx, yyy" />
    
    
    <dubbo:service filter="xxx, yyy" />
    
    
    <dubbo:provider filter="xxx, yyy" />

配置上的“潜规则”：

1.  过滤器顺序：
    
     *  用户自定义的过滤器的顺序默认会在框架内置过滤器之后，可以使用`filter="xxx, default"`这种配置方式让自定义的过滤器顺序靠前。
     *  我们在配置`filter="xxx, yyy"`时，写在前面的xxx会比yyy的顺序要靠前。
2.  剔除过滤器。对于一些默认的过滤器或自动激活的过滤器，有些方法不想使用这些过滤器，可以使用`"-"`加过滤器名称来过滤，如`filter="-xxFilter"`会让xxFilter不生效。如果不想使用所有默认启用的过滤器，则可以配置`filter="-default"`来进行剔除。
3.  过滤器的叠加。如果服务提供者、消费者端都配置了过滤器，则两边的过滤器不会相互覆盖，而是互相叠加，都会生效。如果需要覆盖，则可以在消费方使用`"-"`的方式剔除对应的过滤器。

#### 过滤器的总体结构 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70]

所有的内置过滤器中除了CompatibleFilter特别突出，只继承了Filter接口，既不会被默认激活，其他的内置过滤器都使用了Activate注解，即默认被激活。Filter接口上有@SPI注解，说明过滤器是一个扩展点，用户可以基于这个扩展点接口实现自己的过滤器。

所有的过滤器会被分为消费者和服务提供者两种类型，消费者类型的过滤器只会在服务引用时被加入Inoker，服务提供者类型的过滤器只会在服务暴露的时候被加入对应的Invoker。MonitorFilter比较特殊，它会同时在暴露和引用被加入Invoker。

<table> 
 <thead> 
  <tr> 
   <th align="left">过滤器名</th> 
   <th align="left">作用</th> 
   <th align="left">使用方</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">AccessLogFilter</td> 
   <td align="left">打印每一次请求的访问日志。如果需要访问的日志只出现在指定的appender中，则可以在log的配置文件中配置additivity</td> 
   <td align="left">服务提供者</td> 
  </tr> 
  <tr> 
   <td align="left">ActiveLimitFilter</td> 
   <td align="left">用于限制消费者端对服务的最大并行调用数</td> 
   <td align="left">消费者</td> 
  </tr> 
  <tr> 
   <td align="left">ExecuteLimitFilter</td> 
   <td align="left">同上，用于限制服务端的最大并行调用数」服务提供者</td> 
   <td align="left"></td> 
  </tr> 
  <tr> 
   <td align="left">ClassLoaderFilter</td> 
   <td align="left">用于切换不同线程的类加载器，服务调用完成后会还原回去</td> 
   <td align="left">服务提供者</td> 
  </tr> 
  <tr> 
   <td align="left">CompatibleFilter</td> 
   <td align="left">用户使返回值与调用程序的对象版本兼容，默认不启用。如果启用，则会把JSON或fastjson类型的返回值转换为Map类型；如果返回类型和本地接口中定义的不同，则会做POJO的转换</td> 
   <td align="left">-</td> 
  </tr> 
  <tr> 
   <td align="left">ConsumerContextFilter</td> 
   <td align="left">为消费者把一些上下文信息设置到当前线程的RpcContext对象中，包括invocation、localhost、remote host等</td> 
   <td align="left">消费者</td> 
  </tr> 
  <tr> 
   <td align="left">ContextFilter</td> 
   <td align="left">同上，但是为服务提供者服务</td> 
   <td align="left">服务提供者</td> 
  </tr> 
  <tr> 
   <td align="left">DeprecatedFilter</td> 
   <td align="left">如果调用的方法被标记位已弃用，那么DeprecatedFilter将记录一个错误消息</td> 
   <td align="left">消费者</td> 
  </tr> 
  <tr> 
   <td align="left">EchoFilter</td> 
   <td align="left">用于echo测试</td> 
   <td align="left">服务提供者</td> 
  </tr> 
  <tr> 
   <td align="left">ExceptionFilter</td> 
   <td align="left">用于统一的异常处理，防止出现序列化失败</td> 
   <td align="left">服务提供者</td> 
  </tr> 
  <tr> 
   <td align="left">GenericFilter</td> 
   <td align="left">用于服务提供者端，实现泛化调用，实现序列化的检查和处理</td> 
   <td align="left">服务提供者</td> 
  </tr> 
  <tr> 
   <td align="left">GenericImplFilter</td> 
   <td align="left">同上，但用于消费者端</td> 
   <td align="left">消费者</td> 
  </tr> 
  <tr> 
   <td align="left">TimeoutFilter</td> 
   <td align="left">如果某些服务调用超时，则自动记录告警日志</td> 
   <td align="left">服务提供者</td> 
  </tr> 
  <tr> 
   <td align="left">TokenFilter</td> 
   <td align="left">服务提供者下令发牌给消费者，通常用于防止消费者绕过注册中心直接调用服务提供者</td> 
   <td align="left">服务提供者</td> 
  </tr> 
  <tr> 
   <td align="left">TpsLimitFilter</td> 
   <td align="left">用于服务端的限流，注意与ExecuteLimitFilter</td> 
   <td align="left">消费者</td> 
  </tr> 
  <tr> 
   <td align="left">FutureFilter</td> 
   <td align="left">在发起invoke或得到返回值、出现异常的时候触发回调事件</td> 
   <td align="left">消费者</td> 
  </tr> 
  <tr> 
   <td align="left">TraceFilter</td> 
   <td align="left">Trace指令的使用</td> 
   <td align="left">服务提供者</td> 
  </tr> 
  <tr> 
   <td align="left">MonitorFilter</td> 
   <td align="left">监控并统计所有的接口的调用情况，如成功、失败、耗时。后续DubboMonitor会定时把该过滤器收集的数据发送到Dubbo-Monitor服务上</td> 
   <td align="left">服务提供者+消费者</td> 
  </tr> 
 </tbody> 
</table>

每个过滤器的使用方不一样，有的是服务提供者使用，有的是消费者使用。Dubbo是如何保证服务提供者不会使用消费者的过滤器的呢？答案就在@Activate注解上，该注解可以设置过滤器激活的条件和顺序，如`@Activate(group = Constants.PROVIDER, order = -110000)`表示在服务提供端扩展点实现才有效，并且过滤器的顺序是 -110000.

#### 过滤器初始化的实现原理 ####

服务的暴露与引用会使用Protocol层，而ProtocolFilterWrapper包装类则实现了过滤器链的组装。在服务的暴露与引用过程中，会使用`ProtocolFilterWrapper#buildInvokerChain`方法组装整个过滤器链：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70 1]

buildInvokerChain方法构造调用链的步骤：

1.  获取并遍历所有过滤器。通过`ExtensionLoader#getActivateExtension`方法获取所有的过滤器并遍历。
2.  使用装饰器模式，增强原有Invoker，组装过滤器链。使用装饰器模式，像俄罗斯套娃一样，把过滤器一个又一个套到Invoker上。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70 2]

为什么要倒排遍历呢？

因为是通过从里到外构造匿名类的方式构造Invoekr的，所以只有倒排，最外层的Invoker才能是第一个过滤器。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70]: /images/20210813/7154d0c32c364753bcad9bd657221258.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70 1]: /images/20210813/0b79afdeda3b47619ecae7d036be3782.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvbGRfX19wbGF5_size_16_color_FFFFFF_t_70 2]: /images/20210813/ad6cf60a38dd4f9e9249b5b58e62bc4a.png