Spring Cloud Gateway 网关限流

不念不忘少年蓝@ 2023-09-30 17:07 17阅读 0赞

### 前言 ###

书接前文：

[网关 Spring Cloud Gateway - API 调用的组织者][Spring Cloud Gateway - API]

已经通过案例实现了通过 **Spring Cloud Gateway** 网关调用服务 API，并已经了解了 **Gateway** 网关的几个核心概念：`routes` ，`predicates`，`filters` 。

这几个核心概念串起来就是 **Gateway** 的执行流程：客户端发请求，通过断言 `predicates` 进行匹配，若匹配上了则请求就会被发送到网关处理程序，并执行特定的请求过滤器链 `fliters` 。

**Spring Cloud Gateway** 提供了多种断言 `predicate` 工厂和过滤器 `filter` 工厂，也可以自定义断言工厂和过滤器工厂。

本文将使用以下两种方式实现网关的限流：

*  使用 **Spring Cloud Gateway** 的 `RequestRateLimiter` 过滤器工厂基于 `Redis` 的限流，
 *  使用 **Sentinel** 结合 **Spring Cloud Gateway** 来实现网关限流。

### 使用 RequestRateLimiter 过滤器工厂结合 Redis 实现网关限流 ###

`RequestRateLimiter` `GatewayFilter` 工厂使用实现 **RateLimiter** 的限流器来确定当前请求是否被限流。如果被限流了，则默认返回 `HTTP 429 - Too Many Requests` 状态。

`RequestRateLimiter` 网关过滤器工厂采用可选的 `keyResolver` 参数和特定于速率限制器的参数。

**KeyResolver** 在源码中的定义：

public interface KeyResolver {
    	Mono<String> resolve(ServerWebExchange exchange);
    }
    复制代码

我们可以通过 **KeyResolver** 来指定限流的 `key` ，比如可以根据用户做限流，也可以根据 IP 来做限流，或者根据接口进行限流。

#### 基于 Redis 的限流器 ####

目前限流器的实现提供了基于 Redis 的实现，其使用的算法是 **令牌桶算法**。

基于 Redis 的限流，需要引入 `spring-boot-starter-data-redis-reactive` 依赖：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
    </dependency>
    复制代码

要实现限流，需要配置 **Redis** 连接以及在配置网关路由的时候添加 `RequestRateLimiter` 过滤器：

spring:
      redis:
        host: 192.168.242.112
        port: 16397
        password: s1lcA6;.7Lx9,x
      cloud:
        gateway:
          routes:
          - id: order-service
            uri: lb://order-service
            filters:
            - name: RequestRateLimiter
              args:
                redis-rate-limiter.replenishRate: 10
                redis-rate-limiter.burstCapacity: 20
                key-resolver: "#{@userKeyResolver}"
    复制代码

这里配置的是按照用户限流，其中参数 `key-resolver: "#{@userKeyResolver}"` 是一个 **KeyResolver** Bean：

@Configuration
    public class RateLimiterConfig {
        @Bean
        public KeyResolver userKeyResolver() {
            return exchange -> Mono.just(Objects.requireNonNull(exchange.getRequest().getQueryParams().getFirst("userId")));
        }
    }
    复制代码

`#{@userKeyResolver}` 是一个引用名为 `userKeyResolver` 的 bean 的 **SpEL 表达式** 。

其他配置项的含义：

*  filter 的名称 name 必须为 **RequestRateLimiter** 。
 *  **redis-rate-limiter.replenishRate** ：允许用户每秒处理的请求数。设置的数值就代表 **每秒向令牌桶添加多少个令牌** 。
 *  **redis-rate-limiter.burstCapacity** ：令牌桶的容量，即允许在 1 秒内完成的最大请求数。设置为 0 则表示拒绝所有请求。

下面开始测试，根据配置的路由，我们通过网关访问 `http://localhost:8000/order/info/2` ：

![format_png][]

直接报错了，看一下异常信息：

![format_png 1][]

根据 `userKeyResolver` 的配置，我们必须传入 `userId` 参数才能正常访问：

![format_png 2][]

访问接口测试后， **Redis** 中会有对应的数据：

192.168.242.112:16397> keys *
    1) "request_rate_limiter.{198276}.tokens"
    2) "request_rate_limiter.{198276}.timestamp"
    192.168.242.112:16397> 
    复制代码

大括号中的就是限流的 `key` ，这里是 `userId` ，就是我们访问接口时传入的参数值。**Redis** 的 key 中还有两个定义：

*  tokens：代表当前秒对应的可用的令牌数量；
 *  timestamp：当前时间的秒数。

再来通过 **JMeter** 模拟一下同时有大量请求的情况，当请求数量超过令牌桶的容量的时候，将会限流。

**1，** 设置每秒有 100 个请求过来：

![format_png 3][]

**2，** 设置通过网关请求的 url，注意要带上 userId 参数，这是根据用户限流的：

![format_png 4][]

**3，** 执行，观察结果树：

![format_png 5][]

![format_png 6][]

当令牌桶容量满了的时候，就不允许其他请求进来了，将返回 `Too Many Requests` ，限流生效。

### Spring Cloud Gateway 结合 Sentinel 实现网关流量控制 ###

Sentinel 1.6.0 引入了 Sentinel API Gateway Adapter Common 模块，此模块中包含网关限流的规则和自定义 API 的实体和管理逻辑：

*  `GatewayFlowRule`：网关限流规则，针对 API Gateway 的场景定制的限流规则，可以针对不同 **route** 或自定义的 **API 分组** 进行限流，支持针对请求中的 `参数`、`Header`、`来源 IP` 等进行定制化的限流。
 *  `ApiDefinition`：用户自定义的 API 定义分组，可以看做是一些 **URL 匹配的组合** 。比如我们可以定义一个 API 叫 `my_api`，请求 path 模式为 `/foo/**` 和 `/baz/**` 的都归到 `my_api` 这个 API 分组下面。限流的时候可以针对这个自定义的 API 分组维度进行限流。

**Spring Cloud Gateway** 与 **Sentinel** 整合也很简单，我们还以 `gwatway-service` 为例，当前该微服务的配置文件如下：

