AI 助理
备案控制台
开发者社区 微服务 文章 正文

说一说 SpringCloud Gateway 使用 Sentinel 实现服务限流熔断​

2025-06-15 265
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 我是小假 期待与你的下一次相遇 ~

1、介绍

Alibaba Sentinel 支持对 Spring Cloud Gateway、Netflix Zuul 等主流的 API Gateway 进行限流与熔断配置。

本文将介绍如何在 Spring Cloud Gateway 中使用 Alibaba Sentinel 进行限流配置，从而代替 Hystrix.

2、集成步骤

2.1. 首先需在Gateway网关模块引入以下依赖配置

（以 Maven 为例）：

方案一：只需引入 sentinel-spring-cloud-gateway-adapter 无需引入 spring-cloud-starter-alibaba-sentinel

  1. <dependency>
  2.    <groupId>com.alibaba.csp</groupId>
  3.    <artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
  4.    <version>x.y.z</version>
  5. </dependency>

方案二：如果需要在Sentinel 控制台管理 网关模块的限流，那么推荐这种配置方式

如果想引入 spring-cloud-starter-alibaba-sentinel 那么就把上面那个 adapter 替换成 spring-cloud-alibaba-sentinel-gateway

  1. <!-- 没添加该依赖的话不能从application配置文件配置sentinel -->
  2. <dependency>
  3.    <groupId>com.alibaba.cloud</groupId>
  4.    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
  5. </dependency>
  6. <dependency>
  7.    <groupId>com.alibaba.cloud</groupId>
  8.    <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
  9. </dependency>

2.2 然后在使用时只需注入对应的 SentinelGatewayFilter 实例以及 SentinelGatewayBlockExceptionHandler 实例即可。

  1. @Configuration
  2. public class GatewayConfiguration {
  4.    private final List<ViewResolver> viewResolvers;
  5.    private final ServerCodecConfigurer serverCodecConfigurer;
  7.    public GatewayConfiguration(ObjectProvider<List<ViewResolver>> viewResolversProvider,
  8.                                ServerCodecConfigurer serverCodecConfigurer) {
  9.        this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
  10.        this.serverCodecConfigurer = serverCodecConfigurer;
  11.    }
  13.    @Bean
  14.    @Order(Ordered.HIGHEST_PRECEDENCE)
  15.    public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
  16.        // Register the block exception handler for Spring Cloud Gateway.
  17.        return new SentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
  18.    }
  20.    @Bean
  21.    @Order(Ordered.HIGHEST_PRECEDENCE)
  22.    public GlobalFilter sentinelGatewayFilter() {
  23.        return new SentinelGatewayFilter();
  24.    }
  25. }

2.3 现在可以选择在控制台中配置Sentinel限流规则 或者选择直接在Java代码中配置限流规则

2.3.1. 如果选择使用 Sentinel 控制台配置限流-熔断规则，那么还需要在 gateway 的配置文件中做出如下配置：

  1. spring:
  2.  cloud:
  3.    # Sentinel 控制台连接配置
  4.    sentinel:
  5.      transport:
  6.       # 当前服务与控制台交互的端口号,默认为8719,同一个机器上若有多个应用于控制台交互时需要设置成不同的端口
  7.        port: 8739
  8.        dashboard: 10.1.3.77:9090
  9.      # 服务启动时直接建立心跳连接
  10.      eager: true
  11.      # Sentinel 储存规则的数据源配置(我这里使用的是Nacos来存储Sentinel的限流规则)
  12.      datasource:
  13.        ds:
  14.          nacos:
  15.            # Nacos 服务地址（可配置单点，或者集群的VIP地址）
  16.            server-addr: 10.1.3.76:8848
  17.            dataId: ${spring.application.name}-sentinel
  18.            groupId: DEFAULT_GROUP
  19.            namespace: sms-dev
  20.            rule-type: flow
  21. # Sentinel 控制台鉴权配置
  22. sentinel:
  23.  dashboard:
  24.    auth:
  25.      username: sentinel
  26.      password: sentinel

