Soul网关的心得体会（一）

17 Jan 2021 | Soul |

支持的插件

本篇文章是在前面几篇文章的基础上，分享一下个人有关Soul网关的使用心得。Soul网关可以很灵活的支持各种插件，如果不满足要求，还可以自定义插件。所有可以支持的插件在org.dromara.soul.common.enums.PluginEnum，目前有17种插件。

每个插件的具体作用是：

Global插件：全局使用的插件，设置上下文信息。
Sign插件：对请求进行签名认证。
Waf插件：对流量实现防火墙的功能，主要用来拦截非法请求，或者异常请求，并且给与相关的拒绝策略。
Rate limiter插件：对流量进行控制，采用redis令牌桶算法进行限流。
Rewrite插件：对请求 URI 进行重写。
Redirect插件：没有看到相关代码实现。
Hystrix插件：对流量进行熔断。
Sentinel插件：对流量进行限流与熔断的可选选择之一。
Resilence4J插件：对流量进行限流与熔断的可选选择之一。
Divide插件：处理http协议，实现负载均衡。
SpringCloud插件：将http协议 转成SpringCloud协议。
WebSocket插件：Soul网关是支持 websocket的代理，在对websocket支持中，使用了divide插件。
Dubbo插件：将http协议 转换成dubbo协议 的插件，也是网关实现dubbo泛化调用的关键。
Sofa插件：实现通过http的方式来请求sofa服务。
Tars插件：还在开发中。
Monitor插件：用来监控自身运行状态（JVM相关），请求的响应迟延，QPS、TPS等相关metrics。
Response插件：没有看到相关代码实现。

就使用者而言，会使用到的是以下12种插件，另外几种（Global,Redirect,Response，WebSocket,Tars）是在系统内部使用（或暂未使用）。

现在，体验了divide插件，dubbo插件，spring cloud插件。还有一个sofa插件，它支持sofa-rpc，为sofa用户提供了接入Soul网关的入口。

本周的原计划是体验soul-examples下面的各个demo，在体验过程中体会到这样安排的用意，这些示例中的插件(divide,dubbo,spring cloud,sofa)是方便业务系统接入到网关中，其他插件(比如：Sign,Waf,Rate limiter等)是对流量进行管控，保护业务系统。感谢导师猫大人（Soul网关的作者）的用心良苦。

插件中的继承关系

Soul插件都是继承AbstractSoulPlugin，而AbstractSoulPlugin实现了SoulPlugin。

public abstract class AbstractSoulPlugin implements SoulPlugin

在AbstractSoulPlugin中，它是一个抽象类，实现了每个插件通用的execute()方法：查找插件->选择器->规则。而每个插件具体怎么做，由他们自己去实现，即重写doExecute()方法。这里使用了模板方法设计模式。

public abstract class AbstractSoulPlugin implements SoulPlugin {
	//每个插件具体怎么做，由他们自己去实现
    protected abstract Mono<Void> doExecute(ServerWebExchange exchange, SoulPluginChain chain, SelectorData selector, RuleData rule);

    //每个插件通用的execute()方法：查找插件->选择器->规则。
    //这里只保留了主要的逻辑，具体代码要查看源码。
    @Override
    public Mono<Void> execute(final ServerWebExchange exchange, final SoulPluginChain chain) {
        //1.找插件
        final PluginData pluginData = BaseDataCache.getInstance().obtainPluginData(pluginName);
     	if (pluginData != null && pluginData.getEnabled()) {
            //2.找选择器
            final SelectorData selectorData = matchSelector(exchange, selectors);
           //3.找规则
            final List<RuleData> rules = BaseDataCache.getInstance().obtainRuleData(selectorData.getId());
            //4.执行插件实际的功能
            return doExecute(exchange, chain, selectorData, rule);
     	}
        return chain.execute(exchange);
    }
}

插件执行逻辑

插件的执行是通过职责链设计模式来实现的。实现逻辑在org.dromara.soul.web.handler.SoulWebHandler.DefaultSoulPluginChain#execute方法里面。

@Override
        public Mono<Void> execute(final ServerWebExchange exchange) {
            return Mono.defer(() -> {
                if (this.index < plugins.size()) {//依次执行每个插件
                    SoulPlugin plugin = plugins.get(this.index++);//获取当前插件
                    Boolean skip = plugin.skip(exchange);//判断当前插件是否执行
                    if (skip) { //跳过
                        return this.execute(exchange);
                    }
                    return plugin.execute(exchange, this);//执行插件
                }
                return Mono.empty();
            });
        }

遇到的问题

最后，分享自己在体验过程中，遇到的问题：

1.使用spring cloud插件时，碰到了一个异常：

-107, "Can not find selector, please check your configuration!"

出现个问题是因为在soul bootstrap中没有引入相应的jar包。

 <!--soul springCloud plugin start-->
        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>soul-spring-boot-starter-plugin-springcloud</artifactId>
            <version>${project.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-commons</artifactId>
            <version>2.2.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
            <version>2.2.0.RELEASE</version>
        </dependency>

        <!--soul springCloud plugin start end-->

2.成功接入spring cloud，发起http请求时，没有任何响应结果。

在使用spring cloud插件，需要同时引入httpclient插件。因为将http协议 转成SpringCloud协议后，还需要通过httpclient插件来发起WebClient请求，获取实际的服务并得到响应。
```
        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>soul-spring-boot-starter-plugin-httpclient</artifactId>
            <version>${project.version}</version>
        </dependency>
```

3.注释中的springCloud是不是应该是SpringCloud更合适；webSocket是不是应该是WebSocket更合适。

/*********org.dromara.soul.common.enums.PluginEnum***********/   
/**
     * springCloud plugin enum.
     */
    SPRING_CLOUD(50, 0, "springCloud"),
  
    /**
     * webSocket plugin enum.
     */
    WEB_SOCKET(55, 0, "webSocket"),

Midnight