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的依赖,如下:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba.csp</groupId>
<artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
<version>1.6.0</version>
</dependency>
新建一个application.yml配置文件,用来配置路由:
server:
port: 2001
spring:
application:
name: spring-cloud-gateway
cloud:
gateway:
routes:
- id: path_route
uri: http://cxytiandi.com
predicates:
- Path=/course
配置了Path路由,等会使用 http://localhost:2001/course 进行访问即可。
增加一个GatewayConfiguration 类,用于配置Gateway限流要用到的类,目前是手动配置的方式,后面肯定是可以通过注解启用,配置文件中指定限流规则的方式来使用,当然这部分工作会交给Spring Cloud Alibaba来做,后面肯定会发新版本的,大家耐心等待就行了。
@Configuration
public class GatewayConfiguration {
private final List<ViewResolver> viewResolvers;
private final ServerCodecConfigurer serverCodecConfigurer;
public GatewayConfiguration(ObjectProvider<List<ViewResolver>> viewResolversProvider,
ServerCodecConfigurer serverCodecConfigurer) {
this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
this.serverCodecConfigurer = serverCodecConfigurer;
}
/**
* 配置SentinelGatewayBlockExceptionHandler,限流后异常处理
* @return
*/
@Bean
@Order(Ordered.HIGHEST_PRECEDENCE)
public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
return new SentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);
}
/**
* 配置SentinelGatewayFilter
* @return
*/
@Bean
@Order(-1)
public GlobalFilter sentinelGatewayFilter() {
return new SentinelGatewayFilter();
}
@PostConstruct
public void doInit() {
initGatewayRules();
}
/**
* 配置限流规则
*/
private void initGatewayRules() {
Set<GatewayFlowRule> rules = new HashSet<>();
rules.add(new GatewayFlowRule("path_route")
.setCount(1) // 限流阈值
.setIntervalSec(1) // 统计时间窗口,单位是秒,默认是 1 秒
);
GatewayRuleManager.loadRules(rules);
}
}
我们定义的资源名称是path_route,也就是application.yml中的路由ID,一致就行。
在一秒钟内多次访问http://localhost:2001/course就可以看到限流启作用了。
3.2 指定参数限流
上面的配置是针对整个路由来限流的,如果我们只想对某个路由的参数做限流,那么可以使用参数限流方式:
rules.add(new GatewayFlowRule("path_route")
.setCount(1)
.setIntervalSec(1)
.setParamItem(new GatewayParamFlowItem()
.setParseStrategy(SentinelGatewayConstants.PARAM_PARSE_STRATEGY_URL_PARAM).setFieldName("vipType")
)
);
通过指定PARAM_PARSE_STRATEGY_URL_PARAM表示从url中获取参数,setFieldName指定参数名称
3.3 自定义API分组
假设我有下面两个路由,我想让这两个路由共用一个限流规则,那么我们可以自定义进行组合:
- id: path2_route
uri: http://cxytiandi.com
predicates:
- Path=/article
- id: path3_route
uri: http://cxytiandi.com
predicates:
- Path=/blog/**
自定义分组代码:
private void initCustomizedApis() {
Set<ApiDefinition> definitions = new HashSet<>();
ApiDefinition api1 = new ApiDefinition("customized_api")
.setPredicateItems(new HashSet<ApiPredicateItem>() {
{
// article完全匹配
add(new ApiPathPredicateItem().setPattern("/article"));
// blog/开头的
add(new ApiPathPredicateItem().setPattern("/blog/**")
.setMatchStrategy(SentinelGatewayConstants.PARAM_MATCH_STRATEGY_PREFIX));
}});
definitions.add(api1);
GatewayApiDefinitionManager.loadApiDefinitions(definitions);
}
然后我们需要给customized_api这个资源进行配置:
rules.add(new GatewayFlowRule("customized_api")
.setCount(1)
.setIntervalSec(1)
);
3.4 自定义异常提示
前面我们有看到,当触发限流后页面显示的是Blocked by Sentinel: FlowException,正常情况下,就算给出提示也要跟后端服务的数据格式一样,如果你后端都是JSON格式的数据,那么异常的提示也要是JSON的格式,所以问题来了,我们怎么去自定义异常的输出?
前面我们有配置SentinelGatewayBlockExceptionHandler,我的注释写的限流后异常处理,我们可以进去看下源码就知道是不是异常处理了。下面贴出核心的代码:
private Mono<Void> writeResponse(ServerResponse response, ServerWebExchange exchange) {
return response.writeTo(exchange, contextSupplier.get());
}
@Override
public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {
if (exchange.getResponse().isCommitted()) {
return Mono.error(ex);
}
// This exception handler only handles rejection by Sentinel.
if (!BlockException.isBlockException(ex)) {
return Mono.error(ex);
}
return handleBlockedRequest(exchange, ex)
.flatMap(response -> writeResponse(response, exchange));
}
重点在于writeResponse这个方法,我们只要把这个方法改掉,返回自己想要返回的数据就行了,可以自定义一个SentinelGatewayBlockExceptionHandler的类来实现。
比如:
https://anime-pictures.net/profile/view_ext_profile/220381
https://anime-pictures.net/profile/view_ext_profile/220381?rezyj
https://anime-pictures.net/profile/view_ext_profile/220381?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220381?lang=en
https://anime-pictures.net/profile/view_ext_profile/220381?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220381?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220381?lang=es
https://anime-pictures.net/profile/view_ext_profile/220381?lang=it
https://anime-pictures.net/profile/view_ext_profile/220381?lang=de
https://anime-pictures.net/profile/view_ext_profile/220381?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220393
https://anime-pictures.net/profile/view_ext_profile/220393?uedca
https://anime-pictures.net/profile/view_ext_profile/220393?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220393?lang=en
https://anime-pictures.net/profile/view_ext_profile/220393?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220393?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220393?lang=es
https://anime-pictures.net/profile/view_ext_profile/220393?lang=it
https://anime-pictures.net/profile/view_ext_profile/220393?lang=de
https://anime-pictures.net/profile/view_ext_profile/220393?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220394
https://anime-pictures.net/profile/view_ext_profile/220394?jovfp
https://anime-pictures.net/profile/view_ext_profile/220394?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220394?lang=en
https://anime-pictures.net/profile/view_ext_profile/220394?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220394?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220394?lang=es
https://anime-pictures.net/profile/view_ext_profile/220394?lang=it
https://anime-pictures.net/profile/view_ext_profile/220394?lang=de
https://anime-pictures.net/profile/view_ext_profile/220394?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220412
https://anime-pictures.net/profile/view_ext_profile/220412?srmnn
https://anime-pictures.net/profile/view_ext_profile/220412?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220412?lang=en
https://anime-pictures.net/profile/view_ext_profile/220412?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220412?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220412?lang=es
https://anime-pictures.net/profile/view_ext_profile/220412?lang=it
https://anime-pictures.net/profile/view_ext_profile/220412?lang=de
https://anime-pictures.net/profile/view_ext_profile/220412?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220413
https://anime-pictures.net/profile/view_ext_profile/220413?qkldy
https://anime-pictures.net/profile/view_ext_profile/220413?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220413?lang=en
https://anime-pictures.net/profile/view_ext_profile/220413?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220413?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220413?lang=es
https://anime-pictures.net/profile/view_ext_profile/220413?lang=it
https://anime-pictures.net/profile/view_ext_profile/220413?lang=de
https://anime-pictures.net/profile/view_ext_profile/220413?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220418
https://anime-pictures.net/profile/view_ext_profile/220418?hkdri
https://anime-pictures.net/profile/view_ext_profile/220418?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220418?lang=en
https://anime-pictures.net/profile/view_ext_profile/220418?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220418?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220418?lang=es
https://anime-pictures.net/profile/view_ext_profile/220418?lang=it
https://anime-pictures.net/profile/view_ext_profile/220418?lang=de
https://anime-pictures.net/profile/view_ext_profile/220418?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220438
https://anime-pictures.net/profile/view_ext_profile/220438?gxmwa
https://anime-pictures.net/profile/view_ext_profile/220438?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220438?lang=en
https://anime-pictures.net/profile/view_ext_profile/220438?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220438?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220438?lang=es
https://anime-pictures.net/profile/view_ext_profile/220438?lang=it
https://anime-pictures.net/profile/view_ext_profile/220438?lang=de
https://anime-pictures.net/profile/view_ext_profile/220438?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220442
https://anime-pictures.net/profile/view_ext_profile/220442?exhdx
https://anime-pictures.net/profile/view_ext_profile/220442?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220442?lang=en
https://anime-pictures.net/profile/view_ext_profile/220442?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220442?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220442?lang=es
https://anime-pictures.net/profile/view_ext_profile/220442?lang=it
https://anime-pictures.net/profile/view_ext_profile/220442?lang=de
https://anime-pictures.net/profile/view_ext_profile/220442?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220443
https://anime-pictures.net/profile/view_ext_profile/220443?cmgug
https://anime-pictures.net/profile/view_ext_profile/220443?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220443?lang=en
https://anime-pictures.net/profile/view_ext_profile/220443?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220443?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220443?lang=es
https://anime-pictures.net/profile/view_ext_profile/220443?lang=it
https://anime-pictures.net/profile/view_ext_profile/220443?lang=de
https://anime-pictures.net/profile/view_ext_profile/220443?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220454
https://anime-pictures.net/profile/view_ext_profile/220454?vores
https://anime-pictures.net/profile/view_ext_profile/220454?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220454?lang=en
https://anime-pictures.net/profile/view_ext_profile/220454?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220454?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220454?lang=es
https://anime-pictures.net/profile/view_ext_profile/220454?lang=it
https://anime-pictures.net/profile/view_ext_profile/220454?lang=de
https://anime-pictures.net/profile/view_ext_profile/220454?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220452
https://anime-pictures.net/profile/view_ext_profile/220452?rjggf
https://anime-pictures.net/profile/view_ext_profile/220452?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220452?lang=en
https://anime-pictures.net/profile/view_ext_profile/220452?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220452?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220452?lang=es
https://anime-pictures.net/profile/view_ext_profile/220452?lang=it
https://anime-pictures.net/profile/view_ext_profile/220452?lang=de
https://anime-pictures.net/profile/view_ext_profile/220452?lang=fr
https://anime-pictures.net/profile/view_ext_profile/219972
https://anime-pictures.net/profile/view_ext_profile/219972?aiaqq
https://anime-pictures.net/profile/view_ext_profile/219972?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/219972?lang=en
https://anime-pictures.net/profile/view_ext_profile/219972?lang=ru
https://anime-pictures.net/profile/view_ext_profile/219972?lang=jp
https://anime-pictures.net/profile/view_ext_profile/219972?lang=es
https://anime-pictures.net/profile/view_ext_profile/219972?lang=it
https://anime-pictures.net/profile/view_ext_profile/219972?lang=de
https://anime-pictures.net/profile/view_ext_profile/219972?lang=fr
https://anime-pictures.net/profile/view_ext_profile/219974
https://anime-pictures.net/profile/view_ext_profile/219974?nsjhw
https://anime-pictures.net/profile/view_ext_profile/219974?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/219974?lang=en
https://anime-pictures.net/profile/view_ext_profile/219974?lang=ru
https://anime-pictures.net/profile/view_ext_profile/219974?lang=jp
https://anime-pictures.net/profile/view_ext_profile/219974?lang=es
https://anime-pictures.net/profile/view_ext_profile/219974?lang=it
https://anime-pictures.net/profile/view_ext_profile/219974?lang=de
https://anime-pictures.net/profile/view_ext_profile/219974?lang=fr
https://anime-pictures.net/profile/view_ext_profile/219975
https://anime-pictures.net/profile/view_ext_profile/219975?ihtuf
https://anime-pictures.net/profile/view_ext_profile/219975?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/219975?lang=en
https://anime-pictures.net/profile/view_ext_profile/219975?lang=ru
https://anime-pictures.net/profile/view_ext_profile/219975?lang=jp
https://anime-pictures.net/profile/view_ext_profile/219975?lang=es
https://anime-pictures.net/profile/view_ext_profile/219975?lang=it
https://anime-pictures.net/profile/view_ext_profile/219975?lang=de
https://anime-pictures.net/profile/view_ext_profile/219975?lang=fr
https://anime-pictures.net/profile/view_ext_profile/219985
https://anime-pictures.net/profile/view_ext_profile/219985?gqies
https://anime-pictures.net/profile/view_ext_profile/219985?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/219985?lang=en
https://anime-pictures.net/profile/view_ext_profile/219985?lang=ru
https://anime-pictures.net/profile/view_ext_profile/219985?lang=jp
https://anime-pictures.net/profile/view_ext_profile/219985?lang=es
https://anime-pictures.net/profile/view_ext_profile/219985?lang=it
https://anime-pictures.net/profile/view_ext_profile/219985?lang=de
https://anime-pictures.net/profile/view_ext_profile/219985?lang=fr
https://anime-pictures.net/profile/view_ext_profile/219980
https://anime-pictures.net/profile/view_ext_profile/219980?uaeae
https://anime-pictures.net/profile/view_ext_profile/219980?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/219980?lang=en
https://anime-pictures.net/profile/view_ext_profile/219980?lang=ru
https://anime-pictures.net/profile/view_ext_profile/219980?lang=jp
https://anime-pictures.net/profile/view_ext_profile/219980?lang=es
https://anime-pictures.net/profile/view_ext_profile/219980?lang=it
https://anime-pictures.net/profile/view_ext_profile/219980?lang=de
https://anime-pictures.net/profile/view_ext_profile/219980?lang=fr
https://anime-pictures.net/profile/view_ext_profile/219996
https://anime-pictures.net/profile/view_ext_profile/219996?hhjjz
https://anime-pictures.net/profile/view_ext_profile/219996?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/219996?lang=en
https://anime-pictures.net/profile/view_ext_profile/219996?lang=ru
https://anime-pictures.net/profile/view_ext_profile/219996?lang=jp
https://anime-pictures.net/profile/view_ext_profile/219996?lang=es
https://anime-pictures.net/profile/view_ext_profile/219996?lang=it
https://anime-pictures.net/profile/view_ext_profile/219996?lang=de
https://anime-pictures.net/profile/view_ext_profile/219996?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220001
https://anime-pictures.net/profile/view_ext_profile/220001?nvfld
https://anime-pictures.net/profile/view_ext_profile/220001?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220001?lang=en
https://anime-pictures.net/profile/view_ext_profile/220001?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220001?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220001?lang=es
https://anime-pictures.net/profile/view_ext_profile/220001?lang=it
https://anime-pictures.net/profile/view_ext_profile/220001?lang=de
https://anime-pictures.net/profile/view_ext_profile/220001?lang=fr
https://anime-pictures.net/profile/view_ext_profile/220012
https://anime-pictures.net/profile/view_ext_profile/220012?qcuyg
https://anime-pictures.net/profile/view_ext_profile/220012?lang=zh_CN
https://anime-pictures.net/profile/view_ext_profile/220012?lang=en
https://anime-pictures.net/profile/view_ext_profile/220012?lang=ru
https://anime-pictures.net/profile/view_ext_profile/220012?lang=jp
https://anime-pictures.net/profile/view_ext_profile/220012?lang=es
https://anime-pictures.net/profile/view_ext_profile/220012?lang=it
https://anime-pictures.net/profile/view_ext_profile/220012?lang=de
https:/&#