server:
      port: 8000
    spring:
      application:
        name: gateway-service
      cloud:
        nacos:
          discovery:
            # Nacos 集群
            server-addr: 192.168.242.112:81
        gateway:
          # 配置网关路由
          routes:
            - id: user-service
              uri: lb://user-service
              predicates:
                - Path=/user/**
              filters:
                - AddRequestHeader=X-Request-Home, China
            - id: order-service
              uri: lb://order-service
              predicates:
                - Path=/order/**
    复制代码

引入 Sentinel 以及和 Spring Cloud Gateway 整合的依赖，这里我们也把 Sentinel 数据源以及 Nacos 持久化的依赖也引进来：

<dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
    </dependency>
    
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-alibaba-sentinel-datasource</artifactId>
    </dependency>
    
    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-datasource-nacos</artifactId>
    </dependency>
    
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
    </dependency>
    复制代码

然后在将在配置文件中增加 `sentinel.transport.dashboard` 配置：

spring:
      cloud:
        sentinel:
          transport:
            dashboard: localhost:8080
    复制代码

这样可以在 Sentinel 控制面板上直观的看到网关流控配置。

启动 Sentinel Dashboard：

java -Dserver.port=8080 ^
    -Dcsp.sentinel.dashboard.server=localhost:8080 ^
    -Dproject.name=sentinel-dashboard ^
    -Dsentinel.dashboard.auth.username=sentinel ^
    -Dsentinel.dashboard.auth.password=123456 ^
    -jar D:\java\sentinel-dashboard-1.8.3.jar
    复制代码

> **Tip：** 如果在 Linux 环境下启动，则将换行符 `^` 替换为 `\` 。

通过网关访问一下 `user-service` 的 API，然后在 Sentinel Dashboard 上就能看到网管服务了，如下图所示：

![format_png 7][]

可以看到，网关服务在 Sentinel Dashboard 上的功能有些不一样，多了个 `API 管理` 。在 `请求链路` 上可以看到网关中定义的 `routes` ：

![format_png 8][]

Sentinel 的限流规则，比如热点参数、流控、熔断等都可以在 Sentinel Dashboard 上配置，网关流控规则同样也能在面板上配置：

![format_png 9][]

如上图所示，我已经将网关流控规则的字段对应标注上了，详细释义可见 Sentinel 官方文档：

[sentinelguard.io/zh-cn/docs/…][sentinelguard.io_zh-cn_docs]

下面我们就开始配置网关限流，按默认配置，间隔1秒，QPS 阈值配置为 1，表示 1 秒内 QPS 大于 1 时进行限流。

然后通过网关访问 `user-service` 这个 route，快速刷新，达到1秒内大于1个QPS时，就被限流了：

![format_png 10][]

一般情况下，我会把流控规则持久化到 Nacos，网关流控规则的数据源类型是 `gw-flow` ，如果设置成了 `flow` 则不会生效。具体配置如下：

spring:
      cloud:
        sentinel:
          transport:
            dashboard: localhost:8080
          datasource: 
            myGatewayRule:
              nacos:
                serverAddr: 192.168.242.112:81
                groupId: DEFAULT_GROUP
                dataId: myGatewayRule.json
                # 此处必须设置为 gw-flow 网关流控规则才会生效
                ruleType: gw-flow
    复制代码

Nacos 中 `myGatewayFlowRule.json` ：

![format_png 11][]

这样网关流控规则就持久化到 Nacos 中了。

### Spring Cloud Gateway 后限流返回结果配置 ###

按照前文配置了限流规则后，如果请求满足了限流的规则，那么将返回如下内容：

{
        "code": 429,
        "message": "Blocked by Sentinel: ParamFlowException"
    }
    复制代码

实际使用中，我们还可以定制返回结果，通过在配置文件增加 `spring.cloud.sentinel.scg.fallback` 配置项就能实现自定义的返回结果，比如如下配置：

spring:
      cloud:
        sentinel:
          scg:
            fallback:
              # 响应模式有 redirect 和 response 两种
              mode: response
              response-status: 200
              response-body: '{"code": 429, "message": "哥们，这瓜不熟，你走吧..."}'
              # redirect: https://google.com
    复制代码

限流后返回格式为：

![format_png 12][]

### 小结 ###

比较一下

*  **Spring Cloud Gateway** 的过滤器工厂 `RequestRateLimiter` 限流
 *  **Sentinel** 与 **Gateway** 结合的限流

这两种网关限流的实现方法，很明显使用 **Sentinel** 更加方便一些。

[Spring Cloud Gateway - API]: https://juejin.cn/post/7134880426291625991
[format_png]: https://img-blog.csdnimg.cn/img_convert/32c9f4c45eb82a16747851f218c16299.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/1e73967fc61da3b1974d6897a1cb1bc1.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/490e8e8424c79d287cf9160213a674de.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/8f646e00c87a668b7cfc970c88634c7f.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/78a1128786a62a18fffb1765f4fa7403.webp?x-oss-process=image/format,png
[format_png 5]: https://img-blog.csdnimg.cn/img_convert/c9ecc62c6df8f45bf49fbd03c7bd5f91.webp?x-oss-process=image/format,png
[format_png 6]: https://img-blog.csdnimg.cn/img_convert/97f5398c22561b1e78fd3822349c79de.webp?x-oss-process=image/format,png
[format_png 7]: https://img-blog.csdnimg.cn/img_convert/bf7338b523886437b16ca6b718375f2c.webp?x-oss-process=image/format,png
[format_png 8]: https://img-blog.csdnimg.cn/img_convert/c296b626839d4d3a9aa485cfce42d8a8.webp?x-oss-process=image/format,png
[format_png 9]: https://img-blog.csdnimg.cn/img_convert/a9b38b1a1122b416d2624932ae55cc49.webp?x-oss-process=image/format,png
[sentinelguard.io_zh-cn_docs]: https://link.juejin.cn?target=https%3A%2F%2Fsentinelguard.io%2Fzh-cn%2Fdocs%2Fapi-gateway-flow-control.html
[format_png 10]: https://img-blog.csdnimg.cn/img_convert/ab16835f8e4bff018aa82271b46faf60.webp?x-oss-process=image/format,png
[format_png 11]: https://img-blog.csdnimg.cn/img_convert/8d476b607d67fbe82c08ada1bed4ae22.webp?x-oss-process=image/format,png
[format_png 12]: https://img-blog.csdnimg.cn/img_convert/e4395f453f0d176a557f09bf1ea37863.webp?x-oss-process=image/format,png