（十六）soul源码的自定义插件

（（十六）soul源码的自定义插件

目标

• soul的本身提供的插件

soul的本身提供的插件

说明

• 插件是 soul 网关的核心执行者，每个插件在开启的情况下，都会对匹配的流量，进行自己的处理。

• 在soul 网关里面，插件其实分为2 类：

  • 一类是单一职责的调用链，不能对流量进行自定义的筛选。

  • 另一类，能对匹配的流量，执行自己的职责调用链。

插件类别

单一职责原插件

首先需要实现org.dromara.soul.plugin.api.SoulPlugin

   Mono<Void> execute(ServerWebExchange exchange, SoulPluginChain chain);

   int getOrder();

   default String named() {
       return "";
   }
   default Boolean skip(ServerWebExchange exchange) {
       return false;
   }

• 接口方法详细说明
  • execute() 方法为核心的执行方法，用户可以在里面自由的实现自己想要的功能。
  • getOrder() 指定插件的排序。
  • named() 指定插件的名称。
  • skip() 在特定的条件下，该插件是否被跳过。

比配流程处理插件

首先需要继承org.dromara.soul.plugin.base.AbstractSoulPlugin

• 详细讲解：
  • 继承该类的插件，插件会进行选择器规则匹配，那如何来设置呢？
  • 首先在 soul-admin 后台 –>插件管理中，新增一个插件，注意 名称与 你自定义插件的 named() 方法要一致。
  • 重新登陆 soul-admin 后台 ，你会发现在插件列表就多了一个你刚新增的插件，你就可以进行选择器规则匹配
  • 在规则中，有个 handler 字段，是你自定义处理数据，在 doExecute() 方法中，通过 final String ruleHandle = rule.getHandle(); 获取，然后进行你的操作。

自定义单一职责插件

由于单一职责插件不需要流量控制，所以不需要插件开关，只在请求的执行链路里做一些处理，比如GlobalPlugin插件根据原始请求信息构造soulContext对象，WebClientPlugin插件向真实业务实例发送http请求等。

• 我们设计实现一个接口环绕打印日志的插件

• 新建 soul-plugin-around 模块
  在soul-plugin模块下建立子模块 soul-plugin-around
  

• soul-plugin-around的pom.xml信息

关键把soul-plugin-api添加依赖

   <parent>
       <artifactId>soul-plugin</artifactId>
       <groupId>org.dromara</groupId>
       <version>2.2.1</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>

   <artifactId>soul-plugin-around-log</artifactId>

   <dependencies>
       <dependency>
           <groupId>org.dromara</groupId>
           <artifactId>soul-plugin-api</artifactId>
           <version>${project.version}</version>
       </dependency>
       <dependency>
           <groupId>org.dromara</groupId>
           <artifactId>soul-common</artifactId>
           <version>${project.version}</version>
       </dependency>
       <dependency>
           <groupId>org.springframework</groupId>
           <artifactId>spring-test</artifactId>
           <scope>test</scope>
       </dependency>
       <dependency>
           <groupId>io.projectreactor</groupId>
           <artifactId>reactor-test</artifactId>
           <scope>test</scope>
       </dependency>
   </dependencies>

• 创建AroundLogPlugin具体实现

执行execute方法，把时间设置到上下文中，然后打印开始日志，然后通过Mono.then方法，打印结束日志，通过exchange上下文统计链路执行耗时。
.then：是在其他责任链都执行完后，才会执行操作

  @Override
   public String named() {
       return PluginEnum.AROUNDLOG.getName();
   }

   @Override
   public Mono<Void> execute(ServerWebExchange exchange,SoulPluginChain chain){
       exchange.getAttributes().put(START_TIME, System.currentTimeMillis());

       log.info("AroundPlugin start executing...");

       return chain.execute(exchange)
               .then(Mono.defer(() -> {
                   Long startTime = exchange.getAttribute(START_TIME);
                   log.info("AroundLogPlugin end. Total execution time: {} ms", System.currentTimeMillis() - startTime);
                   return Mono.empty();
               }));
   }

   @Override
       return PluginEnum.AROUNDLOG.getCode();
   public int getOrder() {
   }

新增项目soul-spring-boot-starter-plugin-around-log

• 依赖如下

 <dependencies>
       <dependency>
           <groupId>org.dromara</groupId>
           <artifactId>soul-plugin-around-log</artifactId>
           <version>${project.version}</version>
       </dependency>
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter</artifactId>
       </dependency>
   </dependencies>

• 新增类AroundLogPluginConfiguration，初始化AroundLogPlugin，加入到是spring容器中

注意：@ConditionalOnClass(AroundLogPlugin.class) 要加上，不然插件不能初始化，
@ConditionalOnClass ： classpath中存在该类时起效

@Configuration
@ConditionalOnClass(AroundLogPlugin.class)
public class AroundLogPluginConfiguration {
   
   /**
    * Waf plugin soul plugin.
    *
    * @return the soul plugin
    */
   @Bean
   public SoulPlugin aroundLogPlugin() {
       return new AroundLogPlugin();
   }
}

• AroundLogPluginConfiguration怎么从源头加载起来的
  springboot的启动注解@SpringBootApplication，源码里面有包含三个注解
  @SpringBootConfiguration #用于spring的xml配置信息加入到springIOC容器的配置类
  @EnableAutoConfiguration #最重要：从classpath中找所有spring.factories文件，并将其中的配置项信息通过反射实例化有类上标注了@Configuration的Java文件，然后汇总并加载到IOC容器中，

• Spring Cloud常用的注解的含义

执行顺序
@AutoConfigureAfter：在指定的配置类初始化后再加载
@AutoConfigureBefore：在指定的配置类初始化前加载
@AutoConfigureOrder：数越小越先初始化
条件配置
@ConditionalOnClass ： classpath中存在该类时起效
@ConditionalOnMissingClass ： classpath中不存在该类时起效
@ConditionalOnBean ： DI容器(控制反转（IoC）容器)中存在该类型Bean时起效
@ConditionalOnMissingBean ： DI容器中不存在该类型Bean时起效
@ConditionalOnSingleCandidate ： DI容器中该类型Bean只有一个或@Primary的只有一个时起效
@ConditionalOnExpression ： SpEL表达式结果为true时
@ConditionalOnProperty ： 参数设置或者值一致时起效
@ConditionalOnResource ： 指定的文件存在时起效
@ConditionalOnJndi ： 指定的JNDI存在时起效
@ConditionalOnJava ： 指定的Java版本存在时起效
@ConditionalOnWebApplication ： Web应用环境下起效
@ConditionalOnNotWebApplication ： 非Web应用环境下起效

在soulbootstrap添加依赖

    <dependency>
           <groupId>org.dromara</groupId>
           <artifactId>soul-spring-boot-starter-plugin-around-log</artifactId>
           <version>${project.version}</version>
    </dependency>

测试日志如下图

总结