1. 前言

4月25号,Sentinel 1.6.0 正式发布,带来 Spring Cloud Gateway 支持、控制台登录功能、改进的热点限流和注解 fallback 等多项新特性,该出手时就出手,紧跟时代潮流,昨天刚发布,今天我就要给大家分享下如何使用!

2. 介绍(本段来自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 分组维度进行限流。

其中网关限流规则 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 和 matchStrategy:为后续参数匹配特性预留,目前未实现。

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

3. 使用

3.1 快速体验

首先你的有一个Spring Cloud Gateway的项目,如果没有,新建一个,增加Gateway和sentinel-spring-cloud-gateway-adapter的依赖,如下:

  1. <dependency>
  2. <groupId>org.springframework.cloud</groupId>
  3. <artifactId>spring-cloud-starter-gateway</artifactId>
  4. </dependency>
  5. <dependency>
  6. <groupId>com.alibaba.csp</groupId>
  7. <artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
  8. <version>1.6.0</version>
  9. </dependency>

新建一个application.yml配置文件,用来配置路由:

  1. server:
  2. port: 2001
  3. spring:
  4. application:
  5. name: spring-cloud-gateway
  6. cloud:
  7. gateway:
  8. routes:
  9. - id: path_route
  10. uri: http://cxytiandi.com
  11. predicates:
  12. - Path=/course

配置了Path路由,等会使用 http://localhost:2001/course 进行访问即可。

增加一个GatewayConfiguration 类,用于配置Gateway限流要用到的类,目前是手动配置的方式,后面肯定是可以通过注解启用,配置文件中指定限流规则的方式来使用,当然这部分工作会交给Spring Cloud Alibaba来做,后面肯定会发新版本的,大家耐心等待就行了。

  1. @Configuration
  2. public class GatewayConfiguration {
  3. private final List<ViewResolver> viewResolvers;
  4. private final ServerCodecConfigurer serverCodecConfigurer;
  5. public GatewayConfiguration(ObjectProvider<List<ViewResolver>> viewResolversProvider,
  6. ServerCodecConfigurer serverCodecConfigurer) {
  7. this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
  8. this.serverCodecConfigurer = serverCodecConfigurer;
  9. }
  10. /**
  11. * 配置SentinelGatewayBlockExceptionHandler,限流后异常处理
  12. * @return
  13. */
  14. @Bean
  15. @Order(Ordered.HIGHEST_PRECEDENCE)
  16. public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
  17. return new SentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
  18. }
  19. /**
  20. * 配置SentinelGatewayFilter
  21. * @return
  22. */
  23. @Bean
  24. @Order(-1)
  25. public GlobalFilter sentinelGatewayFilter() {
  26. return new SentinelGatewayFilter();
  27. }
  28. @PostConstruct
  29. public void doInit() {
  30. initGatewayRules();
  31. }
  32. /**
  33. * 配置限流规则
  34. */
  35. private void initGatewayRules() {
  36. Set<GatewayFlowRule> rules = new HashSet<>();
  37. rules.add(new GatewayFlowRule("path_route")
  38. .setCount(1) // 限流阈值
  39. .setIntervalSec(1) // 统计时间窗口,单位是秒,默认是 1 秒
  40. );
  41. GatewayRuleManager.loadRules(rules);
  42. }
  43. }

我们定义的资源名称是path_route,也就是application.yml中的路由ID,一致就行。

在一秒钟内多次访问http://localhost:2001/course就可以看到限流启作用了。

3.2 指定参数限流

上面的配置是针对整个路由来限流的,如果我们只想对某个路由的参数做限流,那么可以使用参数限流方式:

  1. rules.add(new GatewayFlowRule("path_route")
  2. .setCount(1)
  3. .setIntervalSec(1)
  4. .setParamItem(new GatewayParamFlowItem()
  5. .setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM).setFieldName("vipType")
  6. )
  7. );

通过指定PARAM_PARSE_STRATEGY_URL_PARAM表示从url中获取参数,setFieldName指定参数名称

3.3 自定义API分组

