Rabbit.Common.RateLimit 1.1.0

Rabbit.Common.RateLimit

限流组件，支持令牌桶和滑动窗口算法。

安装

dotnet add package Rabbit.Common.RateLimit

依赖

• Rabbit.Common.Lite
• Rabbit.Common.Redis（可选，用于分布式限流）
• FreeRedis（可选，用于 Redis 存储）

功能

• 令牌桶算法: 平滑限流，支持突发流量
• 滑动窗口算法: 精确计数
• Redis 存储: 分布式限流支持

快速开始

1. 配置限流

using Rabbit.Common.RateLimit;

// 内存存储（单机）
services.AddRateLimitConfigure();

// Redis 存储（单实例，使用默认 IRedisClient）
services.AddRateLimitConfigure(RateLimitStorageType.Redis);

// Redis 存储（多实例，指定 Key）
services.AddFreeRedisMapConfigure("RateLimitRedis", "127.0.0.1:6379");
services.AddRateLimitConfigure(RateLimitStorageType.Redis, "RateLimitRedis");

2. 使用中间件

app.Use(async (context, next) =>
{
    var store = context.RequestServices.GetRequiredService<IRateLimitStore>();

    // 按 IP 限流
    var key = context.Connection.RemoteIpAddress?.ToString() ?? "unknown";

    var options = new RateLimitOptions
    {
        Capacity = 100,           // 最大请求数
        RefillPerSecond = 10,     // 每秒填充速率
        Window = TimeSpan.FromSeconds(1),
        Prefix = "rl:api:"
    };

    if (!await store.IsAllowedAsync(key, options, AlgorithmEnum.TokenBucket))
    {
        context.Response.StatusCode = 429; // Too Many Requests
        await context.Response.WriteAsync("请求过于频繁，请稍后重试");
        return;
    }

    await next();
});

3. 不同场景限流

// API 限流 - 令牌桶（允许突发）
var apiOptions = new RateLimitOptions
{
    Capacity = 100,
    RefillPerSecond = 10,
    Prefix = "rl:api:"
};

// 登录限流 - 滑动窗口（严格计数）
var loginOptions = new RateLimitOptions
{
    Capacity = 5,              // 5次
    Window = TimeSpan.FromMinutes(1), // 每分钟
    Prefix = "rl:login:"
};

if (!await store.IsAllowedAsync(userId, loginOptions, AlgorithmEnum.SlidingWindow))
{
    return "登录次数过多，请稍后再试";
}

配置选项

public class RateLimitOptions
{
    /// <summary>
    /// 令牌桶容量 / 窗口最大请求数
    /// </summary>
    public int Capacity { get; set; }

    /// <summary>
    /// 每秒填充速率（仅令牌桶用）
    /// </summary>
    public int RefillPerSecond { get; set; }

    /// <summary>
    /// 时间窗口
    /// </summary>
    public TimeSpan Window { get; set; } = TimeSpan.FromSeconds(1);

    /// <summary>
    /// 键前缀
    /// </summary>
    public string Prefix { get; set; } = "rl:";
}

算法对比

许可证

MIT