概念
ASP.NET Core Middleware是在應用程序處理管道pipeline中用于處理請求和操作響應的組件。
每個組件:
特性和行為
ASP.NET Core處理管道由一系列請求委托組成,一環(huán)接一環(huán)的被調用, 下面給出自己繪制的Middleware pipeline流程圖:
從上圖可以看出,請求自進入處理管道,經歷了四個中間件,每個中間件都包含后續(xù)緊鄰中間件 執(zhí)行委托(next)的引用,同時每個中間件在交棒之前和交棒之后可以自行決定參與一些Http請求和響應的邏輯處理。
每個中間件還可以決定不將請求轉發(fā)給下一個委托,這稱為請求管道的短路(短路是有必要的,某些專有中間件比如 StaticFileMiddleware 可以在完成功能之后,避免請求被轉發(fā)到其他動態(tài)處理過程)。
源碼實現(xià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; // 下一個中間件執(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();
標準的中間件使用方式是如此簡單明了,帶著幾個問題探究一下源碼實現(xiàn)
(1).中間件傳參是怎樣完成的: app.UseMiddleware<Authorization>(AuthOption); 我們傳參的時候,為什么能自動注入中間件構造函數非第1個參數
(2).編寫中間件的時候,為什么必須要定義特定的 Invoke/InvokeAsync 函數?
(3).設定中間件的順序很重要,中間件的嵌套順序是怎么確定的 ?
思考以上標準中間件的行為: 輸入下一個中間件的執(zhí)行委托Next, 定義當前中間件的執(zhí)行委托Invoke/InvokeAsync;
每個中間件完成了 Func<RequestDelegate,RequestDelegate>這樣的行為;
通過參數next與下一個中間件的執(zhí)行委托Invoke/InvokeAsync 建立"鏈式"關系。
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); // 通過反射形成中間件實例的時候,構造函數第一個參數被指定為 下一個中間件的執(zhí)行委托 var instance = ActivatorUtilities.CreateInstance(app.ApplicationServices, middleware, ctorArgs); if (parameters.Length == 1) { return (RequestDelegate)methodInfo.CreateDelegate(typeof(RequestDelegate), instance); } // 當前執(zhí)行委托除了可指定HttpContext參數以外, 還可以注入更多的依賴參數 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; }
通過以上代碼我們可以看出:
分析源碼:回答上面的問題:
附:非標準中間件的用法
短路中間件、 分叉中間件、條件中間件
整個處理管道的形成,存在一些管道分叉或者臨時插入中間件的行為,一些重要方法可供使用
聲明:本網頁內容旨在傳播知識,若有侵權等問題請及時與本網聯(lián)系,我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com