ASP.NET?Core使用固定窗口限流

更新時(shí)間：2021年12月09日 09:00:24 作者：波斯馬

本文詳細(xì)講解了ASP.NET?Core使用固定窗口限流的算法實(shí)現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

算法原理

固定窗口算法又稱計(jì)數(shù)器算法，是一種簡單的限流算法。在單位時(shí)間內(nèi)設(shè)定一個(gè)閾值和一個(gè)計(jì)數(shù)值，每收到一個(gè)請(qǐng)求則計(jì)數(shù)值加一，如果計(jì)數(shù)值超過閾值則觸發(fā)限流，如果達(dá)不到則請(qǐng)求正常處理，進(jìn)入下一個(gè)單位時(shí)間后，計(jì)數(shù)值清零，重新累計(jì)。

如上圖所示，時(shí)間單位是1秒，閾值是3。

第1秒3個(gè)請(qǐng)求，不會(huì)觸發(fā)限流；
第2秒1個(gè)請(qǐng)求，不會(huì)觸發(fā)限流；
第3秒4個(gè)請(qǐng)求，這一秒的前3個(gè)請(qǐng)求正常處理，第4個(gè)請(qǐng)求觸發(fā)限流，會(huì)被拒絕處理。
后續(xù)第4秒、第5秒不會(huì)觸發(fā)限流，所有請(qǐng)求正常處理。

算法實(shí)現(xiàn)

這里講兩種實(shí)現(xiàn)方法：進(jìn)程內(nèi)即內(nèi)存固定窗口算法、基于Redis的固定窗口算法。

進(jìn)程內(nèi)即內(nèi)存固定窗口算法

使用字典，Key是限流目標(biāo)，Value包括計(jì)數(shù)值和過期時(shí)間。處理請(qǐng)求時(shí)，首先從請(qǐng)求中提取限流目標(biāo)，然后根據(jù)限流目標(biāo)去字典中查找，如果不存在，則添加一個(gè)字典項(xiàng)，計(jì)數(shù)值是1，過期時(shí)間是當(dāng)前時(shí)間+限流單位時(shí)間；如果存在，則檢查是否過期，如果過期，則計(jì)數(shù)值歸1，過期時(shí)間是當(dāng)前時(shí)間+限流單位時(shí)間，如果未過期，則僅計(jì)數(shù)值加1。這里需要注意多線程問題，讀寫數(shù)據(jù)時(shí)需要加鎖。

在C#語言中可以使用MemoryCache，它的緩存項(xiàng)有一個(gè)過期時(shí)間，不需要自己回收過期的項(xiàng)目。

進(jìn)程內(nèi)計(jì)數(shù)的方法最適合單實(shí)例處理的程序限流，多實(shí)例處理的情況下可能每個(gè)實(shí)例收到的請(qǐng)求數(shù)不均勻，不能保證限流效果。

基于Redis的固定窗口算法

Redis作為KV存儲(chǔ)，類似于字典，而且也自帶過期時(shí)間。處理請(qǐng)求時(shí)，首先從請(qǐng)求中提取限流目標(biāo)，然后根據(jù)限流目標(biāo)去Redis中查找，如果不存在，則添加KV項(xiàng)，Value值是1，過期時(shí)間是當(dāng)前時(shí)間+限流單位時(shí)間；如果存在，則Value值加1。

這些操作邏輯可以封裝在一個(gè)Lua script中，因?yàn)長ua script在Redis中執(zhí)行時(shí)也是原子操作，所以Redis的限流計(jì)數(shù)在分布式處理時(shí)天然就是準(zhǔn)確的。

算法應(yīng)用

這里以限流組件 FireflySoft.RateLimit 為例，實(shí)現(xiàn)ASP.NET Core中的固定窗口限流。

1、安裝Nuget包

有多種安裝方式，選擇自己喜歡的就行了。

包管理器命令：

Install-Package FireflySoft.RateLimit.AspNetCore

或者.NET命令:

dotnet add package FireflySoft.RateLimit.AspNetCore

或者項(xiàng)目文件直接添加：

<ItemGroup>

<PackageReference Include="FireflySoft.RateLimit.AspNetCore" Version="2.*" />

</ItemGroup>

2、使用中間件

在Startup中使用中間件，演示代碼如下（下邊會(huì)有詳細(xì)說明）：

public void ConfigureServices(IServiceCollection services)
        {
           ...
           app.AddRateLimit(new InProcessFixedWindowAlgorithm(
                new[] {
                    new FixedWindowRule()
                    {
                        ExtractTarget = context =>
                        {
                        		// 提取限流目標(biāo)
                            return (context as HttpContext).Request.Path.Value;
                        },
                        CheckRuleMatching = context =>
                        {
                        		// 判斷當(dāng)前請(qǐng)求是否需要限流處理
                            return true;
                        },
                        Name="fixed window limit rule",
                        LimitNumber=30, // 限流閾值
                        StatWindow=TimeSpan.FromSeconds(1) // 限流單位時(shí)間
                    }
                })
            );
            ...
        }

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

如上需要先注冊(cè)服務(wù)，然后使用中間件。

注冊(cè)服務(wù)的時(shí)候需要提供限流算法和對(duì)應(yīng)的規(guī)則：

這里使用進(jìn)程內(nèi)固定窗口算法InProcessFixedWindowAlgorithm，還可以使用RedisFixedWindowAlgorithm，需要傳入一個(gè)Redis連接。
限流閾值是30，限流單位時(shí)間是1秒。
ExtractTarget用于提取限流目標(biāo)，這里是每個(gè)不同的請(qǐng)求Path。如果有IO請(qǐng)求，這里還支持對(duì)應(yīng)的異步方法ExtractTargetAsync。
CheckRuleMatching用于驗(yàn)證當(dāng)前請(qǐng)求是否限流。如果有IO請(qǐng)求，這里還支持對(duì)應(yīng)的異步方法CheckRuleMatchingAsync。
默認(rèn)被限流時(shí)會(huì)返回HttpStatusCode 429，可以在AddRateLimit時(shí)使用可選參數(shù)error自定義這個(gè)值，以及Http Header和Body中的內(nèi)容。

基本的使用就是上邊例子中的這些了。

如果還是基于傳統(tǒng)的.NET Framework，則需要在Application_Start中注冊(cè)一個(gè)消息處理器RateLimitHandler，算法和規(guī)則部分都是共用的，具體可以看Github上的使用說明：https://github.com/bosima/FireflySoft.RateLimit#aspnet

FireflySoft.RateLimit 是一個(gè)基于 .NET Standard 的限流類庫，其內(nèi)核簡單輕巧，能夠靈活應(yīng)對(duì)各種需求的限流場(chǎng)景。