.NET API 高性能的限流利器

2024-06-25码农

前言

FireflySoft.RateLimit是基于.NET Core和.NET Standard构建，支持多种速率限制算法和策略，包括固定窗口、滑动窗口、漏桶、令牌桶等。通过简单的配置和集成，开发者可以快速地将其应用到现有的Web API、微服务或中间件中，实现对请求的精确控制。

同时，该库还支持分布式系统中的速率限制，通过Redis等分布式缓存系统实现数据的共享和同步，确保在不同节点之间实现一致的速率限制效果。

除了强大的功能外，FireflySoft.RateLimit还注重易用性和性能优化。提供了简洁明了的API和丰富的示例代码，使得开发者能够快速地掌握其使用方法。同时，我们还对算法进行了优化，减少了不必要的计算开销，以确保在高并发场景下仍然能够保持高效的性能表现。

总之，FireflySoft.RateLimit 是一个不错的限流类库，其内核简单轻巧，能够灵活应对各种需求的限流场景。希望通过它能够帮助更多的开发者保护系统和API免受恶意请求和过载请求的侵害，同时也期待与大家一起探索更多可能性和创新点。

功能

多种限流算法：内置固定窗口、滑动窗口、漏桶、令牌桶四种算法，还可自定义扩展。

多种计数存储：目前支持内存、Redis（含集群）两种存储方式。

分布式友好：通过Redis存储支持分布式程序统一计数。

限流目标灵活：可以从请求中提取各种数据用于设置限流目标。

支持限流惩罚：可以在客户端触发限流后锁定一段时间不允许其访问。

时间窗口增强：支持到毫秒级别；支持从秒、分钟、小时、日期等时间周期的起始点开始。

实时限流跟踪：当前计数周期内已处理的请求数、剩余允许请求数，以及计数周期重置的时间。

动态更改规则：支持程序运行时动态更改限流规则。

自定义错误：可以自定义触发限流后的错误码和错误消息。

普适性：原则上可以满足任何需要限流的场景。

使用说明

publicvoidConfigureServices(IServiceCollection services) { ... services.AddRateLimit(new InProcessFixedWindowAlgorithm( new[] { new FixedWindowRule() { ExtractTarget = context => { // 提取限流目标 // 这里是直接从请求中提取Path作为限流目标，还可以多种组合，甚至去远程查询一些数据 return (context as HttpContext).Request.Path.Value; }, CheckRuleMatching = context => { // 检查当前请求是否要做限流 // 比如有些Url是不做限流的、有些用户是不做限流的 returntrue; }, Name="default limit rule", LimitNumber=30, // 限流时间窗口内的最大允许请求数量 StatWindow=TimeSpan.FromSeconds(1) // 限流计数的时间窗口 } }) ); ... } publicvoidConfigure(IApplicationBuilder app, IWebHostEnvironment env) { ... app.UseRateLimit(); ... }

ASP.NET 应用

1、安装 Nuget 包，使用包管理器控制台：

Install-Package FireflySoft.RateLimit.AspNet

其它类型应用

1、安装 Nuget 包，使用包管理器控制台

Install-Package FireflySoft.RateLimit.Core

或者 .NET CLI

dotnet add package FireflySoft.RateLimit.Core

2、使用限流算法，使用 IAlgorithm 过滤每个请求, 处理 Check 方法的返回值。

// 定义限流规则 var fixedWindowRules = new FixedWindowRule[] { new FixedWindowRule() { Id = "3", StatWindow=TimeSpan.FromSeconds(1), LimitNumber=30, ExtractTarget = (request) => { return (request as SimulationRequest).RequestResource; }, CheckRuleMatching = (request) => { returntrue; }, } }; // 使用限流算法 IAlgorithm algorithm = new InProcessFixedWindowAlgorithm(fixedWindowRules); // 过滤请求 var result = algorithm.Check(new SimulationRequest() { RequestId = Guid.NewGuid().ToString(), RequestResource = "home", Parameters = new Dictionary<string, string>() { { "from","sample" }, } });