SpringCloud+Dubbo实现自定义Filter，关键配置避免启动过滤器无效

SpringCloud+Dubbo整合自定义Filter实践

最新推荐文章于 2025-09-24 14:49:45 发布

原创最新推荐文章于 2025-09-24 14:49:45 发布 · 1.7k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#spring cloud #dubbo #filter #过滤器 #java

springcloud 专栏收录该内容

2 篇文章

订阅专栏

本文介绍了如何在SpringCloud和Dubbo中实现自定义Filter，并强调了@Activate注解的关键作用，以及避免启动时过滤器无效的配置步骤。通过创建META-INF/dubbo目录下的org.apache.dubbo.rpc.Filter文件，加入自定义类，可以简化配置，提高Filter的透明度。

关键：@Activate、CommonConstants.CONSUMER、CommonConstants.PROVIDER

直接上代码......................

服务提供方：

package com.weifor.xx.api.dubbo;

import com.weifor.util.WeiFor;
import lombok.extern.slf4j.Slf4j;
import org.apache.dubbo.common.constants.CommonConstants;
import org.apache.dubbo.common.extension.Activate;
import org.apache.dubbo.rpc.*;

import java.util.concurrent.CompletableFuture;

/**
 *
 * Dubbo过滤器，执行者
 *
 * Copyright http://www.weifor.com/
 * Author PangShuqiang
 * Blog https://blog.youkuaiyun.com/PangSir
 * Email pangshuqiang@163.com
 * QQ 127015919
 * Date: 2021/6/25
 */ 
@Slf4j
@Activate(group = CommonConstants.PROVIDER)
public class DubboProviderFilter implements Filter {
    @Override
    public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
        String appName = RpcContext.getContext().getAttachment(WebConstEnum.Model.SERVER_NAME);
        String currentPath = invoker.getUrl().getPath().concat("." + invocation.getMethodName());
        log.info("调用Dubbo服务，项目名称：{}", appName);
        if (true) {
            RpcContext.getContext().getAttachment("appName");
            return invoker.invoke(invocation);
        } else {
            log.error("调用Dubbo服务失败！Path：".concat(currentPath));
            CompletableFuture b = new CompletableFuture ();
            AsyncRpcResult asyncRpcResult = new AsyncRpcResult(b,invocation);
            asyncRpcResult.setValue("Provider 服务失败，Dubbo Provider 停止执行！Path：" + currentPath);
            return asyncRpcResult;
        }
    }
}

调用消费方：

package com.weifor.xx.api.dubbo;

import lombok.extern.slf4j.Slf4j;
import org.apache.dubbo.common.constants.CommonConstants;
import org.apache.dubbo.common.extension.Activate;
import org.apache.dubbo.rpc.*;

import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;

/**
 *
 * Dubbo过滤器，调用者
 *
 * Copyright http://www.weifor.com/
 * Author PangShuqiang
 * Blog https://blog.youkuaiyun.com/PangSir
 * Email pangshuqiang@163.com
 * QQ 127015919
 * Date: 2021/6/25
 */
@Slf4j
@Activate(group = CommonConstants.CONSUMER)
public class DubboConsumerFilter implements Filter {
    @Override
    public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
        // Result result = invoker.invoke(invocation);
        if (invoker.getUrl() == null) {
            log.error("调用Dubbo服务时，准备动作处理失败！");
            throw new RpcException("调用Dubbo服务时，准备动作处理失败！");
        }
        Class<?> serviceType = invoker.getInterface();
        Map attachments = invocation.getAttachments();
        log.info("[{}], [{}], [{}]", invoker.getInterface(), invocation.getMethodName(), Arrays.toString(invocation.getArguments()));

        String currentPath = invoker.getUrl().getPath().concat("." + invocation.getMethodName());
        if (true) {
            RpcContext.getContext().setAttachment("appName", "这个是你给我的！");

            return invoker.invoke(invocation);
        } else {
            log.error("调用Dubbo服务时失败！Path：".concat(currentPath));

            CompletableFuture b = new CompletableFuture ();
            AsyncRpcResult asyncRpcResult = new AsyncRpcResult(b,invocation);
            asyncRpcResult.setValue("Consumer 服务失败，Dubbo Consumer 停止调用！Path：" + currentPath);
            return asyncRpcResult;
        }
    }
}

关键配置，官方说明：https://dubbo.apache.org/docs/v2.7/dev/impls/filter/#m-docsv27devimplsfilter

无论是SpringCloud还是SpringBoot，均可按照Spring的SPI方式进行配置，具体可在项目Resource下执行：

1、建文件夹及文件：META-INF/dubbo/org.apache.dubbo.rpc.Filter，其中META-INF/dubbo是文件夹，org.apache.dubbo.rpc.Filter是文件名。（这个文件夹和文件名千万不要把“/”和“.”弄错了，不然Filter过滤器无效）

2、在org.apache.dubbo.rpc.Filter加入自定义类：

dubboConsumerFilter=com.weifor.xx.api.dubbo.DubboConsumerFilter
dubboProviderFilter=com.weifor.xx.api.dubbo.DubboProviderFilter

PS：

在@Activate没有出现之前，还需要在项目配置文件里（比如某个客户单位项目调用接口时）配置dubbo.consumer.filter和dubbo.provider.filter引用自定义dubboConsumerFilter、dubboProviderFilter，很麻烦也很容易忘记，现在增加了@Activate注释后，通过Spring提供的SPI机制，引入SPI配置文件META-INF/XX方式即可减少调用方的繁琐配置，让Filter的存在更加透明化。