此时就可以在Sentinel控制台页面中配置限流规则，或者在 Nacos 配置中心中添加限流配置文件sms-gateway-sentinel

  1. [
  2.    {
  3.        "resource": "api-service",
  4.        "limitApp": "default",
  5.        "grade": 1,
  6.        "count": 2,
  7.        "strategy": 0,
  8.        "controlBehavior": 0,
  9.        "clusterMode": false
  10.    },
  11.    {
  12.        "resource": "url-proxy-1",
  13.        "limitApp": "default",
  14.        "grade": 1,
  15.        "count": 2,
  16.        "strategy": 0,
  17.        "controlBehavior": 0,
  18.        "clusterMode": false
  19.    }
  20. ]

2.3.2 如果选择在Java代码中配置限流规则

下面是一个详细的配置示例

  1. import com.alibaba.csp.sentinel.adapter.gateway.common.SentinelGatewayConstants;
  2. import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiDefinition;
  3. import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiPathPredicateItem;
  4. import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiPredicateItem;
  5. import com.alibaba.csp.sentinel.adapter.gateway.common.api.GatewayApiDefinitionManager;
  6. import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayFlowRule;
  7. import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayRuleManager;
  8. import com.alibaba.csp.sentinel.adapter.gateway.sc.SentinelGatewayFilter;
  9. import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.BlockRequestHandler;
  10. import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.GatewayCallbackManager;
  11. import com.alibaba.csp.sentinel.adapter.gateway.sc.exception.SentinelGatewayBlockExceptionHandler;
  12. import com.alibaba.csp.sentinel.slots.block.RuleConstant;
  13. import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRule;
  14. import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRuleManager;
  15. import org.springframework.beans.factory.ObjectProvider;
  16. import org.springframework.cloud.gateway.filter.GlobalFilter;
  17. import org.springframework.context.annotation.Bean;
  18. import org.springframework.context.annotation.Configuration;
  19. import org.springframework.core.Ordered;
  20. import org.springframework.core.annotation.Order;
  21. import org.springframework.http.HttpStatus;
  22. import org.springframework.http.MediaType;
  23. import org.springframework.http.codec.ServerCodecConfigurer;
  24. import org.springframework.web.reactive.function.BodyInserters;
  25. import org.springframework.web.reactive.function.server.ServerResponse;
  26. import org.springframework.web.reactive.result.view.ViewResolver;
  27. import org.springframework.web.server.ServerWebExchange;
  28. import reactor.core.publisher.Mono;
  30. import javax.annotation.PostConstruct;
  31. import java.util.*;
  33. /**
  34. * @description: 网关限流配置
  35. * @create: 2020-08-26 12:23
  36. **/
  37. @Configuration
  38. public class GatewaySentinelConfiguration {
  39.    private final List<ViewResolver> viewResolvers;
  40.    private final ServerCodecConfigurer serverCodecConfigurer;
  42.    public GatewaySentinelConfiguration(ObjectProvider<List<ViewResolver>> viewResolversProvider,
  43.                                        ServerCodecConfigurer serverCodecConfigurer) {
  44.        this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
  45.        this.serverCodecConfigurer = serverCodecConfigurer;
  46.    }
  49.    @Bean
  50.    @Order(Ordered.HIGHEST_PRECEDENCE)
  51.    public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
  52.        // Register the block exception handler for Spring Cloud Gateway.
  53.        return new SentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
  54.    }
  56.    @Bean
  57.    @Order(Ordered.HIGHEST_PRECEDENCE)
  58.    public GlobalFilter sentinelGatewayFilter() {
  59.        return new SentinelGatewayFilter();
  60.    }
  62.    /**
  63.    * Spring 容器初始化的时候执行该方法
  64.    */
  65.    @PostConstruct
  66.    public void doInit() {
  67.        // 加载网关限流规则
  68.        initGatewayRules();
  69.        // 加载自定义限流异常处理器
  70.        initBlockHandler();
  71.    }
  73.    /**
  74.    * 网关限流规则
  75.    * 建议直接在 Sentinel 控制台上配置
  76.    */
  77.    private void initGatewayRules() {
  78.        Set<GatewayFlowRule> rules = new HashSet<>();
  79.        /*
  80.        resource：资源名称，可以是网关中的 route 名称或者用户自定义的 API 分组名称
  81.        count：限流阈值
  82.        intervalSec：统计时间窗口，单位是秒，默认是 1 秒
  83.        */
  84.        // rules.add(new GatewayFlowRule("order-service")
  85.        //         .setCount(3) // 限流阈值
  86.        //         .setIntervalSec(60)); // 统计时间窗口，单位是秒，默认是 1 秒
  87.        // --------------------限流分组----------start----------
  88.        rules.add(new GatewayFlowRule("url-proxy-1")
  89.                  .setCount(1) // 限流阈值
  90.                  .setIntervalSec(60)); // 统计时间窗口，单位是秒，默认是 1 秒
  91.        rules.add(new GatewayFlowRule("api-service")
  92.                  .setCount(5) // 限流阈值
  93.                  .setIntervalSec(60)); // 统计时间窗口，单位是秒，默认是 1 秒
  94.        // --------------------限流分组-----------end-----------
  96.        // 加载网关限流规则
  97.        GatewayRuleManager.loadRules(rules);
  98.        // 加载限流分组
  99.        initCustomizedApis();
  101.        // ---------------熔断-降级配置-------------
  102.        DegradeRule degradeRule = new DegradeRule("api-service") // 资源名称
  103.            .setGrade(RuleConstant.DEGRADE_GRADE_EXCEPTION_RATIO) // 异常比率模式(秒级)
  104.            .setCount(0.5) // 异常比率阈值(50%)
  105.            .setTimeWindow(10); // 熔断降级时间(10s)
  106.        // 加载规则.
  107.        DegradeRuleManager.loadRules(Collections.singletonList(degradeRule));
  108.    }
  110.    /**
  111.    * 自定义限流异常处理器
  112.    */
  113.    private void initBlockHandler() {
  114.        BlockRequestHandler blockRequestHandler = new BlockRequestHandler() {
  115.            @Override
  116.            public Mono<ServerResponse> handleRequest(ServerWebExchange serverWebExchange, Throwable throwable) {
  117.                Map<String, String> result = new HashMap<>(3);
  118.                result.put("code", String.valueOf(HttpStatus.TOO_MANY_REQUESTS.value()));
  119.                result.put("message", HttpStatus.TOO_MANY_REQUESTS.getReasonPhrase());
  120.                result.put("x","xx");
  121.                return ServerResponse.status(HttpStatus.TOO_MANY_REQUESTS)
  122.                    .contentType(MediaType.APPLICATION_JSON)
  123.                    //                        .body(BodyInserters.fromValue(result));
  124.                    .body(BodyInserters.fromObject(result));
  125.            }
  126.        };
  128.        // 加载自定义限流异常处理器
  129.        GatewayCallbackManager.setBlockHandler(blockRequestHandler);
  130.    }
  132.    /**
  133.    * 分组限流
  134.    */
  135.    private void initCustomizedApis() {
  136.        //demo
  137.        Set<ApiDefinition> definitions = new HashSet<>();
  138.        // product-api 组
  139.        ApiDefinition api1 = new ApiDefinition("product-api")
  140.            .setPredicateItems(new HashSet<ApiPredicateItem>() {{
  141.                // 匹配 /product-service/product 以及其子路径的所有请求
  142.                add(new ApiPathPredicateItem().setPattern("/product-service/product/**")
  143.                    .setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX));
  144.            }});
  146.        // order-api 组
  147.        ApiDefinition api2 = new ApiDefinition("order-api")
  148.            .setPredicateItems(new HashSet<ApiPredicateItem>() {{
  149.                // 只匹配 /order-service/order/index
  150.                add(new ApiPathPredicateItem().setPattern("/order-service/order/index"));
  151.            }});
  152.        definitions.add(api1);
  153.        definitions.add(api2);
  154.        // 加载限流分组
  155.        GatewayApiDefinitionManager.loadApiDefinitions(definitions);
  156.    }
  157. }

