spring-cloud-alibaba-sentinel-gateway

Spring Cloud Alibaba Sentinel Gateway 是阿里巴巴开源组件 Sentinel 与 Spring Cloud Gateway 的整合模块，主要用于在微服务架构中对网关层的流量进行控制、保护和监控。以下是它的详细说明：

---

一. 核心用途

• 网关层流量治理：在 API 网关（Spring Cloud Gateway）层面实现动态流量控制，保护后端微服务不被突发流量击垮。
• 替代 Sentinel 默认的网关适配模块 ：相比 Sentinel 原生提供的 sentinel-api-gateway-adapter，Spring Cloud Alibaba Sentinel Gateway 提供了更深度整合的解决方案。

---

二. 主要功能

• 路由维度流控：针对不同网关路由（Route）设置独立的限流规则（如 QPS、线程数）。
• 自定义 API 分组：将多个路由组合成一个逻辑API分组，统一设置流控规则。
• 请求属性匹配：支持基于请求路径、Host、Header 等属性灵活定义流控规则。
• 熔断降级：当后端服务响应慢或异常时，自动熔断请求，返回预设的降级响应。
• 热点参数限流：针对高频访问的参数（如商品ID、用户ID）实施精细化限流。
• 系统自适应保护：根据网关节点的负载（CPU、内存等）动态调整流量阈值。

---

三. 典型场景

• 突发流量拦截：防止恶意刷接口或秒杀活动导致的系统过载。
• 服务降级：在依赖的下游服务故障时，快速返回缓存或默认值，避免雪崩。
• 灰度发布：通过流控规则将部分流量导到新版本服务。
• API 权限控制：结合 Sentinel 的规则限制未授权或低频用户的访问。

---

四. 与普通 Sentinel 的区别

特性	Spring Cloud Alibaba Sentinel Gateway	普通 Sentinel（如用于 Spring MVC）
作用层级	网关层（全局入口）	单个微服务内部
规则维度	路由、API 分组	方法、资源名
依赖	需集成 Spring Cloud Gateway	直接集成到应用

---

五. 配置示例

在 application.yml 中启用 Sentinel Gateway：

spring:
  cloud:
    gateway:
      enabled: true
    sentinel:
      enabled: true
      # 配置 Sentinel 控制台地址（可选）
      transport:
        dashboard: localhost:8080
      # 启用网关流控过滤器
      filter:
        enabled: true

