Dubbo Filter机制概述
微信公众号:[中间件兴趣圈]
作者简介:《RocketMQ技术内幕》作者
从上文可知,在服务的调用或消费端发送请求命令中,Dubbo引入过滤器链机制来实现功能的包装(或扩展)。Dubbo很多功能,例如泛化调用、并发控制等都是基于Filter机制实现的,系统默认的Filter在/dubbo-rpc-api/src/main/resources/META-INF/dubbo/internal/com.alibaba.dubbo.rpc.Filter文件中定义,内容如下:
1echo=com.alibaba.dubbo.rpc.filter.EchoFilter
2generic=com.alibaba.dubbo.rpc.filter.GenericFilter
3genericimpl=com.alibaba.dubbo.rpc.filter.GenericImplFilter
4token=com.alibaba.dubbo.rpc.filter.TokenFilter
5accesslog=com.alibaba.dubbo.rpc.filter.AccessLogFilter
6activelimit=com.alibaba.dubbo.rpc.filter.ActiveLimitFilter
7classloader=com.alibaba.dubbo.rpc.filter.ClassLoaderFilter
8context=com.alibaba.dubbo.rpc.filter.ContextFilter
9consumercontext=com.alibaba.dubbo.rpc.filter.ConsumerContextFilter
10exception=com.alibaba.dubbo.rpc.filter.ExceptionFilter
11executelimit=com.alibaba.dubbo.rpc.filter.ExecuteLimitFilter
12deprecated=com.alibaba.dubbo.rpc.filter.DeprecatedFilter
13compatible=com.alibaba.dubbo.rpc.filter.CompatibleFilter
14timeout=com.alibaba.dubbo.rpc.filter.TimeoutFilter
以其中一个来说明一下Filter的定义要素:
1/**
2 * EchoInvokerFilter
3 */
4 (group = Constants.PROVIDER, order = -110000) // @2
5public class EchoFilter implements Filter { // @1
6
7
8 public Result invoke(Invoker<?> invoker, Invocation inv) throws RpcException {
9 if (inv.getMethodName().equals(Constants.$ECHO) && inv.getArguments() != null && inv.getArguments().length == 1)
10 return new RpcResult(inv.getArguments()[0]);
11 return invoker.invoke(inv);
12 }
13}
代码@1:实现com.alibaba.dubbo.rpc.Filter接口。
代码@2:添加Activate,其注解含义如下:
group: 所属组,String[],例如消费端、服务端。
value String[],如果指定该值,只有当消费者或服务提供者URL中包含属性名为value的键值对,该过滤器才处于激活状态。
before:String[],用于指定执行顺序,before指定的过滤器在该过滤器之前执行。
after:string[],用于指定执行顺序,after指定的过滤器在该过滤器之后执行。
order:用户指定顺序,值越小,越先执行。
除了支持默认的过滤器外,Dubbo还支持自定义Filter,可以通过service.filter指定过滤器,多个用英文逗号隔开,其配置方法为:
1 < dubbo:service ......>
2 < dubbo:parameter key = "service.filter" value = "filter1,filer2,..."/>
3 < /dubbo:service>
当然,可以为所有服务提供者设置共用过滤器,其指定方法为:
1 < dubbo:provider ...>
2 < dubbo:parameter key = "service.filter" value = "filter1,filer2,..."/>
3 < /dubbo:provider>
消费端自定义过滤器的key为reference.filter,其使用方法在< dubbo:reference/>标签或< dubbo:consumer/>标签下定义属性。
关于自定义Filter的解析代码如下:
ExtensionLoader#getActivateExtension
1public List<T> getActivateExtension(URL url, String key, String group) { // @1
2 String value = url.getParameter(key); // @2
3 return getActivateExtension(url, value == null || value.length() == 0 ? null : Constants.COMMA_SPLIT_PATTERN.split(value), group); // @3
4}
代码@1:参数说明。
URL url:服务提供者或服务消费者url。
String key:过滤器属性key,服务提供者固定为:service.filter,服务消费者固定为reference.filter。
String group:服务提供者或服务消费者。
代码@2:从url中获取配置的自定义filter。
代码@3:如果value不为空,则将字符串调用split转换为数组,然后调用getActivateExtension方法,获取符合条件的过滤器。
ExtensionLoader#getActivateExtension
1public List<T> getActivateExtension(URL url, String[] values, String group) {
2 List<T> exts = new ArrayList<T>();
3 List<String> names = values == null ? new ArrayList<String>(0) : Arrays.asList(values);
4 if (!names.contains(Constants.REMOVE_VALUE_PREFIX + Constants.DEFAULT_KEY)) { // @1
5 getExtensionClasses(); // @2
6 for (Map.Entry<String, Activate> entry : cachedActivates.entrySet()) {
7 String name = entry.getKey();
8 Activate activate = entry.getValue();
9 if (isMatchGroup(group, activate.group())) { // @3
10 T ext = getExtension(name);
11 if (!names.contains(name)
12 && !names.contains(Constants.REMOVE_VALUE_PREFIX + name) // @4
13 && isActive(activate, url)) { // @5
14 exts.add(ext);
15 }
16 }
17 }
18 Collections.sort(exts, ActivateComparator.COMPARATOR);
19 }
20 List<T> usrs = new ArrayList<T>();
21 for (int i = 0; i < names.size(); i++) { // @6
22 String name = names.get(i);
23 if (!name.startsWith(Constants.REMOVE_VALUE_PREFIX)
24 && !names.contains(Constants.REMOVE_VALUE_PREFIX + name)) {
25 if (Constants.DEFAULT_KEY.equals(name)) {
26 if (!usrs.isEmpty()) {
27 exts.addAll(0, usrs);
28 usrs.clear();
29 }
30 } else {
31 T ext = getExtension(name);
32 usrs.add(ext);
33 }
34 }
35 }
36 if (!usrs.isEmpty()) {
37 exts.addAll(usrs);
38 }
39 return exts;
40 }
代码@1:如果配置的service.filter或referecnce.filter包含了-default,表示禁用系统默认提供的一系列过滤器。
代码@2:如果不禁用系统默认过滤器链,则首先加载所有默认过滤器。
代码@3:根据group刷选出适配的过滤器。
代码@4:也可以对单个filter进行禁用,其方法是-过滤器名称的方式。例如如想禁用AccessLogFilter,则可以通过-accesslog方式禁用。-key,key为/dubbo-rpc-api/src/main/resources/META-INF/dubbo/internal/com.alibaba.dubbo.rpc.Filter中定义的key。
代码@5:判断过滤器是否激活,其逻辑是如果Filter上的@Activate注解value值不为空,则需要判断url中是否包含键为value的属性对,存在则启用,不存在则不启用。
代码@6:加载用户自定义的Filter,也即是service.filter或reference.filter指定的过滤器。
综上所述,Dubbo提供了过滤器机制,在真实服务被调用前提供扩展点。Filter机制就简单介绍到这里了,从下文开始会重点分析Dubbo服务提供的核心Filter。
温馨提示:
如果需要自定过滤器,需要在自定的工程中META-INF/dubbo/internal/com.alibaba.dubbo.rpc.Filter文件中注册。
本文就介绍到这里了,从下篇开始将会根据Dubbo的功能特性来详细分析其实现过程,其本质都是各种Dubbo 过滤器器。
广告:作者新书《RocketMQ技术内幕》已上市
《RocketMQ技术内幕》已出版上市,目前可在主流购物平台(京东、天猫等)购买,本书从源码角度深度分析了RocketMQ NameServer、消息发送、消息存储、消息消费、消息过滤、主从同步HA、事务消息;在实战篇重点介绍了RocketMQ运维管理界面与当前支持的39个运维命令;并在附录部分罗列了RocketMQ几乎所有的配置参数。本书得到了RocketMQ创始人、阿里巴巴Messaging开源技术负责人、Linux OpenMessaging 主席的高度认可并作序推荐。目前是国内第一本成体系剖析RocketMQ的书籍。
新书7折优惠!7折优惠!7折优惠!
更多文章请关注微信公众号:
推荐关注微信公众号:RocketMQ官方微信公众号