Midnight

Soul网关中的Spring Cloud插件

19 Jan 2021   |   Soul  |  

本篇文章主要介绍学习使用Spring Cloud插件，如何将Spring Cloud服务接入到Soul网关。主要内容如下：

  • 在Soul中使用Spring Cloud服务

    • 查看官方样例
    • 引入依赖
    • 注册Spring Cloud服务
    • 运行Spring Cloud服务
    • 启动Soul Admin和Soul Bootstrap
    • 体验Spring Cloud服务

在前面几篇文章中，已经体验过了Soul中divide插件，apache dubbo插件和sofa插件，今天的spring cloud插件是最后一篇有关业务服务如何接入Soul网关的文章。大体逻辑和之前的一致。

1. 在Soul中使用spring cloud服务

1.1 查看官方样例

Soul官方在soul-examples模块提供了测试样例，其中的soul-examples-springcloud模块演示的是Soul网关对springcloud服务的支持。模块目录及配置信息如下：

1

有关的配置信息还是和之前一样。在本项目中Spring Cloud的注册中心使用的是nacos。

nacos可以在官网直接下载，然后解压，在bin目录下使用命令startup.cmd -m standalone就能启动成功。


server:
  port: 8884
  address: 0.0.0.0

spring:
  application:
    name: springCloud-test
  cloud: 
    nacos:
      discovery:
          server-addr: 127.0.0.1:8848 # 注册中心nacos的地址


springCloud-test:
  ribbon.NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RandomRule

soul:
  springcloud:
    admin-url: http://localhost:9095 # soul-admin的地址
    context-path: /springcloud

logging:
  level:
    root: info
    org.dromara.soul: debug
  path: "./logs"
1.2 引入依赖

在spring cloud服务的pom文件中引入soul相关依赖，当前版本是2.2.1。

	  <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>soul-spring-boot-starter-client-springcloud</artifactId>
            <version>${soul.version}</version>
        </dependency>

	<!--使用nacos作为注册中心-->
       <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>2.1.0.RELEASE</version>
        </dependency>
1.3 注册spring cloud服务

在需要被代理的接口上使用注解@SoulSpringCloudClient，@SoulSpringCloudClient注解会把当前接口注册到soul网关中。使用方式如下：

1

如果其他接口也想被网关代理，使用方式是一样的。在@SoulSpringCloudClient注解中，指定path即可。

1.4 运行spring cloud服务

运行SoulTestSpringCloudApplication，启动soul-examples-springcloud项目。成功启动后，可以在控制台看见接口被成功注册到soul网关中。

1

1.5 启动Soul Admin和Soul Bootstrap

参考上一篇的Soul入门，启动Soul Admin和Soul Bootstrap。Soul的后台界面如下：

1

如果spring cloud插件没有开启，需要手动在管理界面开启一下。

1

在Soul Bootstrap中，加入相关依赖：

         <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>soul-spring-boot-starter-plugin-httpclient</artifactId>
            <version>${project.version}</version>
        </dependency>
	 <!--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-->

httpclient插件也是需要的，在soul网关将http协议转换为spring cloud协议后，还需要通过httpclient插件发起web mvc请求。

提一句，当spring cloud服务和soul-bootstrap等启动成功后，可以在注册中心看到这两个服务实例。

1

1.6 体验spring cloud服务

三个系统（本身的业务系统(这里就是soul-examples-sofa)，Soul后台管理系统Soul Admin，Soul核心网关Soul Bootstrap）都启动成功后，就能够体验到sofa服务在网关soul中的接入。

  • 先直连spring cloud服务

1

  • 再通过Soul网关请求spring cloud服务

1

	 //实际spring cloud提供的服务
    @GetMapping("/findById")
    @SoulSpringCloudClient(path = "/findById")
    public OrderDTO findById(@RequestParam("id") final String id) {
        OrderDTO orderDTO = new OrderDTO();
        orderDTO.setId(id);
        orderDTO.setName("hello world spring cloud findById");
        return orderDTO;
    }

上面演示的是先通过请求http://localhost:8884/order/findById?id=99直连spring cloud服务。再通过Soul网关发起请求http://localhost:9195/springcloud/order/findById?id=99，实际被调用的是spring cloud的服务。

最后，这篇文章主要介绍了Soul对spring cloud提供的支持，结合实际案例进行了演示。至此，不同业务系统如何接入Soul网关就已经演示完了。其他的插件（比如：waf/sign/rate limiter等等）是Soul作为一个网关所提供的功能（防火墙，签名认证，限流等等）

接下来，将要分析的是Soul是如何完成数据同步的？在soul-admin的后台管理中修改了插件，选择器或规则，是如何将这些信息同步到网关的呢？敬请期待~

Soul网关中的Sofa插件

18 Jan 2021   |   Soul  |  

本篇文章主要介绍学习使用sofa插件，如何将sofa服务接入到Soul网关，以及sofa的简单介绍。主要内容如下：

  • 在Soul中使用sofa服务

    • 查看官方样例
    • 引入依赖
    • 注册sofa服务
    • 运行sofa服务
    • 启动Soul Admin和Soul Bootstrap
    • 体验sofa服务

  • 关于sofa

    • sofa是什么

    • sofa基本原理

今天体验的是Soul中sofa插件，如果业务系统是由sofa构建而成的，当需要Soul网关的支持时，可以将自己的sofa服务接入soul网关。

1. 在Soul中使用sofa服务

1.1 查看官方样例

