Spring Cloud Gateway 整合 sentinel 实现流控熔断

秒速五厘米 2023-10-01 18:25 34阅读 0赞

### 一、什么是网关限流： ###

在微服务架构中，网关层可以屏蔽外部服务直接对内部服务进行调用，对内部服务起到隔离保护的作用，网关限流，顾名思义，就是通过网关层对服务进行限流，从而达到保护后端服务的作用。

Sentinel 从 1.6.0 版本开始就提供了 Spring Cloud Gateway 的适配，可以提供两种资源维度的限流：

*  route维度：即在配置文件中配置的路由条目，资源名为对应的 routeId，这种属于粗粒度的限流，一般是对某个微服务进行限流。
 *  自定义API维度：用户可以利用 Sentinel 提供的API来自定义一些API分组，这种属于细粒度的限流，针对某一类的uri进行匹配限流，可以跨多个微服务。

### 二、gateway 整合 sentinel 实现网关限流： ###

那么接下来我们就介绍下 spring cloud gateway 如何整合 sentinel，至于如何搭建网关项目和整合nacos注册中心上篇文章我们已经介绍过了，感兴趣的读者请阅读这篇文章：[Spring Cloud Gateway 服务网关的部署与使用详细介绍][Spring Cloud Gateway]

1、添加 sentinel 相关依赖：

<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-gateway</artifactId>
    		</dependency>

2、配置文件中添加 sentinel 控制台的配置：

# sentinel看板相关配置
    spring.cloud.sentinel.eager = true
    spring.cloud.sentinel.transport.dashboard = 172.28.190.101:8999

3、启动网关项目：

对于网关项目，我们需要在原启动参数的基础上添加如下启动参数，标记该应用为 API Gateway 类型：

# 注：通过 Spring Cloud Alibaba Sentinel 自动接入的 API Gateway 整合则无需此参数
    -Dcsp.sentinel.app.type=1

![70955bb5aadb4ad99b6505df9865ea86.png][]

4、访问 sentinel 控制台：

至此，我们就已经将 Spring Cloud Gateway 与 Sentinel 整合好了，进入 sentinel 控制台就能够看到网关项目被监控了

![9897f3cfb1524a8d891c3e90e3a97423.png][]

### 三、sentinel 网关流控规则的介绍： ###

整合好 Spring Cloud Gateway 与 Sentinel 之后，接下来我们介绍下如何基于 sentinel-dashboard 控制台进行网关流控，如下图所示：

![8dc17483dda541f78c85092b4f7f5ff3.png][]

#### 3.1、网关流控规则： ####

网关流控规则 GatewayFlowRule 的核心属性如下：

① resourceMode：规则是针对 API Gateway 的 route（RESOURCE\_MODE\_ROUTE\_ID）还是用户在 Sentinel 中定义的 API 分组（RESOURCE\_MODE\_CUSTOM\_API\_NAME），默认是 route。

② resource：资源名称，可以是网关中的 route 名称或者用户自定义的 API 分组名称。

③ grade：限流指标维度，同限流规则的 grade 字段

④ count：限流阈值

⑤ intervalSec：统计时间窗口，单位是秒，默认是 1 秒

⑥ controlBehavior：流量整形的控制效果，目前支持快速失败和匀速排队两种模式，默认是快速失败。

⑦ burst：应对突发请求时额外允许的请求数目。

⑧ maxQueueingTimeoutMs：匀速排队模式下的最长排队时间，单位是毫秒，仅在匀速排队模式下生效。

⑨ paramItem：参数限流配置。若不提供，则代表不针对参数进行限流，该网关规则将会被转换成普通流控规则；否则会转换成热点规则。其中的字段：

>  *  parseStrategy：从请求中提取参数的策略，目前支持提取来源 IP（PARAM\_PARSE\_STRATEGY\_CLIENT\_IP）、Host（PARAM\_PARSE\_STRATEGY\_HOST）、任意 Header（PARAM\_PARSE\_STRATEGY\_HEADER）和任意 URL 参数（PARAM\_PARSE\_STRATEGY\_URL\_PARAM）四种模式。
>  *  fieldName：若提取策略选择 Header 模式或 URL 参数模式，则需要指定对应的 header 名称或 URL 参数名称。
>  *  pattern：参数值的匹配模式，只有匹配该模式的请求属性值会纳入统计和流控；若为空则统计该请求属性的所有值。
>  *  matchStrategy：参数值的匹配策略，目前支持精确匹配（PARAM\_MATCH\_STRATEGY\_EXACT）、子串匹配（PARAM\_MATCH\_STRATEGY\_CONTAINS）和正则匹配（PARAM\_MATCH\_STRATEGY\_REGEX）。

#### 3.2、API 分组管理： ####

API 分组就是对接口进行分组，然后对不同组的接口实施不同的限流策略。

（1）添加API分组：

如下图，按指定步骤进入自定义API界面：

![7bcf86d94b7441deaca16d8721d7ea0c.png][]

API 分组有三种配置模式：精确、前缀和正则三种模式。

