Rabbit.Common.RateLimit 1.3.1

Rabbit.Common.RateLimit

Rate limiting component supporting token bucket and sliding window algorithms. Memory storage for single-instance or Redis for distributed rate limiting.

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

安装

dotnet add package Rabbit.Common.RateLimit

依赖

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

功能

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

使用方式

Console 项目

using Microsoft.Extensions.DependencyInjection;
using Rabbit.Common.RateLimit;

// 1. 创建 DI 容器
var services = new ServiceCollection();

// 2. 注册限流服务
// 内存存储（单机）
services.AddRateLimitConfigure();

// Redis 存储（需先注册 Redis）
// services.AddFreeRedisConfigure("127.0.0.1:6379");
// services.AddRateLimitConfigure(RateLimitStorageType.Redis);

// 3. 构建服务提供者
var provider = services.BuildServiceProvider();

// 4. 使用限流
var rateLimitStore = provider.GetRequiredService<IRateLimitStore>();

var options = new RateLimitOptions {
    Capacity = 100,
    RefillPerSecond = 10
};

bool allowed = await rateLimitStore.IsAllowedAsync(
    "user:123",
    options,
    AlgorithmEnum.TokenBucket
);

Web API 项目

using Rabbit.Common.RateLimit;

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

// Redis 存储（单实例）
services.AddRateLimitConfigure(RateLimitStorageType.Redis);

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

使用静态方法

如果需要使用 RateLimitHelper 静态方法，在应用启动后初始化：

var app = builder.Build();

// 初始化静态 Helper
RateLimitHelper.Initialize(app.Services);

app.Run();

// 方式一：完整参数
var allowed = await RateLimitHelper.IsAllowedAsync(
    key: userId,
    options: new RateLimitOptions { Capacity = 100, RefillPerSecond = 10 },
    algorithm: AlgorithmEnum.TokenBucket
);

// 方式二：令牌桶快捷方法
var allowed = await RateLimitHelper.IsAllowedAsync(userId, capacity: 100, refillPerSecond: 10);

// 方式三：滑动窗口快捷方法
var allowed = await RateLimitHelper.IsAllowedWindowAsync(userId, capacity: 5, window: TimeSpan.FromMinutes(1));

使用中间件

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;
        await context.Response.WriteAsync("请求过于频繁，请稍后重试");
        return;
    }

    await next();
});

不同场景限流

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

// 登录限流 - 滑动窗口（严格计数）
var loginOptions = new RateLimitOptions
{
    Capacity = 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