ASP.NET Core Middleware的實(shí)現(xiàn)方法詳解
概念
ASP.NET Core Middleware是在應(yīng)用程序處理管道pipeline中用于處理請求和操作響應(yīng)的組件。
每個(gè)組件:
- 在pipeline中判斷是否將請求傳遞給下一個(gè)組件
- 在處理管道的下個(gè)組件執(zhí)行之前和之后執(zhí)行一些工作, HttpContxt對象能跨域請求、響應(yīng)的執(zhí)行周期
特性和行為
ASP.NET Core處理管道由一系列請求委托組成,一環(huán)接一環(huán)的被調(diào)用, 下面給出自己繪制的Middleware pipeline流程圖:
從上圖可以看出,請求自進(jìn)入處理管道,經(jīng)歷了四個(gè)中間件,每個(gè)中間件都包含后續(xù)緊鄰中間件 執(zhí)行委托(next)的引用,同時(shí)每個(gè)中間件在交棒之前和交棒之后可以自行決定參與一些Http請求和響應(yīng)的邏輯處理。
每個(gè)中間件還可以決定不將請求轉(zhuǎn)發(fā)給下一個(gè)委托,這稱為請求管道的短路(短路是有必要的,某些專有中間件比如 StaticFileMiddleware 可以在完成功能之后,避免請求被轉(zhuǎn)發(fā)到其他動(dòng)態(tài)處理過程)。
源碼實(shí)現(xiàn)
觀察一個(gè)標(biāo)準(zhǔn)的中間件代碼的寫法和用法:
using System.Threading.Tasks;
using Alyio.AspNetCore.ApiMessages;
using Gridsum.WebDissector.Common;
using Microsoft.AspNetCore.Http;
namespace Gridsum.WebDissector
{
sealed class AuthorizationMiddleware
{
private readonly RequestDelegate _next; // 下一個(gè)中間件執(zhí)行委托的引用
public AuthorizationMiddleware(RequestDelegate next)
{
_next = next;
}
public Task Invoke(HttpContext context) // 貫穿始終的HttpContext對象
{
if (context.Request.Path.Value.StartsWith("/api/"))
{
return _next(context);
}
if (context.User.Identity.IsAuthenticated && context.User().DisallowBrowseWebsite)
{
throw new ForbiddenMessage("You are not allow to browse the website.");
}
return _next(context);
}
}
}
public static IApplicationBuilder UserAuthorization(this IApplicationBuilder app)
{
return app.UseMiddleware<AuthorizationMiddleware>();
}
// 啟用該中間件,也就是注冊該中間件
app.UserAuthorization();
標(biāo)準(zhǔn)的中間件使用方式是如此簡單明了,帶著幾個(gè)問題探究一下源碼實(shí)現(xiàn)
(1).中間件傳參是怎樣完成的: app.UseMiddleware<Authorization>(AuthOption); 我們傳參的時(shí)候,為什么能自動(dòng)注入中間件構(gòu)造函數(shù)非第1個(gè)參數(shù)
(2).編寫中間件的時(shí)候,為什么必須要定義特定的 Invoke/InvokeAsync 函數(shù)?
(3).設(shè)定中間件的順序很重要,中間件的嵌套順序是怎么確定的 ?
思考以上標(biāo)準(zhǔn)中間件的行為: 輸入下一個(gè)中間件的執(zhí)行委托Next, 定義當(dāng)前中間件的執(zhí)行委托Invoke/InvokeAsync;
每個(gè)中間件完成了 Func<RequestDelegate,RequestDelegate>這樣的行為;
通過參數(shù)next與下一個(gè)中間件的執(zhí)行委托Invoke/InvokeAsync 建立"鏈?zhǔn)?關(guān)系。
public delegate Task RequestDelegate(HttpContext context);
//-----------------節(jié)選自 Microsoft.AspNetCore.Builder.UseMiddlewareExtensions------------------
/// <summary>
/// Adds a middleware type to the application's request pipeline.
/// </summary>
/// <typeparam name="TMiddleware">The middleware type.</typeparam>
/// <param name="app">The <see cref="IApplicationBuilder"/> instance.</param>
/// <param name="args">The arguments to pass to the middleware type instance's constructor.</param>
/// <returns>The <see cref="IApplicationBuilder"/> instance.</returns>
public static IApplicationBuilder UseMiddleware<TMiddleware>(this IApplicationBuilder app, params object[] args)
{
return app.UseMiddleware(typeof(TMiddleware), args);
}
/// <summary>
/// Adds a middleware type to the application's request pipeline.
/// </summary>
/// <param name="app">The <see cref="IApplicationBuilder"/> instance.</param>
/// <param name="middleware">The middleware type.</param>
/// <param name="args">The arguments to pass to the middleware type instance's constructor.</param>
/// <returns>The <see cref="IApplicationBuilder"/> instance.</returns>
public static IApplicationBuilder UseMiddleware(this IApplicationBuilder app, Type middleware, params object[] args)
{
if (typeof(IMiddleware).GetTypeInfo().IsAssignableFrom(middleware.GetTypeInfo()))
{
// IMiddleware doesn't support passing args directly since it's
// activated from the container
if (args.Length > 0)
{
throw new NotSupportedException(Resources.FormatException_UseMiddlewareExplicitArgumentsNotSupported(typeof(IMiddleware)));
}
return UseMiddlewareInterface(app, middleware);
}
var applicationServices = app.ApplicationServices;
return app.Use(next =>
{
var methods = middleware.GetMethods(BindingFlags.Instance | BindingFlags.Public); // 執(zhí)行委托名稱被限制為Invoke/InvokeAsync
var invokeMethods = methods.Where(m =>
string.Equals(m.Name, InvokeMethodName, StringComparison.Ordinal)
|| string.Equals(m.Name, InvokeAsyncMethodName, StringComparison.Ordinal)
).ToArray();
if (invokeMethods.Length > 1)
{
throw new InvalidOperationException(Resources.FormatException_UseMiddleMutlipleInvokes(InvokeMethodName, InvokeAsyncMethodName));
}
if (invokeMethods.Length == 0)
{
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareNoInvokeMethod(InvokeMethodName, InvokeAsyncMethodName, middleware));
}
var methodInfo = invokeMethods[0];
if (!typeof(Task).IsAssignableFrom(methodInfo.ReturnType))
{
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareNonTaskReturnType(InvokeMethodName, InvokeAsyncMethodName, nameof(Task)));
}
var parameters = methodInfo.GetParameters();
if (parameters.Length == 0 || parameters[0].ParameterType != typeof(HttpContext))
{
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareNoParameters(InvokeMethodName, InvokeAsyncMethodName, nameof(HttpContext)));
}
var ctorArgs = new object[args.Length + 1];
ctorArgs[0] = next;
Array.Copy(args, 0, ctorArgs, 1, args.Length); // 通過反射形成中間件實(shí)例的時(shí)候,構(gòu)造函數(shù)第一個(gè)參數(shù)被指定為 下一個(gè)中間件的執(zhí)行委托 var instance = ActivatorUtilities.CreateInstance(app.ApplicationServices, middleware, ctorArgs);
if (parameters.Length == 1)
{
return (RequestDelegate)methodInfo.CreateDelegate(typeof(RequestDelegate), instance);
}
// 當(dāng)前執(zhí)行委托除了可指定HttpContext參數(shù)以外, 還可以注入更多的依賴參數(shù)
var factory = Compile<object>(methodInfo, parameters);
return context =>
{
var serviceProvider = context.RequestServices ?? applicationServices;
if (serviceProvider == null)
{
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareIServiceProviderNotAvailable(nameof(IServiceProvider)));
}
return factory(instance, context, serviceProvider);
};
});
}
//-------------------節(jié)選自 Microsoft.AspNetCore.Builder.Internal.ApplicationBuilder-------------------
private readonly IList<Func<RequestDelegate, RequestDelegate>> _components = new List<Func<RequestDelegate, RequestDelegate>>();
publicIApplicationBuilder Use(Func<RequestDelegate,RequestDelegate>middleware)
{
this._components.Add(middleware);
return this;
}
public RequestDelegate Build()
{
RequestDelegate app = context =>
{
context.Response.StatusCode = 404;
return Task.CompletedTask;
};
foreach (var component in _components.Reverse())
{
app = component(app);
}
return app;
}
通過以上代碼我們可以看出:
- 注冊中間件的過程實(shí)際上,是給一個(gè)
Type= List<Func<RequestDelegate, RequestDelegate>>的容器依次添加元素的過程; - 容器中每個(gè)元素對應(yīng)每個(gè)中間件的行為委托
Func<RequestDelegate, RequestDelegate>, 這個(gè)行為委托包含2個(gè)關(guān)鍵行為:輸入下一個(gè)中間件的執(zhí)行委托next:RequestDelegate, 完成當(dāng)前中間件的Invoke函數(shù): RequestDelegate; - 通過build方法完成前后中間件的鏈?zhǔn)絺髦店P(guān)系