Soul官方在soul-examples模块提供了测试样例，其中的soul-examples-sofa模块演示的是Soul网关对sofa服务的支持。模块目录及配置信息如下：

1

​ soul.sofa是有关Soul对sofa插件支持的配置，adminUrl是Soul的后台管理地址，contextPath是业务系统的请求路径上下文。

1.2 引入依赖

在sofa服务的pom文件中引入soul相关依赖，当前版本是2.2.1。

        <properties>
            <rpc-sofa-boot-starter.version>6.0.4</rpc-sofa-boot-starter.version>
        </properties>       
		<dependency>
            <groupId>com.alipay.sofa</groupId>
            <artifactId>rpc-sofa-boot-starter</artifactId>
            <version>${rpc-sofa-boot-starter.version}</version>
        </dependency>
 		<dependency>
            <groupId>org.dromara</groupId>
            <artifactId>soul-spring-boot-starter-client-sofa</artifactId>
            <version>${soul.version}</version>
            <exclusions>
                <exclusion>
                    <artifactId>guava</artifactId>
                    <groupId>com.google.guava</groupId>
                </exclusion>
            </exclusions>
        </dependency>
1.3 注册sofa服务

在需要被代理的接口上使用注解@SoulSofaClient，@SoulSofaClient注解会把当前接口注册到soul网关中。使用方式如下：

1

如果其他接口也想被网关代理，使用方式是一样的。在@SoulSofaClient注解中，指定path即可。

1.4 运行sofa服务

运行TestSofaApplication，启动soul-examples-sofa项目。sofa是需要注册中心的。本文使用的是zookeeper，启动也很简单。在官网下载，然后解压，直接运行zkServer.cmd就可以运行。

1

1.5 启动Soul Admin和Soul Bootstrap

参考上一篇的Soul入门，启动Soul Admin和Soul Bootstrap。Soul的后台界面如下：

1

如果sofa插件没有开启，需要手动在管理界面开启一下。

1

在Soul Bootstrap中，加入相关依赖：

 	<!--soul sofa plugin start-->
        <dependency>
           <groupId>com.alipay.sofa</groupId>
           <artifactId>sofa-rpc-all</artifactId>
           <version>5.7.6</version>
       </dependency>
       <dependency>
           <groupId>org.apache.curator</groupId>
           <artifactId>curator-client</artifactId>
           <version>4.0.1</version>
       </dependency>
       <dependency>
           <groupId>org.apache.curator</groupId>
           <artifactId>curator-framework</artifactId>
           <version>4.0.1</version>
       </dependency>
       <dependency>
           <groupId>org.apache.curator</groupId>
           <artifactId>curator-recipes</artifactId>
           <version>4.0.1</version>
       </dependency>
       <dependency>
           <groupId>org.dromara</groupId>
           <artifactId>soul-spring-boot-starter-plugin-sofa</artifactId>
                <!-- 当前版本是2.2.1-->
           <version>${project.version}</version>
       </dependency>
     <!-- soul  sofa plugin end-->
1.6 体验sofa服务

三个系统（本身的业务系统(这里就是soul-examples-sofa)，Soul后台管理系统Soul Admin，Soul核心网关Soul Bootstrap）都启动成功后，就能够体验到sofa服务在网关soul中的接入。

1

	 //实际sofa提供的服务
    @SoulSofaClient(path = "/findAll", desc = "Get all data")
    public DubboTest findAll() {
        DubboTest dubboTest = new DubboTest();
        dubboTest.setName("hello world Soul Sofa , findAll");
        dubboTest.setId(String.valueOf(new Random().nextInt()));
        return dubboTest;
    }

上面向网关发起了一个请求http://localhost:9195/sofa/findAll，实际被调用的是sofa的服务。

2. 关于sofa

2.1 sofa是什么

在之前，我还没有使用过sofa，这里直接引用了官方的介绍：

SOFARPC 是蚂蚁金服开源的一款基于 Java 实现的 RPC 服务框架，为应用之间提供远程服务调用能力，具有高可伸缩性，高容错性，目前蚂蚁金服所有的业务的相互间的 RPC 调用都是采用 SOFARPC。SOFARPC 为用户提供了负载均衡，流量转发，链路追踪，链路数据透传，故障剔除等功能。

SOFARPC 还支持不同的协议，目前包括 bolt，RESTful，dubbo，H2C 协议进行通信。其中 bolt 是蚂蚁金融服务集团开放的基于 Netty 开发的网络通信框架。

个人理解：sofa是一个轻量级的dubbo。

2.2 sofa基本原理

1

    1. 当一个 SOFARPC 的应用启动的时候，如果发现当前应用需要发布 RPC 服务的话，那么 SOFARPC 会将这些服务注册到服务注册中心上。如图中 Service 指向 Registry。
    1. 当引用这个服务的 SOFARPC 应用启动时，会从服务注册中心订阅到相应服务的元数据信息。服务注册中心收到订阅请求后，会将发布方的元数据列表实时推送给服务引用方。如图中 Registry 指向 Reference。
    1. 当服务引用方拿到地址以后，就可以从中选取地址发起调用了。如图中 Reference 指向 Service。

最后，这篇文章主要介绍了Soul对sofa提供的支持，结合实际案例进行了演示。给出了sofa的简单介绍。

参考地址：

Soul网关的心得体会（一）

17 Jan 2021   |   Soul  |  

支持的插件

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

1

每个插件的具体作用是：

  • 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）是在系统内部使用（或暂未使用）。

1

现在，体验了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

1

在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"),