自定义匹配方式

本文介绍如何对 org.apache.shenyu.plugin.base.condition.strategy.MatchStrategy 进行自定义扩展。

  • 新增一个类 CustomMatchStrategy，继承org.apache.shenyu.plugin.base.condition.strategy.AbstractMatchStrategy，实现 org.apache.shenyu.plugin.base.condition.strategy.MatchStrategy ，添加注解org.apache.shenyu.spi.Join。
  1. /**
  2.  * This is custom match strategy.
  3.  */
  4. @Join
  5. public class CustomMatchStrategy extends AbstractMatchStrategy implements MatchStrategy {
  8.     @Override
  9.     public Boolean match(final List<ConditionData> conditionDataList, final ServerWebExchange exchange) {
  10.         // 匹配逻辑实现
  11.     }
  12. }
  • 在org.apache.shenyu.plugin.base.condition.strategy.MatchStrategy文件中添加如下内容：
  1. ${spi name}=${custom class path}

${spi name}表示spi的名称，${custom class path}表示该类的全限定名。比如：

  1. custom=org.apache.shenyu.examples.http.strategy.CustomMatchStrategy
  • 在 org.apache.shenyu.common.enums.MatchModeEnum 类中添加枚举类型：
  3.     /**
  4.      * And custom mode enum.
  5.      */
  6.     CUSTOM(2, "custom"),
  • 在Apache ShenYu网关管理系统 —> 基础配置 —> 字典管理， 找到字典编码为 MATCH_MODE，新增一条数据，注意字典名称要为: ${spi name}，图中的示例是custom。

自定义匹配方式 - 图1

字典类型：matchMode；

字典编码：MATCH_MODE；

字典名称：${spi name}，填写自定义spi的名称；

字典值：使用时，下拉框的值，不要和现有的重复；

字典描述或备注信息：描述信息；

排序： 排序；

状态：打开或关闭。

  • 在添加选择器或规则时，就可以使用自定义的匹配方式：

自定义匹配方式 - 图2