Soul网关源码学习系列之【divide插件】

Soul的插件设计

• 插件采用数据库设计，来存储插件，选择器，规则配置数据，以及对应关系。
• 数据库表UML类图:
  
• 设计详解:
  • 一个插件对应多个选择器，一个选择器对应多个规则。
  • 一个选择器对应多个匹配条件，一个规则对应多个匹配条件。
  • 每个规则在对应插件下，不同的处理表现为handle字段，handle字段就是一个json字符串。具体的可以在admin使用过程中进行查看。

Divide插件简介

• divide插件是网关处理 http协议请求的核心处理插件。
• divide插件是进行http正向代理的插件，所有http类型的请求，都是由该插件进行负载均衡的调用。
• 想更详细了解，可以参考官方文档。我这里还是主要看一下其代码实现。

Divide插件代码

• 整个Soul的代码结构还是比较清晰的，所以我们可以快速的定位到soul-plugin下的soul-plugin-divide
• 看一下我们的DividePlugin类，继承了AbstractSoulPlugin，这个是所有插件的一个父类，并且这个父类实现了SoulPlugin的接口。

  public class DividePlugin extends AbstractSoulPlugin {
       ...}
  

• 在插件的execute处打上断点，以便跟踪代码处理，断点进来后，可以发现程序是从SoulWebHandler的execute方法进来的。我们暂且认为这里是入口，因为实际请求是通过spring封装好的Netty过来的，这块后面再单独看。
• 那现在我们把焦点放在我们divide插件的execute方法上

  	@Override
      public Mono<Void> execute(final ServerWebExchange exchange, final SoulPluginChain chain) {
       
          String pluginName = named(); // 插件名称
          final PluginData pluginData = BaseDataCache.getInstance().obtainPluginData(pluginName); //根据插件名称获取插件信息，这里是把数据放在了一个Map中，前面有看过。
          if (pluginData != null && pluginData.getEnabled()) {
        // 判断插件是否开启，这个是我们后台管理页面里控制的。
              final Collection<SelectorData> selectors = BaseDataCache.getInstance().obtainSelectorData(pluginName);  // 拿到插件下的所有Selector
              if (CollectionUtils.isEmpty(selectors)) {
       
                  return handleSelectorIsNull(pluginName, exchange, chain);
              }
              final SelectorData selectorData = matchSelector(exchange, selectors); // 这个match的处理就是找到我们请求的url里面的selector
              if (Objects.isNull(selectorData)) {
       
                  return handleSelectorIsNull(pluginName, exchange, chain);
              }
              selectorLog(selectorData, pluginName); // 这里知识输出log
              final List<RuleData> rules = BaseDataCache.getInstance().obtainRuleData(selectorData.getId()); // 找到selector下面对应的rules
              if (CollectionUtils.isEmpty(rules)) {
       
                  return handleRuleIsNull(pluginName, exchange, chain);
              }
              RuleData rule;
              if (selectorData.getType() == SelectorTypeEnum.FULL_FLOW.