asp.net core web api項(xiàng)目添加自定義中間件的實(shí)現(xiàn)
前言
在asp.net core web api項(xiàng)目中,默認(rèn)提供了很多的中間件,比如訪問(wèn)靜態(tài)文件中間件UseStaticFiles
,跨域配置中間件UseCors
,路由中間件UseRouting
,身份驗(yàn)證中間件UseAuthentication
。
那么如何添加一些自定義的中間件呢。
需求
現(xiàn)在有一個(gè)需求,我們的所有接口中都有一個(gè)
TimeSpan
參數(shù),傳入的是當(dāng)前時(shí)間的時(shí)間戳,正常需要對(duì)時(shí)間戳進(jìn)行加密,然后在加一個(gè)統(tǒng)一的驗(yàn)證方法,只正常處理2分鐘以內(nèi)的請(qǐng)求,超時(shí)的請(qǐng)求不在處理,直接返回錯(cuò)誤代碼,這樣可以一定程度上保護(hù)我們的業(yè)務(wù)數(shù)據(jù)。
這時(shí)我們就可以添加一個(gè)自定義的中間件,對(duì)所有過(guò)來(lái)的請(qǐng)求先進(jìn)行時(shí)間戳校驗(yàn)處理,處理通過(guò)的再返回到業(yè)務(wù)邏輯正常處理,時(shí)間戳校驗(yàn)不通過(guò)的則直接返回錯(cuò)誤碼。
實(shí)現(xiàn)
接下來(lái)看實(shí)現(xiàn)。
為了演示,我還是新建一個(gè)空的asp.net core web api項(xiàng)目。然后調(diào)用WeatherForecastController
下的Get
方法來(lái)做測(cè)試。
然后添加一個(gè)類,為了簡(jiǎn)單點(diǎn),這個(gè)類就一個(gè)TimeSpan
參數(shù)。
public class BaseRequest { public string TimeSpan { get; set; } }
為了方便的使用中間件,我們希望可以直接在Program下的Main函數(shù)里直接調(diào)用。類似這樣。
public static void Main(string[] args) { var builder = WebApplication.CreateBuilder(args); builder.Services.AddControllers(); var app = builder.Build(); //這里是自定義添加的中間件 app.UseRequestCheckMiddleware(); app.UseAuthorization(); app.MapControllers(); app.Run(); }
Startup里添加原理一樣。
所以首先我需要添加一個(gè)ApplicationBuilder
的擴(kuò)展方法。這樣才能調(diào)用方法一樣用.
出來(lái)。
添加一個(gè)ApplicationBuilderExtension
類。
public static class ApplicationBuilderExtension { public static IApplicationBuilder UseRequestCheckMiddleware(this IApplicationBuilder builder) { return builder.UseMiddleware<RequestCheckMiddleware>(); } }
在這個(gè)類里通過(guò)builder.UseMiddleware
傳入一個(gè)實(shí)現(xiàn)類,就可以實(shí)現(xiàn)中間件添加的效果了,如果想添加多個(gè)自定義的中間件,可以繼續(xù)添加新的Use
方法。
接下來(lái)重點(diǎn)就是RequestCheckMiddleware
的實(shí)現(xiàn)。
public class RequestCheckMiddleware { private readonly RequestDelegate _next; public RequestCheckMiddleware(RequestDelegate next) { _next= next; } public async Task InvokeAsync(HttpContext context) { HttpRequest request = context.Request; //緩存下來(lái)允許多次讀取 request.EnableBuffering(); var reader = new StreamReader(request.Body, Encoding.UTF8); string data = await reader.ReadToEndAsync(); // 重置流的位置以便后續(xù)中間件可以讀取 request.Body.Position = 0; try { var inputJson = JsonSerializer.Deserialize<BaseRequest>(data); // 假設(shè) BaseRequest.TimeSpan 是一個(gè) long 類型的 UNIX 時(shí)間戳 if (string.IsNullOrEmpty(inputJson.TimeSpan)) { await HandleError(context, 500, "時(shí)間戳為空!"); return; } var requestTime = UnixTimeStampToDateTime(Convert.ToInt64(inputJson.TimeSpan)); if (DateTime.Now - requestTime > TimeSpan.FromMinutes(2)) { await HandleError(context, 429, "超時(shí)請(qǐng)求!"); return; } await _next(context); } catch (Exception ex) { await HandleError(context, 400, $"處理請(qǐng)求失敗: {ex.Message}"); } } private async Task HandleError(HttpContext context, int statusCode, string message) { context.Response.StatusCode = statusCode; var result = new { code = statusCode, message = message, result = new object() }; await context.Response.WriteAsync(JsonSerializer.Serialize(result)); } private DateTime UnixTimeStampToDateTime(long unixTimeStamp) { // UNIX 時(shí)間戳轉(zhuǎn)換為 DateTime DateTime dateTime = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc); dateTime = dateTime.AddSeconds(unixTimeStamp).ToLocalTime(); return dateTime; } }
這里有幾點(diǎn)可以解釋一下。
1、這里的主函數(shù)名必須是Invoke
或者InvokeAsync
,且入?yún)⑹?code>HttpContext。表示這是在請(qǐng)求管道中對(duì)請(qǐng)求進(jìn)行處理的中間件。
2、這里需要定義RequestDelegate
的委托,因?yàn)樾枰诋?dāng)前邏輯處理完成后,還需要把請(qǐng)求傳遞到下一步。
3、request.Body
默認(rèn)只能被讀取一次,為了傳遞到下一步依然有原模原樣的請(qǐng)求參數(shù),所以需要先對(duì)請(qǐng)求進(jìn)行緩存處理。讀取完成之后,需要把流的位置重置到開(kāi)始。方便后面可以再次讀取請(qǐng)求內(nèi)容。
然后在Program里添加對(duì)應(yīng)中間件就行了。
//這里是自定義添加的中間件 app.UseRequestCheckMiddleware();
驗(yàn)證
最后來(lái)演示一下效果。
首先傳遞一個(gè)2分鐘內(nèi)正常的時(shí)間戳。
請(qǐng)求可以正常返回。
接著等一會(huì)吧,等時(shí)間戳過(guò)期。
到此這篇關(guān)于asp.net core web api項(xiàng)目添加自定義中間件的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)asp.net core web api中間件內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
.NET 與樹(shù)莓派WS28XX 燈帶的顏色漸變動(dòng)畫效果的實(shí)現(xiàn)
所謂顏色漸變動(dòng)畫,首先,你要確定兩種顏色——起始色和最終色,比如從綠色變成紅色,綠色是起始,紅色是終點(diǎn)。這篇文章主要介紹了.NET 與樹(shù)莓派WS28XX 燈帶的顏色漸變動(dòng)畫,需要的朋友可以參考下2021-12-12NLog路由規(guī)則和上下文信息知識(shí)點(diǎn)總結(jié)
在本篇文章里小編給各位整理的是關(guān)于NLog路由規(guī)則和上下文信息的相關(guān)文章,有需要的朋友們學(xué)習(xí)下。2019-10-10Visual Studio 2017 IDE安裝使用圖文教程
這篇文章主要為大家詳細(xì)介紹了Visual Studio 2017 IDE安裝使用圖文教程,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-09-09asp.net在Repeater嵌套的Repeater中使用復(fù)選框詳解
這篇文章主要介紹了asp.net在Repeater嵌套的Repeater中使用復(fù)選框,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-12-12在ASP.NET中支持?jǐn)帱c(diǎn)續(xù)傳下載大文件(ZT)源碼
這篇文章主要為大家介紹了在ASP.NET中如何做到支持?jǐn)帱c(diǎn)續(xù)傳下載大文件(ZT),需要的朋友可以參考下2014-07-07asp.net 模擬提交有文件上傳的表單(通過(guò)http模擬上傳文件)
通過(guò)HTTP模擬GET或POST請(qǐng)求,提交數(shù)據(jù)到服務(wù)端獲取響應(yīng),比較常見(jiàn)些;但如上傳文件到服務(wù)端,使用html form當(dāng)然簡(jiǎn)單了,而因環(huán)境所限有時(shí)需要使用模擬方法去提交有附件(文件上傳)的表單。2010-02-02將Access數(shù)據(jù)庫(kù)中數(shù)據(jù)導(dǎo)入到SQL Server中的詳細(xì)方法實(shí)例
將Access數(shù)據(jù)庫(kù)中數(shù)據(jù)導(dǎo)入到SQL Server中的詳細(xì)方法實(shí)例,需要的朋友可以參考一下2013-03-03