.Netcore 2.0 Ocelot Api网关教程（7）-
2019-03-15 本文已影响12人
Weidaicheng
本文介绍Ocelot中的限流，限流允许Api网关控制一段时间内特定api的总访问次数。
限流的使用非常简单，只需要添加配置即可。
1、添加限流
修改 configuration.json 配置文件，对 UpstreamPathTemplate 为 /webapib/values 的配置修改如下：
{
// ...
"UpstreamPathTemplate": "/webapib/values",
"UpstreamHttpMethod": [ "Get" ],
"RateLimitOptions": {
"ClientWhiteList": [
"myclient"
],
"EnableRateLimiting": true,
"Period": "1m",
"PeriodTimespan": 30,
"Limit": 2
}
}
对 RateLimitOptions 中几个配置项做下解释：
- ClientWhiteList：一个字符串数组，在请求头中包含ClientId=xxx的请求不受限流控制，其中ClientId这个key可以修改，后边会介绍，xxx表示配置的白名单。
- EnableRateLimiting：Boolean值，是否启用限流，只有为true时，配置生效。
- Period：限流控制的时间段，可以输入 1s（1秒），1m（1分），1h（1小时），1d（1天）类似的值，以此类推。
- PeriodTimespan：超过限流限制的次数后，需要等待重置的时间（单位是秒）。
- Limit：在Period时间内最大能访问的数量。
用一句话描述一下上边的配置：对于除了请求头中包含ClientId=myclient的请求启用限流，1分钟之内该api最多被访问2次，如果已经达到2次，从第2次请求结束起30秒后才能进行下一次访问。
分别运行WebApiB和OcelotGetWay，使用Postman以get方式请求链接http://localhost:5000/webapib/values，如下所示：
first.png
third.png
再看一下未达到限制的response header和达到限制的response header：
first header.png
可以看到在未达到限制时的header会返回前面配置的Perid和剩余请求次数。
third header.png
在达到限制时的header会返回剩余多长时间（秒）重置。
再次用Postman以get的方式请求http://localhost:5000/webapib/values，不过此次要添加header：
multi requests.png
多次请求后同样可以请求到数据，并没有受到限流配置影响。
2、全局配置
同时在全局配置中可以添加一些关于限流的配置来控制是否在response header中返回限流相关的信息，以及限流的返回信息和状态码还有ClientIdHeader。
修改 GlobalConfiguration 如下：
"GlobalConfiguration": {
"ServiceDiscoveryProvider": {
"Host": "localhost",
"Port": 8500
},
"RateLimitOptions": {
"DisableRateLimitHeaders": true,
"QuotaExceededMessage": "Stop request plz!",
"HttpStatusCode": 999,
"ClientIdHeader": "cid"
}
}
重新运行Ocelot Api网关，请求链接如下：
Do not display rate limit headers.png
返回信息中不再包含限流相关信息。
当达到限流时，返回的信息以及状态码也会根据配置发生变化：
status.png
细心的同学可能已经发现，在上边的两次请求中都添加了header ClientId=myclient，但是还是受到了限流控制，这是因为我们在上边的全局配置中已经将ClientId修改为cid，修改header信息重新访问，就不会再受到限流控制：
cid.png
源码下载