*  精确模式：指对URL的路径完全匹配时，进行限流。例如，匹配串配置为 /order/1
 *  前缀模式：指对URL的路径前缀匹配时，进行限流。例如，匹配串配置为 /order/\*
 *  正则模式：指对URL的路径符合正则表示式规则时，进行限流。例如，匹配串配置为 \\/order\\/\\d\*

![b1bc0693748c42eb9273de42994acc59.png][]

（2）配置限流规则：

接下来需要对这个API分组添加流控规则，API名称可以选择不同的API分组进行配置，如下图所示：

![269b7f58485a46a593f6b173eced438a.png][]

新增之后，限流规则就会对符合匹配模式的 API 生效了。

### 四、sentinel 网关流控实现的原理： ###

知道如何使用 sentinel-dashboard 对网关进行流控之后，我们接下来介绍 sentinel 网关流控的实现原理。

当通过 GatewayRuleManager 加载网关流控规则（GatewayFlowRule）时，无论是否针对请求属性进行限流，Sentinel 底层都会将网关流控规则转化为热点参数规则（ParamFlowRule），存储在 GatewayRuleManager 中，与正常的热点参数规则相隔离。转换时 Sentinel 会根据请求属性配置，为网关流控规则设置参数索引（idx），并同步到生成的热点参数规则中。

外部请求进入 API Gateway 时会经过 Sentinel 实现的 filter，其中会依次进行 “路由/API 分组匹配 -> 请求属性解析 和 参数组装"。Sentinel 会根据配置的网关流控规则来解析请求属性，并依照参数索引顺序组装参数数组，最终传入 SphU.entry(res, args) 中。Sentinel API Gateway Adapter Common 模块向 Slot Chain 中添加了一个 GatewayFlowSlot，专门用来做网关规则的检查。GatewayFlowSlot 会从 GatewayRuleManager 中提取生成的热点参数规则，根据传入的参数依次进行规则检查。若某条规则不针对请求属性，则会在参数最后一个位置置入预设的常量，达到普通流控的效果。

![2e6443f248a0414fbf33072563b09bd8.png][]

### 五、网关限流了，服务就安全了吗？ ###

如果已经在网关层面做了限流，那么躲在身后的服务是否就安全了呢？答案是否定的，微服务架构中，一个独立服务往往会被多方调用，如下图：

![0cd9a395c443122ed30ee7a820a5e626.png][]

商品服务不仅仅被网关层调用，还被内部订单服务调用，这时候如果仅仅在网关层限流，一旦大量的请求订单服务，比如大促秒杀，商品服务不做限流还是会被瞬间击垮。因此需要根据公司业务场景对自己负责的服务也要进行限流兜底，最常见的方案：**网关层集群限流+内部服务的单机限流兜底**，这样才能保证不被流量冲垮。

### 六、自定义流控异常消息： ###

网关流控的默认异常返回信息并不够人性化，直接返回：“Block.........”，这种肯定是不能接受的，那么我们如何自定义配置流控异常信息呢？其实 sentinel 已经为我们实现了自定义流控异常的返回内容。只需要在配置文件中添加配置如下：

spring:
      cloud:
        sentinel:
          #配置限流之后的响应内容
          scg:  
            fallback:
              # 两种模式：一种是response返回文字提示信息，一种是redirect，重定向跳转，需要同时配置redirect(跳转的uri)
              mode: response
              # 响应的状态
              response-status: 426
              # 响应体
              response-body: '{"code": 426,"message": "限流了，稍后重试！"}'

上述配置中 mode 配置的是 response，一旦被限流了，将会返回 JSON 串。

{
        "code": 426,
        "message": "限流了，稍后重试！"
    }

重定向的配置如下：

spring:
      cloud:
        sentinel:
          #配置限流之后的响应内容
          scg:
            fallback:
              ## 两种模式，一种是response返回文字提示信息，一种是redirect，重定向跳转，需要同时配置redirect(跳转的uri)
              mode: redirect
              ## 跳转的URL
              redirect: http://www.baidu.com

一旦被限流，将会直接跳转到：http://www.baidu.com

--------------------

> 相关阅读：
> 
> [常见的服务器架构入门：从单体架构、EAI 到 SOA 再到微服务和 ServiceMesh][EAI _ SOA _ ServiceMesh]
> 
> [常见分布式理论（CAP、BASE）和一致性协议（Gosssip协议、Raft一致性算法）][CAP_BASE_Gosssip_Raft]
> 
> [一致性哈希算法原理详解][Link 1]
> 
> [Nacos注册中心的部署与用法详细介绍][Nacos]
> 
> [Nacos配置中心用法详细介绍][Nacos 1]
> 
> [SpringCloud OpenFeign 远程HTTP服务调用用法与原理][SpringCloud OpenFeign _HTTP]
> 
> [什么是RPC？RPC框架dubbo的核心流程][RPC_RPC_dubbo]
> 
> [服务容错设计：流量控制、服务熔断、服务降级][Link 2]
> 
> [sentinel 限流熔断神器详细介绍][sentinel]
> 
> [Sentinel 规则持久化到 apollo 配置中心][Sentinel _ apollo]
> 
> [Sentinel-Dashboard 与 apollo 规则的相互同步][Sentinel-Dashboard _ apollo]
> 
> [Spring Cloud Gateway 服务网关的部署与使用详细介绍][Spring Cloud Gateway]
> 
> [Spring Cloud Gateway 整合 sentinel 实现流控熔断][Spring Cloud Gateway _ sentinel]
> 
> [Spring Cloud Gateway 整合 knife4j 聚合接口文档][Spring Cloud Gateway _ knife4j]
> 
> [常见分布式事务详解（2PC、3PC、TCC、Saga、本地事务表、MQ事务消息、最大努力通知）][2PC_3PC_TCC_Saga_MQ]
> 
> [分布式事务Seata原理][Seata]
> 
> [RocketMQ事务消息原理][RocketMQ]

