插件扩展

    • 插件是 网关的核心执行者，每个插件在开启的情况下，都会对匹配的流量，进行自己的处理。
    • 在 Apache ShenYu 网关里面，插件分为两类。
      • 一类是单一职责的调用链，不能对流量进行自定义的筛选。
      • 一类是能对匹配的流量，执行自己的职责调用链。
    • 用户可以参考 模块，新增自己的插件处理，如果有好的公用插件，可以向官网提交pr。
    • 引入如下依赖：
    • 用户新增一个类 MyShenyuPlugin，直接实现 org.apache.shenyu.plugin.api.ShenyuPlugin
    1. public interface ShenyuPlugin {
    4.     /**
    5.      * Process the Web request and (optionally) delegate to the next
    6.      * {@code WebFilter} through the given {@link ShenyuPluginChain}.
    7.      *
    8.      * @param exchange the current server exchange
    9.      * @param chain    provides a way to delegate to the next filter
    10.      * @return {@code Mono<Void>} to indicate when request processing is complete
    11.      */
    12.     Mono<Void> execute(ServerWebExchange exchange, ShenyuPluginChain chain);
    15.     /**
    16.      * return plugin order .
    17.      * This attribute To determine the plugin execution order in the same type plugin.
    18.      *
    19.      * @return int order
    20.      */
    21.     int getOrder();
    24.     /**
    25.      * acquire plugin name.
    26.      * this is plugin name define you must Provide the right name.
    27.      * if you impl AbstractShenyuPlugin this attribute not use.
    28.      *
    29.      * @return plugin name.
    30.      */
    31.     default String named() {
    32.         return "";
    33.     }
    36.     /**
    37.      * plugin is execute.
    38.      * if return true this plugin can not execute.
    39.      *
    40.      * @param exchange the current server exchange
    41.      * @return default false.
    42.      */
    43.     default Boolean skip(ServerWebExchange exchange) {
    44.         return false;
    45.     }
    46. }

      • getOrder() 指定插件的排序。

      • named() 指定插件的名称，命名采用Camel Case，如：dubbo、springCloud。

      • skip() 在特定的条件下，该插件是否被跳过。

    • 注册成Spring的bean，参考如下，或者直接在实现类上加 @Component 注解。

    1.     @Bean
    3.         return new MyShenyuPlugin();
    4.     }
    • 引入如下依赖：

    • 新增一个类 CustomPlugin，继承 org.apache.shenyu.plugin.base.AbstractShenyuPlugin

    1. /**
    2.  * This is your custom plugin.
    3.  * He is running in after before plugin, implement your own functionality.
    4.  * extends AbstractShenyuPlugin so you must user shenyu-admin And add related plug-in development.
    5.  *
    6.  * @author xiaoyu(Myth)
    7.  */
    8. public class CustomPlugin extends AbstractShenyuPlugin {
    11.     /**
    12.      * return plugin order .
    13.      * The same plugin he executes in the same order.
    14.      *
    15.      * @return int
    16.      */
    17.     @Override
    18.     public int getOrder() {
    19.         return 0;
    20.     }
    23.     /**
    24.      * acquire plugin name.
    25.      * return you custom plugin name.
    26.      * It must be the same name as the plug-in you added in the admin background.
    27.      *
    28.      * @return plugin name.
    29.      */
    30.     @Override
    31.     public String named() {
    32.         return "shenYu";
    33.     }
    36.     /**
    37.      * plugin is execute.
    38.      * Do I need to skip.
    39.      * if you need skip return true.
    40.      *
    41.      * @param exchange the current server exchange
    42.      * @return default false.
    43.      */
    44.     @Override
    45.     public Boolean skip(final ServerWebExchange exchange) {
    46.         return false;
    47.     }
    50.      * this is Template Method child has Implement your own logic.
    51.      *
    52.      * @param exchange exchange the current server exchange
    53.      * @param chain    chain the current chain
    54.      * @param selector selector
    55.      * @param rule     rule
    56.      * @return {@code Mono<Void>} to indicate when request handling is complete
    58.     @Override
    59.     protected abstract Mono<Void> doExecute(ServerWebExchange exchange, ShenyuPluginChain chain, SelectorData selector, RuleData rule) {
    60.         LOGGER.debug(".......... function plugin start..............");
    61.         /*
    62.          * Processing after your selector matches the rule.
    63.          * rule.getHandle() is you Customize the json string to be processed.
    64.          * for this example.
    65.          * Convert your custom json string pass to an entity class.
    66.          */
    67.         final String ruleHandle = rule.getHandle();
    70.         final Test test = GsonUtils.getInstance().fromJson(ruleHandle, Test.class);
    73.         /*
    74.          * Then do your own business processing.
    75.          * The last execution  chain.execute(exchange).
    76.          * Let it continue on the chain until the end.
    77.          */
    78.         System.out.println(test.toString());
    79.         return chain.execute(exchange);
    80.     }
    81. }

    • 详细讲解：

      • 继承该类的插件，插件会进行选择器规则匹配。

      • 首先在 shenyu-admin 后台管理系统 —> 基础配置 —> 插件管理 中，新增一个插件，注意 名称与 你自定义插件的 named() 方法要一致。

      • 重新登陆 shenyu-admin 后台，可以看见刚新增的插件，然后就可以进行选择器规则匹配。

      • 在规则中，有个 handler 字段，是自定义处理数据，在 doExecute() 方法中，通过 final String ruleHandle = rule.getHandle(); 获取，然后进行你的操作。

    • 注册成Spring的bean，参考如下或者直接在实现类上加 @Component 注解。

    1.     @Bean
    2.     public ShenyuPlugin customPlugin() {
    3.         return new CustomPlugin();
    4.     }
    • 新增一个类 PluginDataHandler，实现 org.apache.shenyu.plugin.base.handler.PluginDataHandler

    • 注册成Spring的bean，参考如下或者直接在实现类上加 @Component 注解。

    1. @Bean
    2. public PluginDataHandler pluginDataHandler() {
    3.     return new PluginDataHandler();
    4. }

    • 当使用此功能时候，上述扩展 ShenyuPlugin, PluginDataHandler, 不用成为 spring bean。只需要构建出扩展项目的jar包即可。

    • 使用以下配置：

    1. shenyu:
    2.   extPlugin:
    3.     path:  //加载扩展插件jar包路径
    4.     enabled: true //是否开启
    5.     threads: 1  //加载插件线程数量
    6.     scheduleTime: 300 //间隔时间（单位：秒）
    7.     scheduleDelay: 30 //网关启动后延迟多久加载（单位：秒）

    插件加载路径详解

    • 此路径是为存放扩展插件jar包的目录。

    • 可以使用 -Dplugin-ext=xxxx 指定，也可以使用 shenyu.extPlugin.path配置文件指定，如果都没配置，默认会加载网关启动路径下的 ext-lib目录。