Tips：这种配置方式只适合固定的限流规则配置，如果需要灵活变动，那么建议使用上面那种方式

3、总结

如果 Gateway 用 Sentinel

  • 建议在 Sentinel 控制台对 网关模块 进行具体的限流，熔断降级配置。
  • 否则还是推荐直接用 Gateway 内置的 RequestRateLimiter 跟 Hystrix 进行熔断限流配置。

还可以参考：https://github.com/alibaba/Sentinel/wiki/Guideline：-从-Hystrix-迁移到-Sentinel

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

  • route 维度： 即在 Spring 配置文件中配置的路由条目，资源名为对应的 routeId* 在网关上用 Sentinel , 那么默认情况下一个 RouteId 对应的服务就是一个资源。
  • GatewayFlowRule： 网关限流规则，针对 API Gateway 的场景定制的限流规则，可以针对不同 route 或自定义的 API 分组进行限流，支持针对请求中的参数、Header、来源 IP 等进行定制化的限流。

自定义 API 维度： 用户可以利用 Sentinel 提供的 API 来自定义一些 API 分组

ApiDefinition：用户自定义的 API 定义分组，可以看做是一些 URL 匹配的组合。比如可以定义一个 API 叫 my_api，请求 path 模式为 /foo/** 和 /baz/** 的都归到 my_api 这个 API 分组下面。限流的时候可以针对这个自定义的 API 分组维度进行限流。

官方Demo 示例：https://github.com/alibaba/Sentinel/tree/master/sentinel-demo/sentinel-demo-spring-cloud-gateway


文章标签：
Sentinel
Java
API
Spring
Nacos
程序员小假
目录
相关文章
磊哥聊Java
|
NoSQL 算法 Java
面试官：网关如何实现限流？
面试官：网关如何实现限流？
磊哥聊Java
733 2
面试官：网关如何实现限流？
秃秃爱健身
|
域名解析 Kubernetes Java
图文详述Nacos配置中心使用：应用间配置共享、扩展配置文件加载优先级、新老版本差异
图文详述Nacos配置中心使用：应用间配置共享、扩展配置文件加载优先级、新老版本差异
秃秃爱健身
5827 1
图文详述Nacos配置中心使用：应用间配置共享、扩展配置文件加载优先级、新老版本差异
程序员小海绵
|
10月前
|
负载均衡 Java Nacos
SpringCloud基础2——Nacos配置、Feign、Gateway
nacos配置管理、Feign远程调用、Gateway服务网关
程序员小海绵
2014 2
SpringCloud基础2——Nacos配置、Feign、Gateway
1288912195458132
|
11月前
|
Kubernetes 数据库 容器
k8s快速部署xxl-job
k8s快速部署xxl-job
1288912195458132
850 3
土木林森
|
11月前
|
前端开发 JavaScript 测试技术
"React新手入门的神奇之处：如何用React构建第一个应用，让你的项目一鸣惊人？"
【8月更文挑战第31天】本文详细介绍了如何从头开始构建首个React应用。React作为当今Web开发中备受欢迎的前端框架，采用组件化设计实现界面构建，便于维护与扩展。文章首先解释了React的基础概念，接着演示了使用Create React App搭建项目的步骤，展示了基础组件编写方法及React Router的简单运用，并分享了一些实用的最佳实践建议，帮助读者快速上手React开发。
土木林森
177 0
DearSil
|
Java Sentinel 微服务
Spring Cloud Alibaba 实操 (十四) Sentinel对Gateway网关进行限流
Sentinel对Gateway网关进行限流
DearSil
1163 0
Spring Cloud Alibaba 实操 (十四) Sentinel对Gateway网关进行限流
墨家巨子@俏如来
|
SpringCloudAlibaba Java Sentinel
十四.SpringCloudAlibaba极简入门-Sentinel对Gateway网关进行限流
服务网关在微服务架构中充当了请求访问入口的角色，是非常重要的一个部分，在高并发的系统中我们通常会在网关层通过流控降级等手段把多余的请求拒绝在外来防止微服务被高并发请求打垮，在之前我们有讨论过《服务网关Spring Cloud Gateway》和 《Sentinel流控》，一个是服务网关，一个是流控降级，本篇文章要讨论的是如何使用Sentinel对Gateway进行流控
墨家巨子@俏如来
599 0
理想shi做条咸鱼
|
Java Maven
关于idea依赖引用正确但是 编译报错“找不到符号”问题
解决烧脑问题，尝试重启、清理Maven重编译或改字符集删除target。一张图片总结其他方法，简单易行。重点检查Maven主路径，避免默认捆绑设置。附两张图片示例，完成操作后重新编译启动，问题解决
理想shi做条咸鱼
903 0
最后一支迷迭香
|
SpringCloudAlibaba 监控 Java
SpringCloud Alibaba微服务-- Sentinel的使用（保姆级）
SpringCloud Alibaba微服务-- Sentinel的使用（保姆级）
最后一支迷迭香
7204 0
杭州小哥哥
|
Sentinel
sentinel的@SentinelResource注解使用
sentinel的@SentinelResource注解使用
杭州小哥哥
642 0