asp.net core 3.x Endpoint終結點路由1-基本介紹和使用
前言
我是從.net 4.5直接跳到.net core 3.x的,感覺asp.net這套東西最初是從4.5中的owin形成的。
目前官方文件重點是講路由,沒有特別說明與傳統路由的區別,本篇主要介紹終結點路由的相關概念和如何使用,不會詳細介紹路由,這個參考官方文件就ok了。如果將來有機會研究到底層再深度剖析。
參考:
https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/routing?view=aspnetcore-3.1
https://q.cnblogs.com/q/113644/
https://aregcode.com/blog/2019/dotnetcore-understanding-aspnet-endpoint-routing/
概述
最初我們訪問 http://www.abc.com/a.aspx時,服務端是存在a.aspx這個檔案的,服務端根據此檔案幫我們建立一個對應類的例項處理請求。
後來需求越來越複雜,出現了路由,目的是將請求地址與執行請求的處理器的直接關聯,變成對映關聯,對映規則由我們自己配置。
在asp.net core 3.x之前這個路由系統是包含在mvc內部的,.net framework時代有個特殊的HttpModule來實現mvc,路由系統也包含其中。.net core是由有個特殊的中介軟體來實現mvc的,路由系統就包含在這個中介軟體中。
這種方式有個問題,mvc只是一箇中間件,路由系統包含在其中,如果我們希望在mvc中介軟體之後加入其它中介軟體,其它中介軟體是無法(也許是不方便)訪問路由相關資訊的。
因此出現了終結點路由,我們說路由的根本目的是將使用者請求地址,對映為一個請求處理器,最簡單的請求處理器可以是一個委託 Func<HttpCotnext,Task>,也可以是mvc/webapi中某個controller的某個action,所以從抽象的角度講 一個終結點 就是一個處理請求的委託。由於mvc中action上還有很多attribute,因此我們的終結點還應該提供一個集合,用來儲存與此請求處理委託的關聯資料。
- 在程式啟動前我們應該定義好程式中有哪些終結點,當然不是我們手動一個個定義,而是根據目標框架自動生成,針對mvc來說的話可以自動將程式中與路由匹配的action轉換成對應的終結點,其它框架應該也有對應的方式,反正最終我們所有用來處理請求的東東都變成了終結點。這步是在定義路由時自動完成的
- 除了定義終結點我們還要定義 請求路徑 與 終結點的對應關係,將來請求抵達時才能匹配找到合適的終結點來處理我們的請求,這步相當於定義路由
- 我們還需要定義一個解析器,當請求抵達時根據終結點與路徑的對應關係找到終結點,微軟已定義好對應的中介軟體來表示這個解析器。
- 最後我們需要定義一箇中間件,在上面的中介軟體執行後 我們可以拿到與當前請求匹配的終結點,最終呼叫它的委託處理請求,這個中介軟體就是mvc中介軟體
- 到此asp.net core 3.x的中介軟體路由預設差不多就這樣了,此時我們可以定義自己的中介軟體,放在步驟3後面,拿到終結點做一些高階處理。微軟定義的一些中介軟體也是這個套路
如何使用
在通過vs預設模板建立asp.net core 3.x專案時,在startup中會看到這樣的程式碼
1 app.UseRouting(); 2 app.UseEndpoints(endpoints => { 3 endpoints.MapControllerRoute( 4 name: "default", 5 pattern: "{controller=Home}/{action=Index}/{id?}"); 6 });
註冊路由
看程式碼的第2行。它有如下3個任務
- 建立終結點定義,針對mvc來說會自動將程式中與路由格式匹配上的action轉換為終結點。在第5行之後可以除錯觀察endpoints.DataSource屬性,生成好的終結點就在裡面
- 建立url與終結點的對應關係,這種關係存在哪?我也不曉得
- 註冊mvc中介軟體(它在將來請求抵達,且之前有中介軟體解析得到與當前請求匹配的終結點後,開始mvc旅程)
這裡路由跟以前的寫法差不多,上面預設值啊、約束啊就去看官方文件吧。
建立終結點也會參照屬性路由,微軟推薦webapi使用屬性路由,mvc使用傳統路由。你會看到建立預設webapi專案時這樣的 endpoints.MapControllers();
終結點進一步定製
預設情況下是根據定義的路由去找到匹配的action最後生成終結點,這個生成終結點的過程我們是可以參與的,具體辦法是通過endpoints.MapControllerRoute的返回物件上呼叫相關擴充套件方法,本質上是向終結點的建立過程加入一些委託,將來建立終結點時,這些委託將被呼叫,程式碼如下:
1 endpoints.MapControllerRoute( 2 name: "default", 3 pattern: "{controller=Home}/{action=Index}/{id?}").Add(endpointBuilder=> { 4 //通過endpointBuilder獲取與action關聯的資料,比如attribute和其它元資料 5 //通過endpointBuilder插入我們向放進終結點的資料 6 });
動態路由
app.UseEndpointsmvc時就說明了使用mvc和webapi了,預設情況下一個action會建立一個對應的終結點,請求抵達時匹配到終結點就直接執行了。但有時候我們希望自己控制一個請求過來時使用哪個controller的哪個action,具體做法:
定義一個類,繼承DynamicRouteValueTransformer,並註冊到ioc容器中,最後呼叫一個擴充套件方法,看程式碼:
1 class MyRouteValueTransformer : DynamicRouteValueTransformer 2 { 3 public override ValueTask<RouteValueDictionary> TransformAsync(HttpContext httpContext, RouteValueDictionary values) 4 { 5 //通過values可以拿到原始路由資料 6 //可以替換或加入新的資料 7 values.Add("controller", "jj"); 8 values.Add("action", "kkk"); 9 return new ValueTask<RouteValueDictionary>(values); 10 } 11 } 12 13 public void ConfigureServices(IServiceCollection services) 14 { 15 services.AddSingleton<MyRouteValueTransformer>(); 16 services.AddControllers(); 17 } 18 19 endpoints.MapDynamicControllerRoute<MyRouteValueTransformer>("aaa/bbb/{id}");
這樣將來請求抵達時,解析得到終結點時會呼叫我們的MyRouteValueTransformer,我們可以獲取已解析得到的路有資料,然後選擇替換/增加某些路由資料,從而達到定製化
回退路由
預設情況下請求抵達時,若沒有找到匹配的終結點,就直接404了,我們希望當沒有匹配到任何終結點時直接執行某個預設的終結點,可以用如下方式:
endpoints.MapFallbackToController("{controller}/{action}/{id?}", "kkk", "jj");
當請求抵達時,如果沒有匹配到任何終結點,則預設執行jjController.kkk方法。可以想象得到此功能可能是通過動態路由實現的
還有幾個相關的擴充套件方法,有了上面的講解,估計你也能猜出是幹嘛用的了。關於路由註冊就暫時說這麼多
自定義中介軟體提前拿到終結點資料
app.UseRouting();對應概述中的步驟3,此擴充套件方法內部會註冊一箇中間件,將來請求抵達時它會幫我們找到與當前請求匹配的終結點並存儲在HttpContext中,且匹配過程中解析得到的路由資料在Request.RouteValues中。我們可以在它後面加入自己的中介軟體
1 app.UseRouting(); 2 app.Use((conttext,next)=> { 3 var endpoint = conttext.GetEndpoint();//拿到終結點 4 var routeData = conttext.Request.RouteValues;//拿到路由資料
//做些牛B的事 5 return next(); 6 });