基于 ActionFilters 的限流库DotNetRateLimiter使用

木宥于林

前言

在构建API项目时，有时出于安全考虑，防止访问用户恶意攻击，希望限制此用户ip地址的请求次数，减轻拒绝服务攻击可能性，也称作限流。接下来，我们就来学习开源库DotNetRateLimiter 如何轻松实现限流。
项目使用配置

安装Nuget包

在新建立的WebAPI项目中，通过Nuget包管理器安装DotNetRateLimiter，安装命令：

NuGet\Install-Package DotNetRateLimiter -Version 1.0.7

项目服务注入

1. using DotNet.RateLimiter;
3. var builder = WebApplication.CreateBuilder(args);
4. //DotNetRateLimiter配置
5. builder.Services.AddRateLimitService(builder.Configuration);

复制代码

DotNetRateLimiter 配置：

appsetting.json 文件中，添加JSON对象节点进行配置，如下：

1. "RateLimitOption": {
2.     "EnableRateLimit": true, //是否开启
3.     "HttpStatusCode": 429,//http响应码
4.     "ErrorMessage": "请求次数过多", //响应信息
5.     "IpHeaderName": "X-Forwarded-For",//客户端IP请求头
6.     //"RedisConnection": "127.0.0.1:6379",  默认使用内存缓存，并且支持配置 Redis 连接， 这样可以对分布式应用进行限流。
7.     "IpWhiteList": ["::1"], //设置白名单集合
8.     "ClientIdentifier": "X-Client-Id"   
9.   }

复制代码

到此配置已经完成，非常简单，接下就是在项目中如何进行使用。
项目中使用

控制器Controller上使用

这个控制器20秒内只允许 3 个请求， 如果调用 api 超过 3 次，就会收到http错误请求代码： 429，错误信息：请求次数过多

1.     [Route("api/[controller]")]
2.     [ApiController]
3.     [RateLimit(PeriodInSec = 20, Limit = 3, Scope = RateLimitScope.Controller)]//控制器上使用
4.     public class RateLimiterController : ControllerBase
5.     {
6.         
7.     }

复制代码

接口Action上使用

这个接口20秒内只允许 3 个请求， 如果调用 api 超过 3 次，就会收到http错误请求代码： 429，错误信息：请求次数过多

1. /// <summary>
2.         ///  添加RateLimit接口特性
3.         /// </summary>
4.         /// <returns></returns>
5.         [HttpGet]
6.         [Route("GetNow")]
7.         [RateLimit(PeriodInSec = 20, Limit = 3)]
8.         public ActionResult GetNow()
9.         {
10.             return Ok(
11.                 new
12.                 {
13.                     Msg = "当前时间",
14.                     Value = DateTime.Now.ToString("yyyy/MM/dd HH:mm:ss")
15.                 }
16.                 );
17.         }
19.         /// <summary>
20.         /// 不添加RateLimit特性接口
21.         /// </summary>
22.         /// <returns></returns>
23.         [HttpGet]
24.         [Route("GetYesteyDayNow")]
25.         public ActionResult GetYesteyDayNow()
26.         {
27.             return Ok(
28.                new
29.                {
30.                    Msg = "昨天时间",
31.                    Value = DateTime.Now.AddDays(-1).ToString("yyyy/MM/dd HH:mm:ss")
32.         }
33.                );
34.         }
36.         /// <summary>
37.         /// RateLimit特性结合路由参数接口
38.         /// </summary>
39.         /// <param name="day"></param>
40.         /// <returns></returns>
41.         [HttpGet]
42.         [Route("GetBeforeTimeByDay/{day}")]
43.         [RateLimit(PeriodInSec = 20, Limit = 3, RouteParams = "day")]//搭配路由进行使用
44.         public ActionResult ActionResult(int day)
45.         {
46.             return Ok(
47.              new
48.              {
49.                  Msg = $"{day}天前时间",
50.                  Value = DateTime.Now.AddDays(-day).ToString("yyyy/MM/dd HH:mm:ss")
51.         }
52.              );
53.         }

复制代码

测试验证

打开Swagger，调用接口测试：

源码获取

关注公众号，后台回复关键字：RateLimiter

来源:https://www.cnblogs.com/wml-it/archive/2023/09/18/17709144.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！