Davids原理探究：Dubbo过滤器原理

怼烎@ 2023-02-17 14:55 39阅读 0赞

### 文章目录 ###

*   *  Dubbo过滤器原理
     *   *  概述
         *  使用方式
         *   *  @Activate注解启用
             *  XML配置启用
         *  规则
         *  总体结构图
         *  作用列表
         *  过滤器链初始化的实现原理

## Dubbo过滤器原理 ##

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

> **关注可以查看更多粉丝专享blog~**

### 概述 ###

Dubbo过滤器提供了服务提供者和消费者的调用拦截，即每次执行RPC调用的时候，对应的过滤器都会生效。虽然过滤器功能强大，但由于每次调用的时候都会执行，因此在使用的时候需要注意它对性能的影响。

### 使用方式 ###

在Dubbo中又很多内置过滤器，并且大多数都是使用@Activate注解默认启用的，比如ContextFilter。对于自行扩展的过滤器有以下两种启用方式。

#### @Activate注解启用 ####

在自定义的过滤器类上添加@Activate(group = Constants.PROVIDER/CONSUMER, order = -10000)注解即可，group标识是提供者/消费者过滤器，order标识优先级（越小越先执行）。

#### XML配置启用 ####

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

### 规则 ###

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

### 总体结构图 ###

![Dubbo过滤器总体结构图][Dubbo]

### 作用列表 ###

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

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

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

// ProtocolFilterWrapper类
    @Override
    public <T> Exporter<T> export(Invoker<T> invoker) throws RpcException {
        
        if (Constants.REGISTRY_PROTOCOL.equals(invoker.getUrl().getProtocol())) {
        
            return protocol.export(invoker);
        }
        // 标识自己是provider
        return protocol.export(buildInvokerChain(invoker, Constants.SERVICE_FILTER_KEY, Constants.PROVIDER));
    }
    
    @Override
    public <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException {
        
        if (Constants.REGISTRY_PROTOCOL.equals(url.getProtocol())) {
        
            return protocol.refer(type, url);
        }
        // 标识自己是consumer
        return buildInvokerChain(protocol.refer(type, url), Constants.REFERENCE_FILTER_KEY, Constants.CONSUMER);
    }

ProtocolFilterWrapper\#buildInvokerChain总的来说分为两步：

1.  获取并遍历所有过滤器。通过[Dubbo SPI][]ExtensionLoader\#getActivateExtension方法获取所有的过滤器并遍历。
2.  使用装饰器模式，增强原有的Invoker，组装过滤器链。

private static <T> Invoker<T> buildInvokerChain(final Invoker<T> invoker, String key, String group) {
        
        Invoker<T> last = invoker;
        // 获取所有的过滤器，包括有@Activate注解默认启动的和用户在XML中自定义的
        List<Filter> filters = ExtensionLoader.getExtensionLoader(Filter.class).getActivateExtension(invoker.getUrl(), key, group);
        if (!filters.isEmpty()) {
        
        	// 对过滤器做倒排遍历，从尾到头
            for (int i = filters.size() - 1; i >= 0; i--) {
        
                final Filter filter = filters.get(i);
                // 将实际的调用invoker放到最后面
                // 比如过滤器有A、B、C，则先放last（实际invoker）然后再放C，此时会变成C->Invoker
                // 然后再放B，变成B->C->Invoker，最后放A，此时变成A->B->C->Invoker调用链组装完成
                final Invoker<T> next = last;
                last = new Invoker<T>() {
        
    
                    ...
    
                    @Override
                    public Result invoke(Invocation invocation) throws RpcException {
        
                        return filter.invoke(next, invocation);
                    }
    
                    ...
                    
                };
            }
        }
        return last;
    }

相关文章：  
[Davids原理探究：Dubbo源码编译（2.7.8）][Davids_Dubbo_2.7.8]  
[Davids原理探究：Dubbo SPI和Java SPI实现原理][Dubbo SPI]  
[Davids原理探究：Dubbo注册中心（ZooKeeper、Redis）实现原理][Davids_Dubbo_ZooKeeper_Redis]  
[Davids原理探究：Dubbo配置解析原理][Davids_Dubbo]  
[Davids原理探究：Dubbo服务暴露原理][Davids_Dubbo 1]  
[Davids原理探究：Dubbo服务消费原理][Davids_Dubbo 2]  
[Davids原理探究：Dubbo优雅停机原理解析][Davids_Dubbo 3]  
[Davids原理探究：Dubbo调用流程图][Davids_Dubbo 4]  
[Davids原理探究：Dubbo路由实现原理][Davids_Dubbo 5]  
[Davids原理探究：Dubbo负载均衡实现原理][Davids_Dubbo 6]  
[Davids原理探究：Dubbo过滤器原理][Davids_Dubbo 7]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70_pic_center]: https://img-blog.csdnimg.cn/20200817133535505.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70#pic_center
[Dubbo]: https://img-blog.csdnimg.cn/20200614180909771.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[Dubbo SPI]: https://blog.csdn.net/Davids_/article/details/106611949
[Davids_Dubbo_2.7.8]: https://blog.csdn.net/Davids_/article/details/106603254
[Davids_Dubbo_ZooKeeper_Redis]: https://blog.csdn.net/Davids_/article/details/106590954
[Davids_Dubbo]: https://blog.csdn.net/Davids_/article/details/106951976
[Davids_Dubbo 1]: https://blog.csdn.net/Davids_/article/details/106669184
[Davids_Dubbo 2]: https://blog.csdn.net/Davids_/article/details/106951941
[Davids_Dubbo 3]: https://blog.csdn.net/Davids_/article/details/106952238
[Davids_Dubbo 4]: https://blog.csdn.net/Davids_/article/details/106721401
[Davids_Dubbo 5]: https://blog.csdn.net/Davids_/article/details/106709918
[Davids_Dubbo 6]: https://blog.csdn.net/Davids_/article/details/106720555
[Davids_Dubbo 7]: https://blog.csdn.net/Davids_/article/details/106750014