假设我有下面两个路由,我想让这两个路由共用一个限流规则,那么我们可以自定义进行组合:

  1. - id: path2_route
  2. uri: http://cxytiandi.com
  3. predicates:
  4. - Path=/article
  5. - id: path3_route
  6. uri: http://cxytiandi.com
  7. predicates:
  8. - Path=/blog/**

自定义分组代码:

  1. private void initCustomizedApis() {
  2. Set<ApiDefinition> definitions = new HashSet<>();
  3. ApiDefinition api1 = new ApiDefinition("customized_api")
  4. .setPredicateItems(new HashSet<ApiPredicateItem>() {{
  5. // article完全匹配
  6. add(new ApiPathPredicateItem().setPattern("/article"));
  7. // blog/开头的
  8. add(new ApiPathPredicateItem().setPattern("/blog/**")
  9. .setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_PREFIX));
  10. }});
  11. definitions.add(api1);
  12. GatewayApiDefinitionManager.loadApiDefinitions(definitions);
  13. }

然后我们需要给customized_api这个资源进行配置:

  1. rules.add(new GatewayFlowRule("customized_api")
  2. .setCount(1)
  3. .setIntervalSec(1)
  4. );

3.4 自定义异常提示

前面我们有看到,当触发限流后页面显示的是Blocked by Sentinel: FlowException,正常情况下,就算给出提示也要跟后端服务的数据格式一样,如果你后端都是JSON格式的数据,那么异常的提示也要是JSON的格式,所以问题来了,我们怎么去自定义异常的输出?

前面我们有配置SentinelGatewayBlockExceptionHandler,我的注释写的限流后异常处理,我们可以进去看下源码就知道是不是异常处理了。下面贴出核心的代码:

  1. private Mono<Void> writeResponse(ServerResponse response, ServerWebExchange exchange) {
  2. return response.writeTo(exchange, contextSupplier.get());
  3. }
  4. @Override
  5. public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {
  6. if (exchange.getResponse().isCommitted()) {
  7. return Mono.error(ex);
  8. }
  9. // This exception handler only handles rejection by Sentinel.
  10. if (!BlockException.isBlockException(ex)) {
  11. return Mono.error(ex);
  12. }
  13. return handleBlockedRequest(exchange, ex)
  14. .flatMap(response -> writeResponse(response, exchange));
  15. }

重点在于writeResponse这个方法,我们只要把这个方法改掉,返回自己想要返回的数据就行了,可以自定义一个SentinelGatewayBlockExceptionHandler的类来实现。

比如:

  1. public class JsonSentinelGatewayBlockExceptionHandler implements WebExceptionHandler {
  2. // ........
  3. }

然后复制SentinelGatewayBlockExceptionHandler中的代码到JsonSentinelGatewayBlockExceptionHandler 中,只改动writeResponse一个方法即可。

  1. private Mono<Void> writeResponse(ServerResponse response, ServerWebExchange exchange) {
  2. ServerHttpResponse serverHttpResponse = exchange.getResponse();
  3. serverHttpResponse.getHeaders().add("Content-Type", "application/json;charset=UTF-8");
  4. byte[] datas = "{\"code\":403,\"msg\":\"限流了\"}".getBytes(StandardCharsets.UTF_8);
  5. DataBuffer buffer = serverHttpResponse.bufferFactory().wrap(datas);
  6. return serverHttpResponse.writeWith(Mono.just(buffer));
  7. }

最后将配置的SentinelGatewayBlockExceptionHandler改成JsonSentinelGatewayBlockExceptionHandler 。

  1. @Bean
  2. @Order(Ordered.HIGHEST_PRECEDENCE)
  3. public JsonSentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
  4. return new JsonSentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
  5. }

欢迎加入我的知识星球,一起交流技术,免费学习猿天地的课程(http://cxytiandi.com/course)

PS:目前星球中正在星主的带领下组队学习Spring Cloud,等你哦!

阿里Sentinel支持Spring Cloud Gateway啦的更多相关文章

  1. Spring Cloud Gateway(二):Spring Cloud Gateway整合Eureka应用

    Spring Cloud Gateway 应用概述 下面的示例启动两个服务:gataway-server 和 user-service 都注册到注册中心 Eureka上,客户端请求后端服务[user- ...

  2. Spring Cloud Gateway 整合阿里 Sentinel网关限流实战!

    大家好,我是不才陈某~ 这是<Spring Cloud 进阶>第八篇文章,往期文章如下: 五十五张图告诉你微服务的灵魂摆渡者Nacos究竟有多强? openFeign夺命连环9问,这谁受得 ...

  3. Spring Cloud gateway 六 Sentinel nacos存储动态刷新

    微服务当前这么火爆的程度,如果不能学会一种微服务框架技术.怎么能升职加薪,增加简历的筹码?spring cloud 和 Dubbo 需要单独学习.说没有时间?没有精力?要学俩个框架?而Spring C ...

  4. Spring Cloud Gateway 扩展支持动态限流

    之前分享过 一篇 <Spring Cloud Gateway 原生的接口限流该怎么玩>, 核心是依赖Spring Cloud Gateway 默认提供的限流过滤器来实现 原生Request ...

  5. Spring Cloud gateway 五 Sentinel整合

    微服务当前这么火爆的程度,如果不能学会一种微服务框架技术.怎么能升职加薪,增加简历的筹码?spring cloud 和 Dubbo 需要单独学习.说没有时间?没有精力?要学俩个框架?而Spring C ...

  6. spring cloud gateway整合sentinel作网关限流

    说明: sentinel可以作为各微服务的限流,也可以作为gateway网关的限流组件. spring cloud gateway有限流功能,但此处用sentinel来作为替待. 说明:sentine ...

  7. 搭建一套ASP.NET Core+Nacos+Spring Cloud Gateway项目

    前言     伴随着随着微服务概念的不断盛行,与之对应的各种解决方案也层出不穷.这毕竟是一个信息大爆发的时代,各种编程语言大行其道,各有各的优势.但是有一点未曾改变,那就是他们服务的方式,工作的时候各 ...

  8. 【Spring Cloud & Alibaba 实战 | 总结篇】Spring Cloud Gateway + Spring Security OAuth2 + JWT 实现微服务统一认证授权和鉴权

    一. 前言 hi,大家好~ 好久没更文了,期间主要致力于项目的功能升级和问题修复中,经过一年时间的打磨,[有来]终于迎来v2.0版本,相较于v1.x版本主要完善了OAuth2认证授权.鉴权的逻辑,结合 ...

  9. Spring Cloud Gateway夺命连环10问?

    大家好,我是不才陈某~ 最近有很多小伙伴私信我催更 <Spring Cloud 进阶>,陈某也总结了一下,最终原因就是陈某之前力求一篇文章将一个组件重要知识点讲透,这样导致了文章篇幅很长, ...

随机推荐

  1. Note | 用Hugo搭建博客并部署到GitHub Pages

    目录 1. 本地搭建 1.1 安装Hugo 1.2 创建站点 1.3 新建页面和文章 1.4 使用主题 1.5 修改配置文件 1.6 预览 2. 部署 之前担心过现有博客平台(如博客园,CSDN)突然 ...

  2. 大话设计模式Python实现-桥接模式

    桥接模式(Bridge Pattern):将抽象部分与它的实现部分分离,使它们都可以独立地变化. 下面是一个桥接模式的demo: #!/usr/bin/env python # -*- coding: ...

  3. 实现简易JDBC框架

    1 准备 JDBC 基本知识 JDBC元数据知识 反射基本知识 2:  两个问题 业务背景:系统中所有实体对象都涉及到基本的CRUD操作.所有实体的CUD操作代码基本相同,仅仅是发送给数据库的sql语 ...

  4. web自动化针对PO模式进行二次封装之basepage

    在PO模式当中,我们做到了页面对象与测试用例的分离,但在页面对象编写时,我们仍然还有优化的空间.页面对象有一些共同的基本操作,可以封装起来,并可以在基本操作当中加上日志和异常截图的处理.比如说我们在查 ...

  5. 二、Mapper映射文件

    Mapper映射文件 mapper.xml映射文件主要是用来编写SQL语句的,以及一些结果集的映射关系的编写,还有就是缓存的一些配置等等. 在映射文件里面可以配置以下标签: 元素名称 描述 备注 se ...

  6. 一个Web前端工程师或程序员的发展方向,未来困境及穷途末路

    如果你刚好是一个Web前端工程师,或者你将要从事web前端工作.你应该和我有同样的感慨,web前端技术到了自己的天花板,前端工作我能做多少年?3年或5年?自己的职业规划应该怎么样?收入为什么没有增长? ...

  7. gcc 编译安装

    wget https://kojipkgs.fedoraproject.org//packages/gcc/7.1.1/1.module_1a179a7b/src/gcc-7.1.1-1.module ...

  8. Pycharm 疑难杂症

    1. Pycharm报错:AttributeError: 'NoneType' object has no attribute 'get'的解决办法 https://blog.csdn.net/fre ...

  9. angular 前端路由不生效解决方案

    angular 前端路由不生效解决方案 Intro 最近使用 Angular 为我的活动室预约项目开发一个前后端分离的客户端,在部署上遇到了一个问题,前端路由不生效,这里记录一下.本地开发正常,但是部 ...

  10. Docker实用debug调试技巧锦集

    阅读约 20 分钟 『重用』容器名 但我们在编写/调试Dockerfile的时候我们经常会重复之前的command,比如这种docker run --name jstorm-zookeeper zoo ...