Spring Boot 中如何使用 Dubbo Activate 擴展點
本文提綱
一、什么是 Dubbo Activate 注解
二、使用 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. 無條件自動激活
直接使用默認的注解即可
- import com.alibaba.dubbo.common.extension.Activate;
- import com.alibaba.dubbo.rpc.Filter;
- @Activate // 無條件自動激活
- public class XxxFilter implements Filter {
- // ...
- }
2. 配置 xxx 參數,并且參數為有效值時激活,比如配了cache=”lru”,自動激活 CacheFilter
- import com.alibaba.dubbo.common.extension.Activate;
- import com.alibaba.dubbo.rpc.Filter;
- @Activate("xxx") // 當配置了xxx參數,并且參數為有效值時激活,比如配了cache="lru",自動激活CacheFilter。
- public class XxxFilter implements Filter {
- // ...
- }
3. 只對提供方激活,group 可選 provider 或 consumer
- import com.alibaba.dubbo.common.extension.Activate;
- import com.alibaba.dubbo.rpc.Filter;
- @Activate(group = "provider", value = "xxx")
- // 只對提供方激活,group可選"provider"或"consumer"
- public class XxxFilter implements Filter {
- // ...
- }
二、使用 Dubbo Activate 注解
基于以前的 springboot-dubbo-server 和 springboot-dubbo-client 工程,GitHub 地址:https://github.com/JeffLi1993/springboot-learning-example 。
這里我們在消費端,既 springboot-dubbo-client 工程上添加一個 Filter。代碼如下:
- package com.xxx;
- import com.alibaba.dubbo.rpc.Filter;
- import com.alibaba.dubbo.rpc.Invoker;
- import com.alibaba.dubbo.rpc.Invocation;
- import com.alibaba.dubbo.rpc.Result;
- import com.alibaba.dubbo.rpc.RpcException;
- public class XxxFilter implements Filter {
- public Result invoke(Invoker<?> invoker,
- Invocation invocation) throws RpcException {
- // before filter ...
- Result result = invoker.invoke(invocation);
- // after filter ...
- return result;
- }
- }
啟動 client 工程發現,Console 報錯,出現:
- Caused by: java.lang.IllegalStateException: No such extension dubboConsumerFilter for filter/com.alibaba.dubbo.rpc.Filter
發現這個 Filter 初始化時,報錯了。證明沒有配置成功。
原來根據官方文檔中描述,我們需要配置擴展點配置文件。
在 META-INF 中配置:
- xxx=com.xxx.XxxFilter
Maven 項目目錄結構
- src
- |-main
- |-java
- |-com
- |-xxx
- |-XxxFilter.java (實現Filter接口)
- |-resources
- |-META-INF
- |-dubbo
- |-com.alibaba.dubbo.rpc.Filter (純文本文件,內容為:xxx=com.xxx.XxxFilter)
三、小結
調用攔截擴展的應用場景很多,比如黑白名單,比如 IP 等。
【本文為51CTO專欄作者“李強強”的原創稿件,轉載請通過51CTO聯系作者獲取授權】