ASP.NET Core使用Middleware設置有條件允許訪問路由

1.簡介

有時,我們可能在Web API中包含一些具有調試功能的請求。比如我們上次的文章中 為什麼ASP.NET Core 數據庫連接串的值和appsettings.json配的不一樣?使用的獲取配置值的功能:

endpoints.MapGet("/test2/{key:alpha}", async context =>
{
    var key = context.Request.RouteValues["key"].ToString();
    foreach (var provider in Configuration.Providers.Reverse())
    {
        if (provider.TryGet(key, out string value))
        {
            await context.Response.WriteAsync(provider.ToString());
            await context.Response.WriteAsync("\r\n");
            await context.Response.WriteAsync(value);
            break;
        }
    }
});

但你絕不會想在生產環境中暴露它們。要想實現此目的,有多種方案:

  • 用戶權限驗證
  • 編譯成單獨dll,不發佈到生產環境

這些方案各有利弊,這裡我們介紹一種使用Middleware實現的簡單方案。

2.實現

從上圖可以看到,請求要訪問到實際路由,需要先經過Middleware,我們可以在最外層的Middleware進行檢查,隻有滿足條件的請求才能通過,否則返回403錯誤。

Middleware代碼如下:

public class DebugMiddleware : IMiddleware
{
    public async Task InvokeAsync(HttpContext context, RequestDelegate next)
    {
        var isDebugEndpoint = context.Request.Path.Value.Contains("/test");
        var debugKey = context.Request.Query["debugKey"].ToString();
        var debugKeyInConfig = "123456";//來自於配置
        if (isDebugEndpoint && debugKey!=debugKeyInConfig)
        {
            context.SetEndpoint(new Endpoint((context) =>
            {
                context.Response.StatusCode = StatusCodes.Status403Forbidden;
                return Task.CompletedTask;
            },
                        EndpointMetadataCollection.Empty,
                        "無權訪問"));
        }

        await next(context);
            
    }
}

當請求地址包含“/test”時,檢查請求參數debugKey是否和配置的值一樣,如果不一樣就返回403錯誤。

效果如下圖:

到此這篇關於ASP.NET Core使用Middleware設置有條件允許訪問路由的文章就介紹到這瞭,更多相關ASP.NET Core使用Middleware有條件允許訪問路由內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: