Spring Cloud Gateway 整合阿里 Sentinel网关限流实战!
扫描二维码
随时随地手机看文章
前一篇文章介绍了Spring Cloud Gateway的一些基础知识点,今天陈某就来唠一唠网关层面如何做限流?文章目录如下:
网关如何限流?
Spring Cloud Gateway本身自带的限流实现,过滤器是RequestRateLimiterGatewayFilterFactory
,不过这种上不了台面的就不再介绍了,有兴趣的可以实现下。从1.6.0版本开始,Sentinel提供了SpringCloud Gateway的适配模块,可以提供两种资源维度的限流:- route维度:即在配置文件中配置的路由条目,资源名为对应的
routeId
,这种属于粗粒度的限流,一般是对某个微服务进行限流。 - 自定义API维度:用户可以利用Sentinel提供的API来自定义一些API分组,这种属于细粒度的限流,针对某一类的uri进行匹配限流,可以跨多个微服务。
“sentinel官方文档:https://github.com/alibaba/Sentinel/wiki/网关限流”Spring Cloud Gateway集成Sentinel实现很简单,这就是阿里的魅力,提供简单、易操作的工具,让程序员专注于业务。
新建项目
新建一个gateway-sentinel9026
模块,添加如下依赖:
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
dependency>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-gatewayartifactId>
dependency>
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>spring-cloud-alibaba-sentinel-gatewayartifactId>
dependency>
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>spring-cloud-starter-alibaba-sentinelartifactId>
dependency>
“注意:这依然是一个网关服务,不要添加WEB的依赖”
配置文件
配置文件中主要指定以下三种配置:- nacos的地址
- sentinel控制台的地址
- 网关路由的配置
spring:
cloud:
## 整合sentinel,配置sentinel控制台的地址
sentinel:
transport:
## 指定控制台的地址,默认端口8080
dashboard: localhost:8080
nacos:
## 注册中心配置
discovery:
# nacos的服务地址,nacos-server中IP地址:端口号
server-addr: 127.0.0.1:8848
gateway:
## 路由
routes:
## id只要唯一即可,名称任意
- id: gateway-provider
uri: lb://gateway-provider
## 配置断言
predicates:
## Path Route Predicate Factory断言,满足/gateway/provider/**这个请求路径的都会被路由到http://localhost:9024这个uri中
- Path=/gateway/provider/**
上述配置中设置了一个路由gateway-provider
,只要请求路径满足/gateway/provider/**
都会被路由到gateway-provider
这个服务中。限流配置
经过上述两个步骤其实已经整合好了Sentinel,此时访问一下接口:http://localhost:9026/gateway/provider/port然后在sentinel控制台可以看到已经被监控了,监控的路由是gateway-provider
,如下图:此时我们可以为其新增一个route维度的限流,如下图:上图中对gateway-provider
这个路由做出了限流,QPS阈值为1。此时快速访问:http://localhost:9026/gateway/provider/port,看到已经被限流了,如下图:以上route维度的限流已经配置成功,小伙伴可以自己照着上述步骤尝试一下。API分组限流也很简单,首先需要定义一个分组,API管理-> 新增API分组,如下图:匹配模式选择了精确匹配(还有前缀匹配,正则匹配),因此只有这个uri:http://xxxx/gateway/provider/port
会被限流。第二步需要对这个分组添加流控规则,流控规则->新增网关流控,如下图:API名称那里选择对应的分组即可,新增之后,限流规则就生效了。陈某不再测试了,小伙伴自己动手测试一下吧...............“陈某这里只是简单的配置一下,至于限流规则持久化一些内容请看陈某的Sentinel文章,这里就不再过多的介绍了。”
如何自定义限流异常信息?
从上面的演示中可以看到默认的异常返回信息是:"Block.........",这种肯定是客户端不能接受的,因此需要定制自己的异常返回信息。下面介绍两种不同的方式定制异常返回信息,开发中自己选择其中一种。直接配置文件中定制
开发者可以直接在配置文件中直接修改返回信息,配置如下:spring:
cloud:
## 整合sentinel,配置sentinel控制台的地址
sentinel:
#配置限流之后,响应内容
scg:
fallback:
## 两种模式,一种是response返回文字提示信息,
## 一种是redirect,重定向跳转,需要同时配置redirect(跳转的uri)
mode: response
## 响应的状态
response-status: 200
## 响应体
response-body: '{"code": 200,"message": "请求失败,稍后重试!"}'
上述配置中mode
配置的是response
,一旦被限流了,将会返回JSON
串。{
"code": 200,
"message": "请求失败,稍后重试!"
}
重定向的配置如下:spring:
cloud:
## 整合sentinel,配置sentinel控制台的地址
sentinel:
#配置限流之后,响应内容
scg:
fallback:
## 两种模式,一种是response返回文字提示信息,一种是redirect,重定向跳转,需要同时配置redirect(跳转的uri)
mode: redirect
## 跳转的URL
redirect: http://www.baidu.com
一旦被限流,将会直接跳转到:http://www.baidu.com编码定制
这种就不太灵活了,通过硬编码的方式,完整代码如下:@Configuration
public class GatewayConfig {
/**
* 自定义限流处理器
*/
@PostConstruct
public void initBlockHandlers() {
BlockRequestHandler blockHandler = (serverWebExchange, throwable) -> {
Map map = new HashMap();
map.put("code",200);
map.put("message","请求失败,稍后重试!");
return ServerResponse.status(HttpStatus.OK)
.contentType(MediaType.APPLICATION_JSON_UTF8)
.body(BodyInserters.fromObject(map));
};
GatewayCallbackManager.setBlockHandler(blockHandler);
}
}
两种方式介绍完了,根据业务需求自己选择适合的方式,当然陈某更喜欢第一种,理由:约定>配置>编码。