Dubbo Filter 过滤器（拦截器）的使用——dubbo.rpc.Filter

太过爱你忘了你带给我的痛 2023-07-13 08:29 27阅读 0赞

# com.alibaba.dubbo.rpc.Filter简介 #

咱们先说说 “Filter”，顾名思义 过滤器，在我们平时的工作中也是一员猛将。  
在之前的文章中我也介绍了在Spring中类似的[HandlerInterceptor的使用方法][HandlerInterceptor]。  
com.alibaba.dubbo.rpc.Filter它换了个马甲，干的依然是守门（过滤器）的活儿，不过是跑去阿里上班了，在dubbo干起了守门保安，做事低调所以认识他的猿并不多，远不如javax.servlet.Filter和HandlerInterceptor 名声在外，儿孙遍地，打麻将都还多几个在旁边买马。

> 废话扯完，进入正题，我就拿我这边的夸系统打印业务流水号来介绍。业务背景是找问题查日志经常涉及到夸系统查询 可是到了另一个系统我如何迅速找到对应的日志 在日志量庞大的情况下靠时间来筛选是十分低效且愚蠢的。所以咱们每个HTTP请求分配一个唯一的UUID，在Dubbo接口调用的过程中将UUID携带过去保证UUID不变实现日志迅速定位。

# 1、定义Filter #

*  实现com.alibaba.dubbo.rpc.Filter接口。
 *  添加Activate，其注解含义如下：
    
     *  group ：所属组 例如消费者、服务提供者 啥的
     *  order ：多个Filter的执行顺序 （越小越早）

package com.test.trace.remote.filter;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.slf4j.MDC;
    
    import com.alibaba.dubbo.common.Constants;
    import com.alibaba.dubbo.common.extension.Activate;
    import com.alibaba.dubbo.rpc.Filter;
    import com.alibaba.dubbo.rpc.Invocation;
    import com.alibaba.dubbo.rpc.Invoker;
    import com.alibaba.dubbo.rpc.Result;
    import com.alibaba.dubbo.rpc.RpcContext;
    import com.alibaba.dubbo.rpc.RpcException;
    import com.test.trace.support.AbstractMyThreadContext;
    import com.test.trace.support.AbstractUUIDShort;
    
    
    @Activate(group = {Constants.CONSUMER, Constants.PROVIDER}, order = -30000)
    public class RemoteTraceIdFilter implements Filter {
        protected final Logger log = LoggerFactory.getLogger(this.getClass());
    
        @Override
        public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
           //判断是消费者  还是 服务提供者
            if (RpcContext.getContext().isConsumerSide()) {
                //消费者 将trace_id（业务流水号） set至上下文中
                RpcContext.getContext().setAttachment(AbstractMyThreadContext.TRACE_ID,
                        AbstractMyThreadContext.getTraceId());
            } else {
                //取出业务流水号
                String traceId =
                        RpcContext.getContext().getAttachment(AbstractMyThreadContext.TRACE_ID);
                if (traceId == null) {
                    traceId = AbstractUUIDShort.generate();
                }
                //流水号set至线程局部变量
                AbstractMyThreadContext.setTraceId(traceId);
                //slf4j 中设置了日志打印格式用作日志链路追踪
                MDC.put(AbstractMyThreadContext.MDC_TRACE_ID, traceId);
            }
            try {
                return invoker.invoke(invocation);
            } finally {
                if (RpcContext.getContext().isProviderSide()) {
                    MDC.remove(AbstractMyThreadContext.MDC_TRACE_ID);
                    AbstractMyThreadContext.removeTraceId();
                }
            }
        }
    }

# 2、取个名 #

*  在resources目录下新建META-INF文件夹，然后建立子文件夹dubbo,最后新建文件com.alibaba.dubbo.rpc.Filter。（**敲黑板划重点拉！这里不要弄错了**）
 *  为你的过滤器起个名并附上对应的过滤器实现类的路径，如下图就取名为traceId（这里的名大家根据业务自己起名字）  
    ![文件目录名字][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaWJvX2x2_size_16_color_FFFFFF_t_70]

# 3、去守门 #

*  去具体的项目中 找到 你们的dubbo配置文件加上如下配置
 *  filter 也就是咱们第二步在文件中取的别名

<dubbo:provider filter="traceId" />
    <dubbo:consumer filter="traceId" />

到这个dubbo中Filter的简单适用方法大家应该有所了解可以上手使用了。  
如果有需要整套日志链路追踪的 可以等我下一篇文章中贴出剩下的代码 。

# 4、番外篇 #

大家现在都用的maven 这里有个小坑需要注意 还是提前说下。如果不注意可能会报：No such extension xxxFilter for filter/com.alibaba.dubbo.rpc.Filter错误  
错误内容是找不到xxxFilter，有可能是你的pom中指定了resources下需要打包的文件类型,修改成.\*结尾就好了。代码如下

<resource>
    	<directory>${basedir}/src/main/resources</directory>
    	<filtering>true</filtering>
    	<includes>
    		<include>**/*.*</include>
    	</includes>
    </resource>

[HandlerInterceptor]: https://blog.csdn.net/zhibo_lv/article/details/81699360
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaWJvX2x2_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200311153137911.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaWJvX2x2,size_16,color_FFFFFF,t_70