ASP.NET Core对不同类型的用户进行区别限流详解

前言

老板提出了一个新需求，从某某天起，免费用户每天只能查询100次，收费用户100W次。

这是一个限流问题，聪明的你也一定想到了如何去做：记录用户每一天的查询次数，然后根据当前用户的类型使用不同的数字做比较，超过指定的数字就返回错误。

嗯，原理就是这么简单。不过真正写起来还要考虑更多问题：

• 统计数据的数据结构是什么样的？字典 or 行记录？
• 统计数据记录到哪里？内存 or MySQL or Redis？
• 分布式应用怎么精确计数？分布式锁 or 队列 or 事务？
• 吞吐量比较大时如何扛得住？内存 or Redis or 数据库集群？
• 这些数据要一直保留吗？自动过期 or 定期清理？
• 如何返回错误？自定义错误 or HTTP标准错误码？
  

自己去做这些事还是有点麻烦的，这里介绍一个ASP.NET Core的中间件来满足这个限流需求：FireflySoft.RateLimit.AspNetCore。使用步骤如下：

1、安装Nuget包

已经发布到nuget.org，有多种安装方式，选择自己喜欢的就行了。

包管理器命令：

Install-Package FireflySoft.RateLimit.AspNetCore

或者.NET命令:

dotnet add package FireflySoft.RateLimit.AspNetCore

或者项目文件直接添加：

<ItemGroup>
<PackageReference Include="FireflySoft.RateLimit.AspNetCore" Version="1.2.0" />
</ItemGroup>

2、使用中间件

在Startup.Configure中使用中间件，演示代码如下（下边会有详细说明）：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
 ...

 app.UseRateLimit(new RateLimitProcessor<HttpContext>.Builder()
  .WithAlgorithm(new FixedWindowAlgorithm<HttpContext>( new[] {
   new FixedWindowRateLimitRule<HttpContext>()
   {
    Id = "1",
    ExtractTarget = context =>
    {
     // 这里假设用户Id是从cookie中传过来的，需根据实际情况获取
     return context.Request.GetTypedHeaders().Get<string>("userId");
    },
    CheckRuleMatching = context =>
    {
     // 这里假设用户类型是从cookie中传过来的，实际可能需要根据用户Id再去查询
     // 0免费用户 1收费用户
     int userType = context.Request.GetTypedHeaders().Get<int>("userType");
     if(userType==0){
      return true;
     }
     return false;
    },
    Name="免费用户限流规则",
    LimitNumber=100,
    StatWindow=TimeSpan.FromDays(1)
   },
   new FixedWindowRateLimitRule<HttpContext>()
   {
    Id = "2",
    ExtractTarget = context =>
    {
     // 这里假设用户Id是从cookie中传过来的，需根据实际情况获取
     return context.Request.GetTypedHeaders().Get<string>("userId");
    },
    CheckRuleMatching = context =>
    {
     // 这里假设用户类型是从cookie中传过来的，实际可能需要根据用户Id再去查询
     // 0免费用户 1收费用户
     int userType = context.Request.GetTypedHeaders().Get<int>("userType");
     if(userType==1){
      return true;
     }
     return false;
    },
    Name="收费用户限流规则",
    LimitNumber=1000000,
    StatWindow=TimeSpan.FromDays(1)
   }
  }))
  .WithError(new Core.RateLimitError()
  {
   Code=429,
   Message = "查询数达到当天最大限制"
  })
  //.WithStorage(new RedisStorage(StackExchange.Redis.ConnectionMultiplexer.Connect("localhost")))
  .Build());

 ...
}

使用此中间件需要构建一个名为RateLimitProcessor的限流处理器实例，指定限流处理的请求类型HttpContext，设置限流处理的三个方面：

限流使用的算法以及对应的规则

限流算法，根据这个需求使用固定窗口算法就可以了，也称为计数器算法。此中间件还提供了滑动窗口算法、漏桶算法、令牌桶算法，可以根据需要选择。

不同的限流算法有不同的限流规则类型，在这里使用的是固定窗口限流规则，针对免费用户和收费用户分别定义了两个规则，注意其中的几个参数：

• Id：在当前的版本中Id必须手动指定，并且不能重复。
• ExtractTarget：传递一个方法用于从请求中提取限流目标，这里就是用户Id。
• CheckRuleMatching传递一个方法用于检查当前请求是否适用当前规则，这里根据用户类型进行判断。
• StatWindow是固定窗口的大小，是一个时间跨度，这里是1天。
• LimitNumber是限流值，在StatWindow时间内请求数超过它就会触发限流。
  

这里有两个比较有意思的设置：ExtractTarget和CheckRuleMatching，他们共同作用，让用户可以完全自由的定制自己限流的目标和条件，无论是IP、ClientId或者Url。

限流统计数据的持久化方式

FireflySoft.RateLimit中的限流计数目前支持保存在内存或者Redis中，也可以通过实现IRateLimitStorage来定义一个新的存储器，不设置时默认为内存存储。

对于只需要部署一份的程序，绝大部分情况下使用内存就够了；但是如果限流的时间窗口比较长，比如1小时限制300次，重启就会丢失计数，这可能是个风险，此时使用Redis会比较合适。对于分布式应用，也建议使用Redis存储。

限流统计数据会根据限流时间窗口自动过期移除。

被限流时的错误码和消息

默认限流错误Code是429，这个会作为HttpStatusCode返回；Message默认为null，你可以修改为自己的任意文字提示，这个会作为Http Body的内容返回。

以上就是使用FireflySoft.RateLimit.AspNetCore对不同类型的用户进行区别限流的使用方法。

如果觉得还是限制的有点死，比如返回错误信息部分，想返回一个json格式的错误消息，还可以使用FireflySoft.RateLimit.Core这个包来封装自己的ASP.NET Core中间件。

如果想在这个程序的基础上再改造下，可以fork这个项目：https://github.com/bosima/FireflySoft.RateLimit

总结

到此这篇关于ASP.NET Core对不同类型的用户进行区别限流的文章就介绍到这了,更多相关ASP.NET Core用户区别限流内容请搜索靠谱客以前的文章或继续浏览下面的相关文章希望大家以后多多支持靠谱客！

最后

以上就是优雅乌冬面为你收集整理的ASP.NET Core对不同类型的用户进行区别限流详解的全部内容，希望文章能够帮你解决ASP.NET Core对不同类型的用户进行区别限流详解所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。