--------------------

参考文章：

[Spring Cloud Gateway 整合阿里 Sentinel网关限流实战！][Spring Cloud Gateway _ Sentinel]

[网关限流 · alibaba/Sentinel Wiki · GitHub][_ alibaba_Sentinel Wiki _ GitHub]

[Sentinel Gateway Nacos 网关限流三剑客 - 云+社区 - 腾讯云][Sentinel Gateway Nacos _ - _ -]

[Spring Cloud Gateway]: https://blog.csdn.net/a745233700/article/details/122917167
[70955bb5aadb4ad99b6505df9865ea86.png]: https://img-blog.csdnimg.cn/70955bb5aadb4ad99b6505df9865ea86.png
[9897f3cfb1524a8d891c3e90e3a97423.png]: https://img-blog.csdnimg.cn/9897f3cfb1524a8d891c3e90e3a97423.png
[8dc17483dda541f78c85092b4f7f5ff3.png]: https://img-blog.csdnimg.cn/8dc17483dda541f78c85092b4f7f5ff3.png
[7bcf86d94b7441deaca16d8721d7ea0c.png]: https://img-blog.csdnimg.cn/7bcf86d94b7441deaca16d8721d7ea0c.png
[b1bc0693748c42eb9273de42994acc59.png]: https://img-blog.csdnimg.cn/b1bc0693748c42eb9273de42994acc59.png
[269b7f58485a46a593f6b173eced438a.png]: https://img-blog.csdnimg.cn/269b7f58485a46a593f6b173eced438a.png
[2e6443f248a0414fbf33072563b09bd8.png]: https://img-blog.csdnimg.cn/2e6443f248a0414fbf33072563b09bd8.png
[0cd9a395c443122ed30ee7a820a5e626.png]: https://img-blog.csdnimg.cn/img_convert/0cd9a395c443122ed30ee7a820a5e626.png
[EAI _ SOA _ ServiceMesh]: https://blog.csdn.net/a745233700/article/details/117448077
[CAP_BASE_Gosssip_Raft]: https://blog.csdn.net/a745233700/article/details/122401700
[Link 1]: https://blog.csdn.net/a745233700/article/details/120814088
[Nacos]: https://blog.csdn.net/a745233700/article/details/122915663
[Nacos 1]: https://blog.csdn.net/a745233700/article/details/122916208
[SpringCloud OpenFeign _HTTP]: https://blog.csdn.net/a745233700/article/details/122916856
[RPC_RPC_dubbo]: https://blog.csdn.net/a745233700/article/details/122445199
[Link 2]: https://blog.csdn.net/a745233700/article/details/120819219
[sentinel]: https://blog.csdn.net/a745233700/article/details/122733366
[Sentinel _ apollo]: https://blog.csdn.net/a745233700/article/details/122725604
[Sentinel-Dashboard _ apollo]: https://blog.csdn.net/a745233700/article/details/122659459
[Spring Cloud Gateway _ sentinel]: https://blog.csdn.net/a745233700/article/details/122917160
[Spring Cloud Gateway _ knife4j]: https://blog.csdn.net/a745233700/article/details/122917137
[2PC_3PC_TCC_Saga_MQ]: https://blog.csdn.net/a745233700/article/details/122402303
[Seata]: https://blog.csdn.net/a745233700/article/details/122402795
[RocketMQ]: https://blog.csdn.net/a745233700/article/details/122656108
[Spring Cloud Gateway _ Sentinel]: https://mp.weixin.qq.com/s?__biz=MzU3MDAzNDg1MA==&mid=2247500540&idx=1&sn=2967bf1f9fa2c4d5b94b7fe291b7869b&chksm=fcf71d31cb8094271b5bbeca85cc03cf7d7c8bbf7c4d5b83a539e39c956e3f4015f91e7742b6&cur_album_id=2042874937312346114&scene=190#rd
[_ alibaba_Sentinel Wiki _ GitHub]: https://github.com/alibaba/Sentinel/wiki/%E7%BD%91%E5%85%B3%E9%99%90%E6%B5%81
[Sentinel Gateway Nacos _ - _ -]: https://cloud.tencent.com/developer/article/1808112