分析源碼:回答上面的問題:
- 使用反射構(gòu)造中間件的時(shí)候,第一個(gè)參數(shù)Array[0] 是下一個(gè)中間件的執(zhí)行委托
- 當(dāng)前中間件執(zhí)行委托 函數(shù)名稱被限制為: Invoke/InvokeAsync, 函數(shù)支持傳入除HttpContext之外的參數(shù)
- 按照代碼順序添加進(jìn)入 _components容器, 通過后一個(gè)中間件的執(zhí)行委托 -----(指向)----> 前一個(gè)中間件的輸入執(zhí)行委托建立鏈?zhǔn)疥P(guān)系。
附:非標(biāo)準(zhǔn)中間件的用法
短路中間件、 分叉中間件
整個(gè)處理管道的形成,存在一些管道分叉或者臨時(shí)插入中間件的行為,一些重要方法可供使用
- Use方法是一個(gè)注冊中間件的簡便寫法
- Run方法是一個(gè)約定,一些中間件使用Run方法來完成管道的結(jié)尾
- Map擴(kuò)展方法:請求滿足指定路徑,將會(huì)執(zhí)行分叉管道,強(qiáng)調(diào)滿足 path
- MapWhen方法:HttpContext滿足條件,將會(huì)執(zhí)行分叉管道:
- UseWhen方法:選擇性的注入中間件

總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
- 詳解ASP.NET Core中間件Middleware
- 理解ASP.NET Core 中間件(Middleware)
- 探究ASP.NET Core Middleware實(shí)現(xiàn)方法
- ASP.NET Core應(yīng)用錯(cuò)誤處理之StatusCodePagesMiddleware中間件針對響應(yīng)碼呈現(xiàn)錯(cuò)誤頁面
- ASP.NET Core應(yīng)用錯(cuò)誤處理之ExceptionHandlerMiddleware中間件呈現(xiàn)“定制化錯(cuò)誤頁面”
- ASP.NET Core應(yīng)用錯(cuò)誤處理之DeveloperExceptionPageMiddleware中間件呈現(xiàn)“開發(fā)者異常頁面”
- 利用Asp.Net Core的MiddleWare思想如何處理復(fù)雜業(yè)務(wù)流程詳解
- ASP.NET?Core使用Middleware設(shè)置有條件允許訪問路由
相關(guān)文章
Asp.NET 隨機(jī)碼生成基類(隨機(jī)字母,隨機(jī)數(shù)字,隨機(jī)字母+數(shù)字)
對于需要用asp.net 字母,隨機(jī)數(shù)字,隨機(jī)字母+數(shù)字生成隨機(jī)碼的朋友用的到2008-11-11
.net?core中高效的動(dòng)態(tài)內(nèi)存管理方案
這篇文章介紹了.net?core中高效的動(dòng)態(tài)內(nèi)存管理方案,文中通過示例代碼介紹的非常詳細(xì)。對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-07-07
.net 獲取瀏覽器Cookie(包括HttpOnly)實(shí)例分享
這篇文章介紹了.net 獲取瀏覽器Cookie(包括HttpOnly)實(shí)例,有需要的朋友可以參考一下2013-10-10
Asp.net內(nèi)置對象之Cookies(簡介/屬性方法/基本操作及實(shí)例)
本文將圍繞cookies了解Cookies對象/Cookie對象的屬性和方法/Cookie的基本操作及實(shí)例:Cookie的寫入和讀取/Cookie對象相比Session、Application的優(yōu)缺點(diǎn)扥等,感興趣的朋友可以了解下,或許對你學(xué)習(xí)cookies有所幫助2013-02-02
.Net Core+Angular Cli/Angular4開發(fā)環(huán)境搭建教程
這篇文章主要為大家詳細(xì)介紹了.Net Core+Angular Cli/Angular4開發(fā)環(huán)境搭建教程,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-06-06
asp.net core 3.0中使用swagger的方法與問題
這篇文章主要給大家介紹了關(guān)于asp.net core 3.0中使用swagger的方法與遇到的一些問題,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者使用asp.net core 3.0具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧2019-10-10
asp.net中“從客戶端中檢測到有潛在危險(xiǎn)的Request.Form值”錯(cuò)誤的解決辦法
這篇文章主要介紹了asp.net中“從客戶端中檢測到有潛在危險(xiǎn)的Request.Form值”錯(cuò)誤的解決辦法,需要的朋友可以參考下2015-11-11
Asp.net treeview實(shí)現(xiàn)無限級樹實(shí)現(xiàn)代碼
最近研究了一下treeview,發(fā)現(xiàn)有兩種實(shí)現(xiàn)無限級樹的方法,文字不想多寫,直入主題。2009-09-09
.NET Core API之格式化輸出對象OutputFormatter
這篇文章介紹了.NET Core API之格式化輸出對象OutputFormatter,文中通過示例代碼介紹的非常詳細(xì)。對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-04-04

