快捷導(dǎo)航

asp.net core web api項(xiàng)目添加自定義中間件的實(shí)現(xiàn)

更新時(shí)間：2025年01月06日 11:08:05 作者：李公子lm

ASP.NET Core Web API項(xiàng)目中可以通過自定義中間件來對(duì)請(qǐng)求進(jìn)行時(shí)間戳校驗(yàn),本文就來介紹一下項(xiàng)目添加自定義中間件的實(shí)現(xiàn),具有一定的參考價(jià)值,感興趣的可以了解一下

前言

在asp.net core web api項(xiàng)目中，默認(rè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ì)所有過來的請(qǐng)求先進(jìn)行時(shí)間戳校驗(yàn)處理，處理通過的再返回到業(yè)務(wù)邏輯正常處理，時(shí)間戳校驗(yàn)不通過的則直接返回錯(cuò)誤碼。

實(shí)現(xiàn)

接下來看實(shí)現(xiàn)。

為了演示，我還是新建一個(gè)空的asp.net core web api項(xiàng)目。然后調(diào)用WeatherForecastController下的Get方法來做測(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)用方法一樣用.出來。
添加一個(gè)ApplicationBuilderExtension類。

public static class ApplicationBuilderExtension
{
     public static IApplicationBuilder UseRequestCheckMiddleware(this IApplicationBuilder builder)
     {
        return builder.UseMiddleware<RequestCheckMiddleware>();
     }
 }

在這個(gè)類里通過builder.UseMiddleware傳入一個(gè)實(shí)現(xiàn)類，就可以實(shí)現(xiàn)中間件添加的效果了，如果想添加多個(gè)自定義的中間件，可以繼續(xù)添加新的Use方法。

接下來重點(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;
        //緩存下來允許多次讀取
        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)行緩存處理。讀取完成之后，需要把流的位置重置到開始。方便后面可以再次讀取請(qǐng)求內(nèi)容。

然后在Program里添加對(duì)應(yīng)中間件就行了。

 //這里是自定義添加的中間件
  app.UseRequestCheckMiddleware();

驗(yàn)證

最后來演示一下效果。
首先傳遞一個(gè)2分鐘內(nèi)正常的時(shí)間戳。

在這里插入圖片描述

請(qǐng)求可以正常返回。

接著等一會(huì)吧，等時(shí)間戳過期。

在這里插入圖片描述

到此這篇關(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)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: