最新文章專題視頻專題問答1問答10問答100問答1000問答2000關(guān)鍵字專題1關(guān)鍵字專題50關(guān)鍵字專題500關(guān)鍵字專題1500TAG最新視頻文章推薦1 推薦3 推薦5 推薦7 推薦9 推薦11 推薦13 推薦15 推薦17 推薦19 推薦21 推薦23 推薦25 推薦27 推薦29 推薦31 推薦33 推薦35 推薦37視頻文章20視頻文章30視頻文章40視頻文章50視頻文章60 視頻文章70視頻文章80視頻文章90視頻文章100視頻文章120視頻文章140 視頻2關(guān)鍵字專題關(guān)鍵字專題tag2tag3文章專題文章專題2文章索引1文章索引2文章索引3文章索引4文章索引5123456789101112131415文章專題3
問答文章1 問答文章501 問答文章1001 問答文章1501 問答文章2001 問答文章2501 問答文章3001 問答文章3501 問答文章4001 問答文章4501 問答文章5001 問答文章5501 問答文章6001 問答文章6501 問答文章7001 問答文章7501 問答文章8001 問答文章8501 問答文章9001 問答文章9501
當(dāng)前位置: 首頁 - 科技 - 知識(shí)百科 - 正文

探究ASP.NET Core Middleware實(shí)現(xiàn)方法

來源:懂視網(wǎng) 責(zé)編:小采 時(shí)間:2020-11-27 22:34:36
文檔

探究ASP.NET Core Middleware實(shí)現(xiàn)方法

探究ASP.NET Core Middleware實(shí)現(xiàn)方法:概念 ASP.NET Core Middleware是在應(yīng)用程序處理管道pipeline中用于處理請(qǐng)求和操作響應(yīng)的組件。 每個(gè)組件: 在pipeline中判斷是否將請(qǐng)求傳遞給下一個(gè)組件 在處理管道的下個(gè)組件執(zhí)行之前和之后執(zhí)行一些工作, HttpContxt對(duì)象能跨域請(qǐng)求、響應(yīng)的執(zhí)行周
推薦度:
導(dǎo)讀探究ASP.NET Core Middleware實(shí)現(xiàn)方法:概念 ASP.NET Core Middleware是在應(yīng)用程序處理管道pipeline中用于處理請(qǐng)求和操作響應(yīng)的組件。 每個(gè)組件: 在pipeline中判斷是否將請(qǐng)求傳遞給下一個(gè)組件 在處理管道的下個(gè)組件執(zhí)行之前和之后執(zhí)行一些工作, HttpContxt對(duì)象能跨域請(qǐng)求、響應(yīng)的執(zhí)行周

概念

ASP.NET Core Middleware是在應(yīng)用程序處理管道pipeline中用于處理請(qǐng)求和操作響應(yīng)的組件。

每個(gè)組件:

  • 在pipeline中判斷是否將請(qǐng)求傳遞給下一個(gè)組件
  • 在處理管道的下個(gè)組件執(zhí)行之前和之后執(zhí)行一些工作, HttpContxt對(duì)象能跨域請(qǐng)求、響應(yīng)的執(zhí)行周期
  • 特性和行為

    ASP.NET Core處理管道由一系列請(qǐng)求委托組成,一環(huán)接一環(huán)的被調(diào)用, 下面給出自己繪制的Middleware pipeline流程圖:

    從上圖可以看出,請(qǐng)求自進(jìn)入處理管道,經(jīng)歷了四個(gè)中間件,每個(gè)中間件都包含后續(xù)緊鄰中間件 執(zhí)行委托(next)的引用,同時(shí)每個(gè)中間件在交棒之前和交棒之后可以自行決定參與一些Http請(qǐng)求和響應(yīng)的邏輯處理。

    每個(gè)中間件還可以決定不將請(qǐng)求轉(zhuǎn)發(fā)給下一個(gè)委托,這稱為請(qǐng)求管道的短路(短路是有必要的,某些專有中間件比如 StaticFileMiddleware 可以在完成功能之后,避免請(qǐng)求被轉(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對(duì)象
     {
     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>();
     }
     // 啟用該中間件,也就是注冊(cè)該中間件
     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;
    }

    通過以上代碼我們可以看出:

  • 注冊(cè)中間件的過程實(shí)際上,是給一個(gè) Type= List<Func<RequestDelegate, RequestDelegate>> 的容器依次添加元素的過程;
  • 容器中每個(gè)元素對(duì)應(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)系
  • 分析源碼:回答上面的問題:

    1. 使用反射構(gòu)造中間件的時(shí)候,第一個(gè)參數(shù)Array[0] 是下一個(gè)中間件的執(zhí)行委托
    2. 當(dāng)前中間件執(zhí)行委托 函數(shù)名稱被限制為: Invoke/InvokeAsync, 函數(shù)支持傳入除HttpContext之外的參數(shù)
    3. 按照代碼順序添加進(jìn)入 _components容器, 通過后一個(gè)中間件的執(zhí)行委托 -----(指向)----> 前一個(gè)中間件的輸入執(zhí)行委托建立鏈?zhǔn)疥P(guān)系。

    附:非標(biāo)準(zhǔn)中間件的用法

    短路中間件、 分叉中間件、條件中間件

    整個(gè)處理管道的形成,存在一些管道分叉或者臨時(shí)插入中間件的行為,一些重要方法可供使用

  • Use方法是一個(gè)注冊(cè)中間件的簡便寫法
  • Run方法是一個(gè)約定,一些中間件使用Run方法來完成管道的結(jié)尾
  • Map擴(kuò)展方法:請(qǐng)求滿足指定路徑,將會(huì)執(zhí)行分叉管道,強(qiáng)調(diào)滿足 path
  • MapWhen方法:HttpContext滿足條件,將會(huì)執(zhí)行分叉管道:
  • UseWhen方法:HttpContext滿足條件 則插入中間件
  • 聲明:本網(wǎng)頁內(nèi)容旨在傳播知識(shí),若有侵權(quán)等問題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系,我們將在第一時(shí)間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com

    文檔

    探究ASP.NET Core Middleware實(shí)現(xiàn)方法

    探究ASP.NET Core Middleware實(shí)現(xiàn)方法:概念 ASP.NET Core Middleware是在應(yīng)用程序處理管道pipeline中用于處理請(qǐng)求和操作響應(yīng)的組件。 每個(gè)組件: 在pipeline中判斷是否將請(qǐng)求傳遞給下一個(gè)組件 在處理管道的下個(gè)組件執(zhí)行之前和之后執(zhí)行一些工作, HttpContxt對(duì)象能跨域請(qǐng)求、響應(yīng)的執(zhí)行周
    推薦度:
    標(biāo)簽: 實(shí)現(xiàn) net core
    • 熱門焦點(diǎn)

    最新推薦

    猜你喜歡

    熱門推薦

    專題
    Top