ASP.NET Core3.X 終端中間件轉(zhuǎn)換為端點路由運行詳解
引言
前幾天.NET Core3.1發(fā)布,于是我把公司一個基礎(chǔ)通用系統(tǒng)升級了,同時刪除了幾個基礎(chǔ)模塊當然這幾個基礎(chǔ)模塊與.NET Core3.1無關(guān),其中包括了支付模塊,升級完后靜文(同事)問我你把支付刪除了?。课艺f是啊,沒考慮好怎么加上(感覺目前不太好,我需要重新設(shè)計一下)。
故事從這開始
考慮支付的時候我考慮的是將支付sdk如何直接引入到系統(tǒng),以及可以有一系列支付的路由,我需要考慮的是如果創(chuàng)建響應(yīng)給指定的地址,so我開始想如何達到我的目的自定義個中間件,Use、Run、Map???
路由的進階
路由負責將請求 URI 映射到終結(jié)點并向這些終結(jié)點調(diào)度傳入的請求。 路由在應(yīng)用中定義,并在應(yīng)用啟動時進行配置。 路由可以選擇從請求包含的 URL 中提取值,然后這些值便可用于處理請求。 通過使用應(yīng)用中的路由信息,路由還能生成映射到終結(jié)點的 URL。
在ASP.NET Core 2.1和更低版本中,路由是通過實現(xiàn)將IRouter傳入的URL映射到處理程序的接口來處理的。通常,將直接依賴MvcMiddleware添加到中間件管道末端的實現(xiàn),而不是直接實現(xiàn)該接口。一旦請求到達MvcMiddleware,便會應(yīng)用路由來確定傳入請求URL路徑所對應(yīng)的控制器和操作。
然后,該請求在執(zhí)行處理程序之前經(jīng)過了各種MVC篩選器。這些過濾器形成了另一條“管道”,讓人聯(lián)想到中間件管道,并且在某些情況下必須復(fù)制某些中間件的行為。一個典型的例子就是CORS政策。為了對每個MVC操作以及中間件管道的其他“分支”實施不同的CORS策略,內(nèi)部需要進行一定程度的重復(fù)。
“分支”中間件管道通常用于“偽路由”。如Map()在中間件管道中的擴展方法,將允許您在傳入路徑具有給定前綴時有條件地執(zhí)行某些中間件。
如下所示:
app.Map("/order", app => app.Run(async context => { await context.Response.WriteAsync("Order"); }) );
在這種情況下,該Run()方法是“終端”中間件,因為它返回響應(yīng)。但是從某種意義上說,整個Map分支對應(yīng)于應(yīng)用程序的“端點”.
在ASP.NET Core 2.2中,引入了終結(jié)點路由作為MVC控制器的新路由機制。此實現(xiàn)本質(zhì)上是的內(nèi)部實現(xiàn)MvcMiddleware .
在ASP.NET Core 2.x中使用Map()
下面我們自定義一個中間件,該中間件返回直接返回一個相應(yīng)而不是繼續(xù)往下執(zhí)行調(diào)用_next委托,一個很基本的中間件。
public class ApiEndpointMiddleware { private readonly RequestDelegate _next; public ApiEndpointMiddleware(RequestDelegate next) { _next = next; } public async Task InvokeAsync(HttpContext context) { context.Response.StatusCode = 200; await context.Response.WriteAsync("Order"); } }
在ASP.NET Core 2.x中,可以通過使用擴展方法指定路由訪問該中間件,從而將其包含在Startup.cs的中間件管道中
public void Configure(IApplicationBuilder app) { app.UseStaticFiles(); app.Map("/order", app => app.UseMiddleware<ApiEndpointMiddleware>()); versionApp.UseMiddleware<VersionMiddleware>()); app.UseMvcWithDefaultRoute(); }
當我們訪問 /order 或者 /order/1 路由都會得到自定義中間件返回的相應(yīng)。
將中間件轉(zhuǎn)換為端點路由
在ASP.NET Core 3.0中,我們使用端點路由,因此路由步驟與端點的調(diào)用是分開的。實際上,這意味著我們有兩個中間件:
- EndpointRoutingMiddleware 實際的路由,即計算將為指定的請求URL路徑調(diào)用哪個端點。
- EndpointMiddleware 所有調(diào)用的端點。
它們在中間件管道中的兩個不同點處添加,因為它們起著兩個不同的作用。一般而言,我們想的是路由中間件提前在管道中,以便后續(xù)的中間件可以訪問有關(guān)將執(zhí)行的端點的信息。端點的調(diào)用應(yīng)在管道的末端進行。
如下所示:
public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } app.UseHttpsRedirection(); app.UseRouting(); app.UseAuthorization(); app.UseEndpoints(endpoints => { endpoints.MapControllers(); }); }
該UseRouting()擴展方法添加EndpointRoutingMiddleware到管道,同時將UseEndpoints()擴展方法添加EndpointMiddleware到管道。UseEndpoints()實際上為應(yīng)用程序注冊所有端點的位置。
那么如何將我們自定義中間件使用端點路由來映射呢?
從概念上講,我們UseEndpoints()使用/OrderURL作為匹配的路徑,將“order”端點的注冊移動到調(diào)用中:
endpoints.MapControllers(); endpoints.Map("/order",endpoints.CreateApplicationBuilder() .UseMiddleware<ApiEndpointMiddleware>().Build()).WithDisplayName("order-api");
在我們上面針對ASP.NET Core 2.x的實現(xiàn)中,我們將匹配/order,/order/123等端點路由
例如:
endpoints.Map("/order/{action}",null);
這將同時匹配 /order /order/1,但不匹配/order/status/1。它比以前的版本功能強大得多.
在上一個示例中,我們提供了一個顯示名稱(主要用于調(diào)試目的),但是我們可以附加其他的信息,例如授權(quán)策略或CORS策略,其他中間件可以查詢這些信息。例如:
app.UseEndpoints(endpoints => { endpoints.MapControllers(); endpoints.Map("/order/{action}",endpoints.CreateApplicationBuilder() .UseMiddleware<ApiEndpointMiddleware>().Build()).WithDisplayName("order-api").RequireCors("AllowAllHosts") .RequireAuthorization("AdminOnly"); });
我們向端點添加了CORS策略(AllowAllHosts)和授權(quán)策略(AdminOnly)。當?shù)竭_端點的請求到達時,并在執(zhí)行端點之前采取相應(yīng)的措施。
參考
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- ASP.NET Core應(yīng)用錯誤處理之DeveloperExceptionPageMiddleware中間件呈現(xiàn)“開發(fā)者異常頁面”
- ASP.NET Core中間件初始化的實現(xiàn)
- 詳解ASP.NET Core 中基于工廠的中間件激活的實現(xiàn)方法
- 在 asp.net core 的中間件中返回具體的頁面的實現(xiàn)方法
- ASP.NET Core自定義中間件如何讀取Request.Body與Response.Body的內(nèi)容詳解
- ASP.NET Core 應(yīng)用程序中的靜態(tài)文件中間件的實現(xiàn)
- 詳解在ASP.NET Core中如何編寫合格的中間件
- .net core webapi通過中間件獲取請求和響應(yīng)內(nèi)容的方法
- 利用.net core實現(xiàn)反向代理中間件的方法
- .net core異常中間件的使用
相關(guān)文章
URL重寫及干掉ASP.NET試圖狀態(tài)的實現(xiàn)方法
URL重寫已經(jīng)很普遍了,但基本上大部分的URL重寫都不支持頁面的相對路徑,所有如果想在已經(jīng)開發(fā)好的項目中添加還是有壓力的,第二就是例如微軟的那個URL重寫是根據(jù)正則表達式來處理的,那樣是很好,但也有不足之處,就是不方便定位到某個頁面只能有哪些參數(shù)2011-11-11ASP.NET?Core實現(xiàn)動態(tài)審計日志功能
這篇文章主要為大家詳細介紹了如何通過ASP.NET?Core設(shè)計和實現(xiàn)一個靈活、可擴展的審計日志系統(tǒng),同時保持對主業(yè)務(wù)邏輯的最小化干擾,需要的可以參考下2024-03-03