自定义匹配方式
本文介绍如何对 org.apache.shenyu.plugin.base.condition.strategy.MatchStrategy
进行自定义扩展。
- 新建一个工程,引入如下依赖:
<dependencies>
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-plugin-base</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>
- 新增一个类
CustomMatchStrategy
,继承org.apache.shenyu.plugin.base.condition.strategy.AbstractMatchStrategy
,实现org.apache.shenyu.plugin.base.condition.strategy.MatchStrategy
,添加注解org.apache.shenyu.spi.Join
。
/**
* This is custom match strategy.
*/
@Join
public class CustomMatchStrategy extends AbstractMatchStrategy implements MatchStrategy {
@Override
public Boolean match(final List<ConditionData> conditionDataList, final ServerWebExchange exchange) {
// 匹配逻辑实现
}
}
- 在工程的META-INF/services目录创建
org.apache.shenyu.plugin.base.condition.strategy.MatchStrategy
文件中添加如下内容:
${spi name}=${custom class path}
${spi name}
表示spi
的名称,${custom class path}
表示该类的全限定名。比如:
custom=xxx.xxx.xxx.CustomMatchStrategy
将工程打包,拷贝到网关 (bootstrap-bin) 的
lib
或ext-lib
目录。在
Apache ShenYu
网关管理系统 —> 基础配置 —> 字典管理, 找到字典编码为MATCH_MODE
,新增一条数据,注意字典名称要为:${spi name}
,图中的示例是custom
。
字典类型:
matchMode
;字典编码:
MATCH_MODE
;字典名称:
${spi name}
,填写自定义spi
的名称;字典值:使用时,下拉框的值,不要和现有的重复;
字典描述或备注信息:描述信息;
排序: 排序;
状态:打开或关闭。
- 在添加选择器或规则时,就可以使用自定义的匹配方式: