2. 程式人生 > 程式設計 >詳解ASP.NET Core中介軟體Middleware

詳解ASP.NET Core中介軟體Middleware

阿新 • • 發佈：2022-01-15

本文為官方文件譯文，官方文件現已非機器翻譯 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/middleware/?view=aspnetcore-2.1

什麼是中介軟體（Middleware）？

中介軟體是組裝到應用程式管道中以處理請求和響應的軟體。 每個元件：

  • 選擇是否將請求傳遞給管道中的下一個元件。
  • 可以在呼叫管道中的下一個元件之前和之後執行工作。

請求委託（Request delegates）用於構建請求管道，處理每個HTTP請求。

請求委託使用Run，Map和Use擴充套件方法進行配置。單獨的請求委託可以以內聯匿名方法（稱為內聯中介軟體）指定，或者可以在可重用的類中定義它。這些可重用的類和內聯匿名方法是中介軟體或中介軟體元件。請求流程中的每個中介軟體元件都負責呼叫流水線中的下一個元件，如果適當，則負責連結短路。

將HTTP模組遷移到中介軟體解釋了ASP.NET Core和以前版本（ASP.NET）中的請求管道之間的區別，並提供了更多的中介軟體示例。

使用 IApplicationBuilder 建立中介軟體管道

ASP.NET Core請求流程由一系列請求委託組成，如下圖所示（執行流程遵循黑色箭頭）：

詳解ASP.NET Core中介軟體Middleware

每個委託可以在下一個委託之前和之後執行操作。委託還可以決定不將請求傳遞給下一個委託，這稱為請求管道的短路。短路通常是可取的，因為它避免了不必要的工作。例如，靜態檔案中介軟體可以返回一個靜態檔案的請求，並使管道的其餘部分短路。需要在管道早期呼叫異常處理委託，因此它們可以捕獲後面管道的異常。

最簡單的可能是ASP.NET Core應用程式建立一個請求的委託，處理所有的請求。此案例不包含實際的請求管道。相反，針對每個HTTP請求都呼叫一個匿名方法。

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.Run(async context =>
        {
            await context.Response.WriteAsync("Hello,World!");
        });
    }
}

第一個 app.Run 委託終止管道。

有如下程式碼：

詳解ASP.NET Core中介軟體Middleware

通過瀏覽器訪問，發現確實在第一個app.Run終止了管道。

詳解ASP.NET Core中介軟體Middleware

您可以將多個請求委託與app.Use連線在一起。 next引數表示管道中的下一個委託。 （請記住，您可以通過不呼叫下一個引數來結束流水線。）通常可以在下一個委託之前和之後執行操作，如下例所示：

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.Use(async (context,next) =>
	        {
				await context.Response.WriteAsync("進入第一個委託 執行下一個委託之前\r\n");
				//呼叫管道中的下一個委託
		        await next.Invoke();
		        await context.Response.WriteAsync("結束第一個委託 執行下一個委託之後\r\n");
			});
	        app.Run(async context =>
	        {
		        await context.Response.WriteAsync("進入第二個委託\r\n");
				await context.Response.WriteAsync("Hello from 2nd delegate.\r\n");
		        await context.Response.WriteAsync("結束第二個委託\r\n");
			});
    }
}

使用瀏覽器訪問有如下結果：

詳解ASP.NET Core中介軟體Middleware

可以看出請求委託的執行順序是遵循上面的流程圖的。

注意：

響應傳送到客戶端後，請勿呼叫next.Invoke。 響應開始之後，對HttpResponse的更改將丟擲異常。 例如，設定響應頭，狀態程式碼等更改將會引發異常。在呼叫next之後寫入響應體。

  • 可能導致協議違規。 例如，寫入超過content-length所述內容長度。
  • 可能會破壞響應內容格式。 例如，將HTML頁尾寫入檔案。

HttpResponse.HasStarted是一個有用的提示，指示是否已傳送響應頭和/或正文已寫入。

順序

在Startup。Configure方法中新增中介軟體元件的順序定義了在請求上呼叫它們的順序，以及響應的相反順序。 此排序對於安全性，效能和功能至關重要。

Startup.Configure方法（如下所示）添加了以下中介軟體元件：

  • 異常/錯誤處理
  • 靜態檔案服務
  • 身份認證
  • MVC
public void Configure(IApplicationBuilder app)
{
    app.UseExceptionHandler("/Home/Error"); // Call first to catch exceptions
                                            								// thrown in the following middleware.

    app.UseStaticFiles();                   // Return static files and end pipeline.

    app.UseAuthentication();               // Authenticate before you access
                                           					// secure resources.

    app.UseMvcWithDefaultRoute();          // Add MVC to the request pipeline.
}

上面的程式碼，UseExceptionHandler是新增到管道中的第一個中介軟體元件，因此它捕獲以後呼叫中發生的任何異常。

靜態檔案中介軟體在管道中提前呼叫，因此可以處理請求和短路，而無需通過剩餘的元件。 靜態檔案中介軟體不提供授權檢查。 由其提供的任何檔案，包括wwwroot下的檔案都是公開的。

如果請求沒有被靜態檔案中介軟體處理，它將被傳遞給執行身份驗證的Identity中介軟體（app.UseAuthentication）。 身份不會使未經身份驗證的請求發生短路。 雖然身份認證請求，但授權（和拒絕）僅在MVC選擇特定的Razor頁面或控制器和操作之後才會發生。

授權（和拒絕）僅在MVC選擇特定的Razor頁面或Controller和Action之後才會發生。

以下示例演示了中介軟體順序，其中靜態檔案的請求在響應壓縮中介軟體之前由靜態檔案中介軟體處理。 靜態檔案不會按照中介軟體的順序進行壓縮。 來自UseMvcWithDefaultRoute的MVC響應可以被壓縮。

public void Configure(IApplicationBuilder app)
{
    app.UseStaticFiles();         // Static files not compressed
    app.UseResponseCompression();
    app.UseMvcWithDefaultRoute();
}

Use,Run,和 Map

你可以使用Use，Run和Map配置HTTP管道。Use方法可以使管道短路（即，可以不呼叫下一個請求委託）。Run方法是一個約定， 並且一些中介軟體元件可能暴露在管道末端執行的Run [Middleware]方法。Map*擴充套件用作分支管道的約定。對映根據給定的請求路徑的匹配來分支請求流水線，如果請求路徑以給定路徑開始，則執行分支。

public class Startup
{
    private static void HandleMapTest1(IApplicationBuilder app)
    {
        app.Run(async context =>
        {
            await context.Response.WriteAsync("Map Test 1");
        });
    }

    private static void HandleMapTest2(IApplicationBuilder app)
    {
        app.Run(async context =>
        {
            await context.Response.WriteAsync("Map Test 2");
        });
    }

    public void Configure(IApplicationBuilder app)
    {
        app.Map("/map1",HandleMapTest1);

        app.Map("/map2",HandleMapTest2);

        app.Run(async context =>
        {
            await context.Response.WriteAsync("Hello WoSOYVVFafrom non-Map delegate. <p>");
        });
    }
}

詳解ASP.NET Core中介軟體Middleware

下表顯示了使用以前程式碼的 http://localhost:19219 的請求和響應：

請求響應
localhost:1234Hello from non-Map delegate.
localhost:1234/map1Map Test 1
localhost:1234/map2Map Test 2
localhost:1234/map3Hello from non-Map delegate.

當使用Map時，匹配的路徑段將從HttpRequest.Path中刪除，併為每個請求追加到Http Request.PathBase。

MapWhen根據給定謂詞的結果分支請求流水線。 任何型別為Func<HttpContext,bool>的謂詞都可用於將請求對映到管道的新分支。 在以下示例中，謂詞用於檢測查詢字串變數分支的存在：

public class Startup
{
    private static void HandleBranch(IApplicationBuilder app)
    {
        app.Run(async context =>
        {
            var branchVer = context.Request.Query["branch"];
            await context.Response.WriteAsync($"Branch used = {branchVer}");
        });
    }

    public void Configure(IApplicationBuilder app)
    {
        app.MapWhen(context => context.Request.Query.ContainsKey("branch"),HandleBranch);

        app.Run(async context =>
        {
            await context.Response.WriteAsync("Hello from non-Map delegate. <p>");
        });
    }
}

詳解ASP.NET Core中介軟體Middleware

以下下表顯示了使用上面程式碼 http://localhost:19219 的請求和響應：

請求響應
localhost:1234Hello from non-Map delegate.
localhost:1234/?branch=1Branch used = master

Map支援巢狀，例如：

app.Map("/level1",level1App => {
       level1App.Map("/level2a",level2AApp => {
           // "/level1/level2a"
           //...
       });
       level1App.Map("/level2b",level2BApp => {
           // "/level1/level2b"
           //...
       });
   });

Map也可以一次匹配多個片段，例如：

app.Map("/level1/level2",HandleMultiSeg);

內建中介軟體

ASP.NET Core附帶以下中介軟體元件：

中介軟體描述
Authentication提供身份驗證支援
CORS配置跨域資源共享
Response Caching提供快取響應支援
Response Compression提供響應壓縮支援
Routing定義和約束請求路由
Session提供使用者會話管理
Static Files為靜態檔案和目錄瀏覽提供服務提供支援
URL Rewriting Middleware用於重寫 Url，並將請求重定向的支援

編寫中介軟體

中介軟體通常封裝在一個類中，並使用擴充套件方法進行暴露。 檢視以下中介軟體，它從查詢字串設定當前請求的Culture：

public class Startup
{
    public void Configure(IApplicationBuilder app)
    www.cppcns.com{
        app.Use((context,next) =>
        {
            var cultureQuery = context.Request.Query["culture"];
            if (!string.IsNullOrWhiteSpace(cultureQuery))
            {
                var culture = new CultureInfo(cultureQuery);

                CultureInfo.CurrentCulture = culture;
                CultureInfo.CurrentUICulture = culture;
            }

            // Call the next delegate/middleware in the pipeline
         www.cppcns.com   return next();
        });

        app.Run(async (context) =>
        {
            await context.Response.WriteAsync(
                $"Hello {CultureInfo.CurrentCulture.DisplayName}");
        });

    }
}

您可以通過傳遞Culture來測試中介軟體，例如 http://localhost:19219/?culture=zh-CN

以下程式碼將中介軟體委託移動到一個類：

using Microsoft.AspNetCore.Http;
using System.Globalization;
using System.Threading.Tasks;

namespace Culture
{
    public class RequestCultureMiddleware
    {
        private readonly RequestDelegate _next;

        public RequestCultureMiddleware(RequestDelegate next)
        {
            _next = next;
        }

        public Task Invoke(HttpContext context)
        {
            var cultureQuery = context.Request.Query["culture"];
            if (!string.IsNullOrWhiteSpace(cultureQuery))
            {
                var culture = new CultureInfo(cultureQuery);http://www.cppcns.com

                CultureInfo.CurrentCulture = culture;
                CultureInfo.CurrentUICulture = culture;

            }

            // Call the next delegate/middleware in the pipeline
            return this._next(context);
        }
    }
}

以下通過IApplicationBuilder的擴充套件方法暴露中介軟體：

using Microsoft.AspNetCore.Builder;

namespace Culture
{
    public static class RequestCultureMiddlewareExtensions
    {
        public static IApplicationBuilder UseRequestCulture(
            this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<RequestCultureMiddleware>();
        }
    }
}

以下程式碼從Configure呼叫中介軟體：

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.UseRequestCulture();

        app.Run(async (context) =>
        {
            await context.Response.WriteAsync(
                $"Hello {CultureInfo.CurrentCulture.DisplayName}");
        });

    }
}

中介軟體應該遵循顯式依賴原則，通過在其建構函式中暴露其依賴關係。 中介軟體在應用程式生命週期構建一次。 如果您需要在請求中與中介軟體共享服務，請參閱以下請求相關性。

中介軟體元件可以通過構造方法引數來解析依賴注入的依賴關係。 UseMiddleware也可以直接接受其他引數。

每個請求的依賴關係

因為中介軟體是在應用程式啟動時構建的，而不是每個請求，所以在每個請求期間，中介軟體建構函式使用的作用域生命週期服務不會與其他依賴注入型別共享。 如果您必須在中介軟體和其他型別之間共享作用域服務，請將這些服務新增到Invoke方法的簽名中。 Invoke方法可以接受由依賴注入填充的其他引數。 例如：

public class MyMiddleware
{
    private readonly RequestDelegate _next;

    public MyMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext httpContext,IMyScopedService svc)
    {
        svc.MyProperty = 1000;
        await _next(httpContext);
    }
}

到此這篇關於ASP.NET Core中介軟體Middleware詳解的文章就介紹到這了。希望對大家的學習有所幫助，也希望大家多多支援我們。

相關推薦

詳解ASP.NET Core中介軟體Middleware

本文為官方文件譯文，官方文件現已非機器翻譯 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/middleware/?view=aspnetcore-2.1

理解ASP.NET Core 中介軟體(Middleware)

目錄中介軟體中介軟體管道RunUseUseWhenMapMapWhenRun & QmumLXUse & UseWhen & Map & Map編寫中介軟體並激活基於約定的中介軟體基於工廠的中介軟體基於約定的中介軟體 VS 基於工廠的中介軟體中介軟

ASP.NET Core 中介軟體(Middleware)的使用及其原始碼解析（一）

中介軟體是一種裝配到應用管道以處理請求和響應的軟體。每個元件： 1、選擇是否將請求傳遞到管道中的下一個元件。

詳解ASP.NET Core 中基於工廠的中介軟體啟用的實現方法

IMiddlewareFactory/IMiddleware是中介軟體啟用的擴充套件點。 UseMiddleware擴充套件方法檢查中介軟體的已註冊型別是否實現IMiddleware。如果是，則使用在容器中註冊的IMiddlewareFactory例項來解析IMiddleware實現

詳解ASP.NET Core中配置監聽URLs的五種方式

預設情況下，ASP. NET Core應用會監聽一下2個Url: http://localhost:5000 https://localhost:5001

詳解ASP.NET Core端點路由的作用原理

端點路由(Endpoint Routing)最早出現在ASP.NET Core2.2，在ASP.NET Core3.0提升為一等公民。

asp .net core 中介軟體

前言 對中介軟體的一個概況，在《重新整理.net core 計1400篇》系列後面會深入。

ASP.NET Core中介軟體 - WebMarkupMin

WebMarkupMin可以做什麼： 執行時最小化html、css、js（去除空格、註釋...） 對HTTP啟用壓縮（GZip、Deflate、Brotli..）

詳解ASP.NET Core Web Api之JWT重新整理Token

前言 如題，本節我們進入JWT最後一節內容，JWT本質上就是從身份認證伺服器獲取訪問令牌，繼而對於使用者後續可訪問受保護資源，但是關鍵問題是：訪問令牌的生命週期到底設定成多久呢？見過一些使用JWT的童鞋會將JWT過

ASP.NET Core 中介軟體

ASP.NET Core 中介軟體（Middleware）詳解 什麼是中介軟體（Middleware）？ 中介軟體是一種裝配到應用管道以處理請求和響應的軟體。每個元件：

ASP.NET Core 中介軟體獲取控制器方法中的自定義特性

為了實現自己的操作日誌記錄功能，我有個思路： 自定義特性ActionAttribute； 在每個控制器方法上加上自定義特性；

ASP .Net Core 中介軟體的使用（一）：搭建靜態檔案伺服器/訪問指定檔案

前言 隨著Asp .Net Core的升級迭代，很多開發者都逐漸傾向於.net core開發。 .net core是一個跨平臺的應用程式，可以在windows、Linux、macOS系統上進行開發和部署，是一個體系結構更精簡模組化框架。

ASP.NET Core 中介軟體的使用（二）：依賴注入的使用

寫在前面 上一篇大家已經粗略接觸瞭解到.NET Core中介軟體的使用：ASP .Net Core 中介軟體的使用（一）：搭建靜態檔案伺服器/訪問指定檔案，

ASP.NET Core 中介軟體獲取自定義特性

技術標籤：dotnetcoreC# .netWeb伺服器中介軟體dotnetcore 在做一個軟體授權相關的需求時，需要在中介軟體中過濾授權資訊，同時需要考慮一些不需要檢查授權的特殊情況。

ASP.NET Core中介軟體初始化的實現

前言 在日常使用ASP.NET Core開發的過程中我們多多少少會設計到使用中介軟體的場景，ASP.NET Core預設也為我們內建了許多的中介軟體，甚至有時候我們需要自定義中介軟體來幫我們處理一些請求管道過程中的處理。接下

ASP.NET Core 中介軟體的使用之全域性異常處理機制

目錄1、建立專案2、建立全域性異常過濾器3、依賴注入全域性異常處理機制4、測試全域性異常處理機制前言：

net core 中介軟體 MiddleWare 三種方式

直接通過反射 找到類 RequestDelegate和InvokeAsync這2個都是固定寫法 框架幫我們寫死的 ，如果看是不是中介軟體，框架先檢查 引數 有沒有InvokeAsync方法和第一個引數必須是RequestDelegate

Asp.net core中介軟體實現原理及用法解說(轉載)

Asp.net core中介軟體實現原理及用法解說 簡述asp.net core中介軟體的實現思路 一次http請求的過程，就是對一個Request請求進行若干次邏輯處理，並最終設定Response的過程。從程式碼的實現維度看，由於Request和R

Asp.Net Core 中介軟體應用實戰中你不知道的那些事

一、概述這篇文章主要分享Endpoint 終結點路由的中介軟體的應用場景及實踐案例，不講述其工作原理，如果需要了解工作原理的同學， 可以點選檢視以下兩篇解讀文章：

詳解在.net core中完美解決多租戶分庫分表的問題

前幾天有人想做一個多租戶的平臺,每個租戶一個庫,可以進行水平擴充套件,應用端根據登入資訊,切換到不同的租戶庫