目录

网关限流规则 GatewayFlowRule 的字段解释如下：

网关流控实现原理

网关流控控制台

编辑网关流控规则页面展示图

 nacos配置流控规则

---

Sentinel 支持对 Spring Cloud Gateway、Zuul 等主流的 API Gateway 进行限流。 

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 分组维度进行限流。

网关限流规则 GatewayFlowRule 的字段解释如下：

• resource

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

• resourceMode

规则是针对 API Gateway 的 route（RESOURCE_MODE_ROUTE_ID）还是用户在 Sentinel 中定义的 API 分组（RESOURCE_MODE_CUSTOM_API_NAME），默认是 route。

• grade

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

• count

限流阈值

• intervalSec

统计时间窗口，单位是秒，默认是 1 秒。

• controlBehavior

流量整形的控制效果，同限流规则的 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：参数值的匹配模式，只有匹配该模式的请求属性值会纳入统计和流控；若为空则统计该请求属性的所有值。（1.6.2 版本开始支持）
• matchStrategy：参数值的匹配策略，目前支持精确匹配（PARAM_MATCH_STRATEGY_EXACT）、子串匹配（PARAM_MATCH_STRATEGY_CONTAINS）和正则匹配（PARAM_MATCH_STRATEGY_REGEX）。（1.6.2 版本开始支持）

用户可以通过 GatewayRuleManager.loadRules(rules) 手动加载网关规则，或通过 GatewayRuleManager.register2Property(property) 注册动态规则源动态推送（推荐方式）。

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

• route 维度：即在 Spring 配置文件中配置的路由条目，资源名为对应的 routeId
• 自定义 API 维度：用户可以利用 Sentinel 提供的 API 来自定义一些 API 分组

网关流控实现原理

当通过 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 中提取生成的热点参数规则，根据传入的参数依次进行规则检查。若某条规则不针对请求属性，则会在参数最后一个位置置入预设的常量，达到普通流控的效果。

以上摘自于官网

网关流控控制台

编辑网关流控规则页面展示图

 nacos配置流控规则

• 下图为route类型      如配置了API分组，resourceMode改为1，resource为API分组名称

注：复制时去除注解，只复制[ ]中内容   

// 对应上面描述，下图为Sentinel控制台展示
[
  {
    "resource": "PLATFORMS-CODE", //资源名称
    "resourceMode": 0,   // 0 route  1 API分组
    "intervalSec": 30,   // 统计时间窗口 （秒），默认是1 秒（目前仅对参数限流生效）。
    "controlBehavior": 2,  // 流控方式 0 快速失败 2 匀速排队，默认是快速失败
    "maxQueueingTimeoutMs": 800,  // 匀速排队模式下的最长排队时间，单位是毫秒，仅在匀速排队模式下生效
    "count": 10   // 限流阈值
  }
]


"grade": 1, // 阈值类型，0代表线程数，1代表QPS    默认QPS 
"burst": 1, // 额外允许的请求数目。

•  API分组配置

[
    {
        "apiName":"PLATFORMS-CODE",  //api名称
        "predicateItems":[   // 匹配规则
            {
                "pattern": "/code/list"
            },
            {
                "pattern": "/code/**", // 匹配字符串
                "matchStrategy": 1    // 匹配模式   0 精准  1 前缀  默认0
            }
        ]
    }
]

 yml中配置 

注：rule-type: gw-flow      gw-flow为网关流控  gw-api-group为API分组 

spring:
  application:
    name: gateway
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
        username: nacos
        password: nacos
    # sentinel控制台
    sentinel:
      transport:
        dashboard: localhost:8858
      web-context-unify: false  # 默认将调用链路收敛，导致链路流效果失效
      datasource:
        gateway-flow-rules:
          nacos:
            # nacos地址
            server-addr: localhost:8848
            # nacos中配置文件的data-id
            data-id: ${spring.application.name}-gateway-flow-rules
            # nacos 分组
            group-id: DEFAULT_GROUP
            data-type: json
            # 规则类型 流控
            rule-type: gw-flow
        gateway-api-rules:
          nacos:
            server-addr: localhost:8848
            data-id: ${spring.application.name}-gateway-api-rules
            group-id: DEFAULT_GROUP
            data-type: json
            # API分组
            rule-type: gw-api-group