AspNetCoreRateLimit 项目教程

项目介绍

AspNetCoreRateLimit 是一个 ASP.NET Core 速率限制解决方案，旨在基于 IP 地址或客户端 ID 控制客户端对 Web API 或 MVC 应用程序发出请求的速率。该解决方案包含一个 IpRateLimitMiddleware 和一个 ClientRateLimitMiddleware，每个中间件都可以为不同的场景设置多个限制，例如允许 IP 或客户端在时间间隔内进行最大数量的调用，如每秒、15 分钟等。您可以定义这些限制以处理对 API 发出的所有请求，也可以将限制范围限定为每个 API URL 或 HTTP 动词和路径。

项目快速启动

安装 AspNetCoreRateLimit 包

首先，通过 NuGet 安装 AspNetCoreRateLimit 包：

dotnet add package AspNetCoreRateLimit

配置中间件

在 Startup.cs 文件中配置中间件：

public void ConfigureServices(IServiceCollection services)
{
    services.AddOptions();
    services.AddMemoryCache();
    services.Configure<IpRateLimitOptions>(Configuration.GetSection("IpRateLimiting"));
    services.Configure<IpRateLimitPolicies>(Configuration.GetSection("IpRateLimitPolicies"));
    services.AddInMemoryRateLimiting();
    services.AddSingleton<IRateLimitConfiguration, RateLimitConfiguration>();
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseIpRateLimiting();
    app.UseRouting();
    app.UseAuthorization();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

配置 appsettings.json

在 appsettings.json 中添加速率限制配置：

{
  "IpRateLimiting": {
    "EnableEndpointRateLimiting": true,
    "StackBlockedRequests": false,
    "RealIpHeader": "X-Real-IP",
    "ClientIdHeader": "X-ClientId",
    "HttpStatusCode": 429,
    "GeneralRules": [
      {
        "Endpoint": "*:/api/*",
        "Period": "1s",
        "Limit": 2
      }
    ]
  }
}

应用案例和最佳实践

应用案例

AspNetCoreRateLimit 可以应用于各种需要限制请求速率的场景，例如：

• 登录接口：防止频繁尝试登录。
• 注册接口：防止异常注册行为。
• API 接口：防止 API 被过度调用。

最佳实践

• 配置灵活性：根据不同的接口和业务需求，灵活配置速率限制规则。
• 监控和日志：记录被限制的请求，便于后续分析和优化。
• 缓存策略：根据实际需求选择合适的缓存策略，如内存缓存、分布式缓存等。

典型生态项目

AspNetCoreRateLimit 可以与其他 ASP.NET Core 生态项目结合使用，例如：

• IdentityServer：用于身份验证和授权，结合速率限制可以更好地保护 API。
• HealthChecks：用于监控应用程序的健康状态，结合速率限制可以防止健康检查接口被过度调用。
• Serilog：用于日志记录，结合速率限制可以更好地记录和分析被限制的请求。

通过以上步骤，您可以快速启动并使用 AspNetCoreRateLimit 项目，实现对 ASP.NET Core 应用程序的请求速率限制。