AspNetCore中的中間件詳解
目錄
- 1 什么叫做中間件?
- 2 請求短路與中間件順序
- 3 中間件配置方法Use、Run、Map
- 3.1Use 方法配置中間件
- 3.2Run 方法配置中間件
- 3.2Map 方法配置中間件
- 4 自定義中間件
1 什么叫做中間件?
ASP.NET Core處理請求的方式看做是一個管道,中間件是組裝到應用程序管道中用來處理請求和響應的組件。通常是一個可重用的類方法
每個中間件可以:
(1)選擇是否將請求傳遞給管道中的下一個組件。
(2)可以在調用管道中的下一個組件之前和之后執行業務邏輯。
其中關于請求管道配置的一個重要方法在startup中的Configure(IApplicationBuilder app, IWebHostEnvironment env)方法。可用Use、Map、Run方法來配置需要使用的中間件。通常使用
IApplicationBuilder的拓展方法來配置請求管道,加入指定的中間件。
IApplicationBuilder Use(Func<RequestDelegate, RequestDelegate> middleware);
中間件類的本質其實是委托類
public void Configure(IApplicationBuilder app, IWebHostEnvironment env){ //判斷是否為開發環境 if (env.IsDevelopment()) {//使用異常開發頁面中間件app.UseDeveloperExceptionPage(); } //靜態文件中間件 app.UseStaticFiles(); //HTTP請求轉HTTPS請求 app.UseHttpsRedirection(); //身份驗證 app.UseAuthentication(); //相較于netcore2來說,Routing 中間件是拆分出來的,原來是屬于MVC中間件的一部分 app.UseRouting(); //端點中間件,請求處理路徑,結合Routing中間件一起使用的 app.UseEndpoints(endpoints => {//當請求"/"時,響應輸出HelloWorld【可通過lamda表達式進行配置】endpoints.MapGet("/", async context =>{ await context.Response.WriteAsync("Hello World!");});//請求路徑匹配到 /home/index/1 這種路徑時,將會到指定的handler處理器上,默認會處理到endpoints.MapControllerRoute("default","/{controller=home}/{action=index}/{id?}"); });}
2 請求短路與中間件順序
請求會按照順序依次經過每個加入管道的中間件,值得注意的是,中間件可以決定是否將請求交給下一個委托,當中間件拒絕將請求傳遞到下一個中間件時,叫做請求短路,可以避免不必要的工作。
中間件的執行與調用的順序有關,在響應式以相反的順序返回。請求在每一步都有可能短路,所以需要正確的添加中間件,如異常處理的中間件,需要放在請求管道的前面,這樣就可以一開始捕獲異常,以及后面中間件中可能發生的異常,做出返回處理。
3 中間件配置方法Use、Run、Map
ASP.NET 中的核心請求管道是通過一個個請求委托串聯而來的,具體是通過IApplicationBuilder的Use、Run、Map方法來實現的。
在講解中間件配置方法之前,需要了解什么是RequestDelegate、和代碼語言描述的中間件Func<RequestDelegate, RequestDelegate> middleware
//一個能處理請求的方法 public delegate Task RequestDelegate(HttpContext context); //中間件原生定義,委托,輸入是一個RequestDelegate,輸出也是一個RequestDelegate, Func<RequestDelegate, RequestDelegate> middleware = new Func<RequestDelegate, RequestDelegate>((RequestDelegate requestdelegate) =>{ return new RequestDelegate(async (context) => {await context.Response.WriteAsync("接收1個帶RequestDelegate類型的參數,返回RequestDelegate類型的委托"); });}); // 上述中間件的定義代碼可根據lamda表達式規則進行縮寫 Func<RequestDelegate, RequestDelegate> middleware = new Func<RequestDelegate, RequestDelegate>((RequestDelegate requestdelegate) =>{ return new RequestDelegate(async (context) => {await context.Response.WriteAsync("接收1個帶RequestDelegate類型的參數,返回RequestDelegate類型的委托"); });}); Func<RequestDelegate, RequestDelegate> middleware = (request=>{return new RequestDelegate(async (context) => {await context.Response.WriteAsync("接收1個帶RequestDelegate類型的參數,返回RequestDelegate類型的委托"); }); });
3.1Use 方法配置中間件
//增加中間件到請求管道中IApplicationBuilder Use(Func<RequestDelegate, RequestDelegate> middleware);
Use 擴展可以使用兩個重載:
一個重載采用 HttpContext 和 Func < Task >。 不使用任何參數調用 Func< Task >。
app.Use(async (context, next) => {await context.Response.WriteAsync(" Rquest The first middleware");//調用下一個中間件await next.Invoke();await context.Response.WriteAsync(" Response The first middleware"); });
另一個重載采用 HttpContext 和 RequestDelegate。 通過傳遞 HttpContext 調用 RequestDelegate。
優先使用后面的重載,因為它省去了使用其他重載時所需的兩個內部每請求分配。
app.Use(next => { return new RequestDelegate(async context => { await context.Response.WriteAsync(" Rquest The first middleware"); await next.Invoke(context); await context.Response.WriteAsync(" Response The first middleware"); }); } );
上面兩種方法實現的功能一致。值得注意的是,next參數表示管道中的下一個中間件。通過不調用下一個中間件,會導致請求短路或中斷,所以需要謹慎的選擇是否需要調用下一個中間件。
3.2Run 方法配置中間件
public static void Run(this IApplicationBuilder app, RequestDelegate handler);
Run 方法配置請求管道時,會使得請求管道短路,因為它不調用下一個請求。因此Run方法一般只在管道的底部使用。
app.Run( async context=> {await context.Response.WriteAsync(" Rquest The final middleware"); });
3.2Map 方法配置中間件
//pathMatch 請求路徑匹配字符串//configuration 符合匹配規則時采取的 請求處理邏輯.//configuration 是一個無返回,請求參數類型為 IApplicationBuilder的回調函數。public static IApplicationBuilder Map(this IApplicationBuilder app, PathString pathMatch, Action<IApplicationBuilder> configuration);
Map 方法是一種可以基于請求路徑的不同來配置分支中間件。
app.Map("/secondturl", appBuilder => { appBuilder.Run(async context => { await context.Response.WriteAsync(" the request"url is secondturl" + "\n"); }); });
且可以在嵌套使用Map方法去配置分支中間件
4 自定義中間件
雖然中間件的本質是一個Func<RequestDelegate, RequestDelegate> middleware 對象,
中間件的類型可分為兩種,下面自定義實現以及記錄請求IP地址的中間件
弱類型中間件
(1) 定義Ip中間件
public class RequestIpMiddleware {private readonly RequestDelegate requestDelegate;public RequestIpMiddleware(RequestDelegate requestDelegate) { this.requestDelegate = requestDelegate;}public async Task Invoke(HttpContext context) { context.Response.WriteAsync("The Request Ip is " + context.Request.HttpContext.Connection.RemoteIpAddress.ToString()+"\n"); //調用下一個請求中間件 await requestDelegate.Invoke(context);} }
(2)增加Use的拓展方法
/// <summary> /// 調用中間件的擴展方法 /// </summary> public static class MiddlewareExtensions {/// <summary>///this 關鍵字不能省略/// </summary>/// <param name="app"></param>/// <returns></returns>public static IApplicationBuilder UseIpMiddleware( this IApplicationBuilder app ) { return app.UseMiddleware<RequestIpMiddleware>();} }
(3)Configure方法中使用該中間件
app.UseIpMiddleware();
強類型中間件
可以在Use方法中調用這個匿名內部類,但是最好是將中間件定義成一個強類型,利于閱讀,且符合編程習慣。
IApplicationBuilder 提供了一種拓展方法來配置強類型的中間件
public static IApplicationBuilder UseMiddleware<TMiddleware>(this IApplicationBuilder app, params object[] args);
/// <summary> /// 自定義中間件 /// </summary> public class IPMiddleware : IMiddleware {/// <summary>/// IMiddleware接口定義了唯一的InvokeAsync方法,用來實現對請求的處理。/// </summary>/// <param name="context"> 當前請求上下文</param>/// <param name="next">下一個請求requestDelegate</param>/// <returns></returns>public Task InvokeAsync(HttpContext context, RequestDelegate next){ //獲取請求的IP var ip = context.Request.HttpContext.Connection.RemoteIpAddress.ToString(); context.Response.WriteAsync("IP is "+ip+"\n"); //調用下一個中間件 return next.Invoke(context);} }
值得注意的是在使用這個中間件時,需要將當前中間件注入到容器中,否則請求管道中的這個中間件無法生效。
到此這篇關于AspNetCore中的中間件詳解的文章就介紹到這了,更多相關AspNetCore中間件內容請搜索以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持!