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注解,dubbo就会把注释的Filter作为dubbo原生的Filter自动加载,而不需要显示的配置provider或者consumer的filter。
但如果我不希望filter自动加载要如何处理呢,可以使用<dubbo:consumer filter="-xxxFilter" /> ,也就是在filter前添加 “-” 来关闭filter的加载。
扩展知识:
如上图,注解 @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时学到的一些东西,欢迎指正。