通过 Sentinel 控制台 动态配置网关规则（如对 /order/** 路由限流 100 QPS）。

---

六. 优势

• 无缝整合：与 Spring Cloud Gateway 原生兼容，无需额外编码。
• 动态生效：规则可通过 Sentinel 控制台实时推送，无需重启网关。
• 生产级功能：支持集群流控、监控数据持久化（需配合 Nacos/AHAS 使用）。

---

七、核心原理：Sentinel 如何与网关整合？

1. 架构层级

• 网关层（Gateway Level） ：所有流量首先经过 Spring Cloud Gateway，Sentinel 通过内置的 SentinelGatewayFilter 拦截请求，在网关层直接执行流控逻辑，无需透传到后端服务。
• 资源标识 ：Sentinel 以网关的 路由ID（如 order-service） 或 自定义API分组 作为资源名称，而非微服务内部的URL或方法。

2. 关键组件

• SentinelGatewayFilter：核心过滤器，处理请求前调用 Sentinel API 检查流控规则。
• GatewayFlowRuleManager：动态管理网关流控规则（如从控制台推送规则到网关）。
• GatewayCallbackManager：配置自定义的限流/熔断回调逻辑（如返回JSON格式的错误信息）。

3. 规则生效流程

通过 拒绝 客户端请求 Spring Cloud Gateway SentinelGatewayFilter检查 转发到后端服务 返回Blocked by Sentinel响应

---

八、详细功能拆解

1. 流量控制（Flow Control）

• 规则类型 ：

  • QPS限流 ：如 /order-api 路径最大 1000 次请求/秒。
  • 并发线程数：限制同时处理的请求线程数。
  • 关联流量 ：当 /pay-api 超阈值时，限制 /order-api 的流量。

• 配置示例（代码） ：

  // 通过代码定义规则（实际推荐用控制台动态配置）
  GatewayFlowRule rule = new GatewayFlowRule("order-route")
      .setCount(100)         // 阈值
      .setIntervalSec(1)      // 统计窗口（秒）
      .setBurst(50);          // 突发流量容限
  GatewayRuleManager.loadRules(Collections.singletonList(rule));

2. 熔断降级（Circuit Breaking）

• 触发条件 ：
  • 慢调用比例（RT > 500ms 且比例超过50%）。
  • 异常比例（异常率 > 60%）。
• 降级策略 ：
  • 直接返回默认响应。
  • 调用Fallback接口（如返回缓存数据）。

3. 热点参数限流（Param Flow Control）

• 场景 ：针对高频参数（如 productId=123）单独限流。

• 示例配置 ：

  ParamFlowItem item = new ParamFlowItem()
      .setObject("productId")  // 参数名
      .setClassType(int.class) // 参数类型
      .setCount(10);          // 单参数阈值
  ParamFlowRule rule = new ParamFlowRule("order-route")
      .setParamFlowItems(Collections.singletonList(item));

4. 系统自适应保护（System Rule）

• 监控指标 ：
  • CPU使用率 > 80% 时触发限流。
  • 平均RT > 1s 时拒绝新请求。
• 全局保护：防止网关本身因资源耗尽崩溃。

---

九、完整使用步骤（Spring Boot 3.x + Spring Cloud 2022+）

1. 添加依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
    <version>2022.0.0.0</version>
</dependency>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
    <version>2022.0.0.0</version>
</dependency>

2. 配置网关路由和Sentinel

spring:
  cloud:
    gateway:
      routes:
        - id: order-service
          uri: lb://order-service
          predicates:
            - Path=/order/**
    sentinel:
      eager: true  # 强制初始化Sentinel
      transport:
        dashboard: localhost:8080  # Sentinel控制台地址
      scg:
        enabled: true  # 显式启用对Spring Cloud Gateway的支持

3. 自定义限流响应

@Configuration
public class SentinelConfig {
    @PostConstruct
    public void init() {
        GatewayCallbackManager.setBlockHandler((exchange, ex) -> {
            Map<String, String> response = Map.of(
                "code", "429",
                "message", "请求过于频繁，请稍后重试"
            );
            return Mono.just(exchange.getResponse())
                .flatMap(resp -> {
                    resp.setStatusCode(HttpStatus.TOO_MANY_REQUESTS);
                    resp.getHeaders().add("Content-Type", "application/json");
                    DataBuffer buffer = resp.bufferFactory()
                        .wrap(JSON.toJSONBytes(response));
                    return resp.writeWith(Mono.just(buffer));
                });
        });
    }
}

---

十、高级配置技巧

1. 规则持久化到Nacos

• 将流控规则保存到Nacos，避免重启丢失：

  spring:
    cloud:
      sentinel:
        datasource:
          gw-flow:
            nacos:
              server-addr: localhost:8848
              dataId: sentinel-gw-flow-rules
              ruleType: GW_FLOW

2. 集群流控

• 多网关节点共享流控计数器（需部署Sentinel Token Server）：

  spring:
    cloud:
      sentinel:
        filter:
          enabled: true
        transport:
          client-ip: ${spring.cloud.client.ip-address}
        cluster:
          enabled: true
          server-addr: ${sentinel.token.server.host}

3. 监控集成

• 对接Prometheus + Grafana：

  <dependency>
      <groupId>com.alibaba.csp</groupId>
      <artifactId>sentinel-datasource-extension</artifactId>
  </dependency>

---

十一、实际案例：电商网关限流

场景需求

• 对 /api/product/{id} 接口实施限流：
  • 普通用户：100 QPS。
  • VIP用户：1000 QPS（通过Header X-User-Level=VIP 识别）。

实现代码

// 自定义解析器识别VIP用户
public class VipParamParser implements GatewayParamParser {
    @Override
    public String parse(HttpRequest request, String key) {
        return request.getHeaders().getFirst("X-User-Level");
    }
}

// 注册解析器并配置规则
@PostConstruct
public void init() {
    GatewayCallbackManager.setRequestOriginParser(exchange -> 
        exchange.getRequest().getHeaders().getFirst("X-User-Level"));
    
    List<GatewayFlowRule> rules = Arrays.asList(
        new GatewayFlowRule("product-route")
            .setCount(100)
            .setStrategy(RuleConstant.STRATEGY_DIRECT),
        new GatewayFlowRule("product-route")
            .setCount(1000)
            .setStrategy(RuleConstant.STRATEGY_DIRECT)
            .setParamItem(new ParamFlowItem()
                .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_HEADER)
                .setFieldName("X-User-Level")
                .setPattern("VIP")
                .setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_EXACT))
    );
    GatewayRuleManager.loadRules(rules);
}

---

常见问题解答

Q1：Sentinel Gateway与Spring Cloud Gateway自带的RequestRateLimiter有什么区别？

A1：

• RequestRateLimiter：基于Redis的简单计数器，功能单一，不支持熔断、热点规则。
• Sentinel Gateway：功能全面，支持动态规则、系统保护、集群流控，且能与微服务内Sentinel联动。

Q2：如何测试限流是否生效？

A2：

• 使用 jmeter 或 wrk 压测网关接口。
• 观察日志：SentinelBlockException 或自定义限流响应。
• 通过Sentinel控制台实时监控流量曲线。

Q3：生产环境推荐如何部署？

A3：

• 至少2个Sentinel控制台节点（高可用）。
• 规则持久化到Nacos/Redis。
• 网关节点开启集群流控。

---

总结

如果使用 Spring Cloud Gateway 作为网关，并需要限流、熔断等能力，Spring Cloud Alibaba Sentinel Gateway 是一个高效的选择。它弥补了网关层流量控制的空白，是微服务稳定性的重要保障工具。