在Asp.netCore中使用Attribute來描述限流的操作步驟

更新時間：2024年12月26日 09:26:19 作者：老九

這篇文章主要介紹了在Asp.netCore中使用Attribute來描述限流的操作步驟,本文給大家介紹的非常詳細,感興趣的朋友一起看看吧

前言

同事問我Asp.netCore的RateLimiting是怎么使用的，我回答說很簡單的，你只要按照如下步驟來：

在RateLimiterOptions上注冊policy，記住policy對應的policyName
在Web應用添加UseRateLimiter()中間件
在api對應的Action上標注[EnableRateLimiting(policyName)]

半小時后，同事說要對我告知他的RateLimiter功能差評，因為他得寫幾十種policy工作量很大，就連policyName的取名都讓他頭大。

讓RateLimiting更簡單

我在基于Yarp的網(wǎng)關上做過RateLimiting，將每個服務的所有Endpoint描述導出放到網(wǎng)關做網(wǎng)關的子級路由，然后基于Endpoint做可配置化的限流，代碼實現(xiàn)上很復雜但使用靈活度非?？捎^。
但今天我們的問題范圍是在單體WebApplication中，如何減少我同事的限流工作量。

限流器Attribute化

假如我們造了如下的Attribute：

[RateLimiter.Concurrency(permitLimit: 10)]
[RateLimiter.FixedWindow(permitLimit: 10, windowSeconds: 60)]
[RateLimiter.SlidingWindow(permitLimit: 10, windowSeconds: 60, segmentsPerWindow: 5)]

讓我的同事在Action上標記其中一個Attribute，他的開發(fā)時間短、代碼可讀性高，免去了他手寫policy實現(xiàn)的巨量代碼。

限流單元來源Attribute化

同事說他的眾多接口中，需要整體限流的很少，幾乎都是需要顆粒度更細的限流：

登錄接口，需要對請求體的json對象的userName值做限流單元
找回密碼接口，需要對請求路由里的userName值做限流單元
其它已經(jīng)做了用戶身份認證的接口，需要用userId值做限流單元
xx特殊接口，需要用請求者IP值做限流單元
yy接口需要從Form中取出yy值做限流單元
zz接口需要從Header中取出zz值做限流單元
想自定義從HttpContext里獲取限流單元

于是我們又造了一些Attribute，來處理上面的需求

[RateLimiterUnit.FromBody(unitName: "$.userName")]
[RateLimiterUnit.FromRoute(unitName: "userName")]
[RateLimiterUnit.FromUser(unitName: ClaimTypes.NameIdentifier)]
[RateLimiterUnit.FromRemoteIPAddress]
[RateLimiterUnit.FromForm(unitName: "yy")]
[RateLimiterUnit.FromHeader(unitName: "zz")]

再提供一個IRateLimiterUnitMetadata接口，讓他實現(xiàn)自定義邏輯

public class YourRateLimiterUnitAttribute : Attribute, IRateLimiterUnitMetadata
{
    public ValueTask<string?> GetUnitAsync(HttpContext context)
    {
        throw new NotImplementedException();
    }
}