如何让dubbo自动加载自定义Filter

Dubbo的Filter机制,是专门为服务提供方和服务消费方调用过程进行拦截设计的,每次远程方法执行,该拦截都会被执行。这样就为开发者提供了非常方便的扩展性,比如为dubbo接口实现ip白名单功能、监控功能等等。

自定义FIlter实现方法很简单,分为3个步骤:
1、自定义Filter,必须继承com.alibaba.dubbo.rpc.Filter接口
2、在resources目录下添加纯文本文件META-INF/dubbo/com.alibaba.dubbo.rpc.Filter,内容写成 xxx=xxx.xxx.xxxFilter
3、在dubbo配置xml中添加 <dubbo:provider filter="xxxFilter" /> 或者 <dubbo:consumer filter="xxxFilter" /> 使Filter生效。

考虑到最近要做一个部门自研的流控平台,需要对dubbo进行限速、降级等等,就需要使用自定义的Filter来拦截请求实现功能,所以我需要把这部分封装成api实现。但是如果按照上面的配置方法,使用方需要引入jar包后,还得添加激活Filter的配置,对代码还是有侵入的,所以,有没有一种方式可以使Filter自动生效且不需要额外配置的呢?

我注意到dubbo原生的Filter就不需要激活直接默认就可以生效,比对了Filter之间的不同,注意到了 @Activate 这个注解,查看注解的说明,如图:


Activate注解

使用了Activate注解,dubbo就会把注释的Filter作为dubbo原生的Filter自动加载,而不需要显示的配置provider或者consumer的filter。

但如果我不希望filter自动加载要如何处理呢,可以使用<dubbo:consumer filter="-xxxFilter" /> ,也就是在filter前添加 “-” 来关闭filter的加载。

扩展知识:


group和order是做什么的?

如上图,注解 @Activate 当中有group,order属性,这两个属性都是做什么的呢?

下面放一段源码,getActivateExtension是加载所有filter配置的方法。

    List<T> exts = new ArrayList<T>();
    // 所有用户自己配置的filter信息
    List<String> names = values == null ? new ArrayList<String>(0) : Arrays.asList(values);
    // 如果这些名称里不包括去除default的标志(-default),就是默认加载所有的默认filter
    if (! names.contains(Constants.REMOVE_VALUE_PREFIX + Constants.DEFAULT_KEY)) {
        // 加载extension信息到
        getExtensionClasses();
        for (Map.Entry<String, Activate> entry : cachedActivates.entrySet()) {
            // name指的是SPI读取的配置文件的key
            String name = entry.getKey();
            Activate activate = entry.getValue();
            // group主要是区分是在provider端生效还是consumer端生效,一个filter可以既是consumer又是provider
            if (isMatchGroup(group, activate.group())) {
                T ext = getExtension(name);
                // 这里以Filter为例:三个判断条件的含义依次是:
                // 1. 用户配置的filter列表中不包含当前ext
                // 2. 用户配置的filter列表中不包含当前ext的加-的key
                // 3. 如果用户的配置信息(url中体现)中有可以激活的配置key并且数据不为0,false,null,N/A,也就是说有正常的使用
                if (! names.contains(name)
                        && ! names.contains(Constants.REMOVE_VALUE_PREFIX + name) 
                        && isActive(activate, url)) {
                    exts.add(ext);
                }
            }
        }
        // 根据Activate注解上的order排序
        Collections.sort(exts, ActivateComparator.COMPARATOR);
    }
    // 以上为加载原生filter,下面处理用户自己扩展的Filter
    List<T> usrs = new ArrayList<T>();
    for (int i = 0; i < names.size(); i ++) {
        String name = names.get(i);
        // 如果单个name不是以-开头并且所有的key里面并不包含-'name'
        if (! name.startsWith(Constants.REMOVE_VALUE_PREFIX)
                && ! names.contains(Constants.REMOVE_VALUE_PREFIX + name)) {
            // 可以通过default关键字替换Dubbo原生的Filter链,主要用来控制调用链顺序
            if (Constants.DEFAULT_KEY.equals(name)) {
                if (usrs.size() > 0) {
                    exts.addAll(0, usrs);
                    usrs.clear();
                }
            } else {
                // 加入用户自己定义的扩展Filter
                T ext = getExtension(name);
                usrs.add(ext);
            }
        }
    }
    if (usrs.size() > 0) {
        exts.addAll(usrs);
    }
    return exts;
}

从代码中可以清晰的看到,group是用来区分是consumer还是provider端生效,order是用来控制filter的执行顺序的。

默认filter链,先执行原生filter,再依次执行自定义filter,继而回溯到原点。


那么根据上面的了解,尝试回答下面两个问题:

1、注解@Activate是否是Dubbo Filter必须的,其上的group和order分别扮演什么样的角色?

对于Dubbo原生自带的filter,注解@Activate是必须,其group用于provider/consumer的站队,而order值是filter顺序的依据。但是对于自定义filter而言,注解@Activate没被用到,其分组和顺序,完全由用户手工配置指定。如果自定义filter添加了@Activate注解,并指定了group了,则这些自定义filter将升级为原生filter组。

2、Filter的顺序是否可以调整, 如何实现?

可以调整,通过'-'符号可以去除某些filter,而default代表默认激活的原生filter子链,通过重排default和自定义filter的顺序,达到实现顺序控制的目的。

让我们来构建几个case,来看看如何配置能满足。假定自定义filter的对象为filter1,filter2:
case 1: 其执行顺序为, 原生filter子链->filter1→filter2

<dubbo:reference filter="filter1,filter2"/>

case 2: 其执行顺序为, filter1->filter2->原生filter子链

<dubbo:reference filter="filter1,filter2,default"/>

case 3: 其执行顺序为, filter1->原生filter子链->filter2, 同时去掉原生的xxxFilter
<dubbo:service filter="filter1,default,filter2,-xxx"/>

以上就是在实现自定义filter时学到的一些东西,欢迎指正。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,179评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,229评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,032评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,533评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,531评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,539评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,916评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,813评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,568评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,654评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,354评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,937评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,918评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,152评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,852评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,378评论 2 342

推荐阅读更多精彩内容

  • Dubbo是什么 Dubbo是Alibaba开源的分布式服务框架,它最大的特点是按照分层的方式来架构,使用这种方式...
    Coselding阅读 17,164评论 3 196
  • 0 准备 安装注册中心:Zookeeper、Dubbox自带的dubbo-registry-simple;安装Du...
    七寸知架构阅读 13,966评论 0 88
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • 门打开了,从外头进来一人,也是个高个头,走着碎步,踉踉跄跄,摔了一跤,又站起来,这手里提着一个酒瓶,是喝得有些小醉...
    chi樂22阅读 308评论 2 0
  • 沈涛守着林曼,她眉头深锁,睡梦中喃喃呓语,沈涛忍不住轻拍她,六年了,她还是摆脱不了梦魔,叫他如何是好?他们的女儿静...
    清风喃语阅读 243评论 0 2