如何在Spring Boot使用Dubbo Activate扩展点

[[190619]]

本文提纲

一、什么是 Dubbo Activate 注解

二、使用 Dubbo Activate

三、小结

继续上一篇:《Springboot 整合 Dubbo/ZooKeeper 》,在 Spring Boot 使用 Dubbo Activate 扩展点。这是一个群友问的,我总结下,分享给更多人。

运行环境:JDK 7 或 8,Maven 3.0+

技术栈:SpringBoot 1.5+、Dubbo 2.5+、ZooKeeper 3.3+

一、什么是 Dubbo Activate 注解

@Activate 是一个 Duboo 框架提供的注解。在 Dubbo 官方文档上有记载:

对于集合类扩展点,比如:Filter, InvokerListener, ExportListener, TelnetHandler, StatusChecker等, 可以同时加载多个实现,此时,可以用自动激活来简化配置。

用 @Activate 来实现一些 Filter ,可以具体如下:

1. 无条件自动激活

直接使用默认的注解即可

 
 
 
  1. import com.alibaba.dubbo.common.extension.Activate; 
  2. import com.alibaba.dubbo.rpc.Filter; 
  3.   
  4. @Activate // 无条件自动激活 
  5. public class XxxFilter implements Filter { 
  6.     // ... 

2. 配置 xxx 参数,并且参数为有效值时激活,比如配了cache="lru",自动激活 CacheFilter

 
 
 
  1. import com.alibaba.dubbo.common.extension.Activate; 
  2. import com.alibaba.dubbo.rpc.Filter; 
  3.   
  4. @Activate("xxx") // 当配置了xxx参数,并且参数为有效值时激活,比如配了cache="lru",自动激活CacheFilter。 
  5. public class XxxFilter implements Filter { 
  6.     // ... 

3. 只对提供方激活,group 可选 provider 或 consumer

 
 
 
  1. import com.alibaba.dubbo.common.extension.Activate; 
  2. import com.alibaba.dubbo.rpc.Filter; 
  3.   
  4. @Activate(group = "provider", value = "xxx")  
  5. // 只对提供方激活,group可选"provider""consumer" 
  6. public class XxxFilter implements Filter { 
  7.     // ... 

二、使用 Dubbo Activate 注解

基于以前的 springboot-dubbo-server 和 springboot-dubbo-client 工程,GitHub 地址:https://github.com/JeffLi1993/springboot-learning-example 。

这里我们在消费端,既 springboot-dubbo-client 工程上添加一个 Filter。代码如下:

 
 
 
  1. package com.xxx; 
  2.   
  3. import com.alibaba.dubbo.rpc.Filter; 
  4. import com.alibaba.dubbo.rpc.Invoker; 
  5. import com.alibaba.dubbo.rpc.Invocation; 
  6. import com.alibaba.dubbo.rpc.Result; 
  7. import com.alibaba.dubbo.rpc.RpcException; 
  8.   
  9.   
  10. public class XxxFilter implements Filter { 
  11.     public Result invoke(Invoker<?> invoker,  
  12. Invocation invocation) throws RpcException { 
  13.         // before filter ... 
  14.         Result result = invoker.invoke(invocation); 
  15.         // after filter ... 
  16.         return result; 
  17.     } 

启动 client 工程发现,Console 报错,出现:

 
 
 
  1. Caused by: java.lang.IllegalStateException: No such extension dubboConsumerFilter for filter/com.alibaba.dubbo.rpc.Filter 

发现这个 Filter 初始化时,报错了。证明没有配置成功。

原来根据官方文档中描述,我们需要配置扩展点配置文件。

Maven 工程项目目录结构:

 
 
 
  1. src 
  2.  |-main 
  3.     |-java 
  4.         |-com 
  5.             |-xxx 
  6.                 |-XxxFilter.java (实现Filter接口) 
  7.     |-resources 
  8.         |-META-INF 
  9.             |-dubbo 
  10.                 |-com.alibaba.dubbo.rpc.Filter  
  11. (纯文本文件,内容为:xxx=com.xxx.XxxFilter) 

在 配置:

xxx=com.xxx.XxxFilter

三、小结

调用拦截扩展的应用场景很多,比如黑白名单,比如 IP 等。

【本文为专栏作者“李强强”的原创稿件,转载请通过联系作者获取授权】

戳这里,看该作者更多好文

THE END