asp.net core 系列 7 Razor框架路由(上)
一.概述
在上二篇中，主要是介紹了asp.net core mvc中路由的使用，這篇繼續介紹路由在ASP.NET Core Razor中的使用。Razor Pages應該使用預設的傳統路由，從應用程式的Pages資料夾中提供命令資源。還可以使用其他約定來自定義 Razor Pages 路由行為。
在ASP.NET Core MVC 中是使用路由中介軟體來匹配傳入請求的 URL 並將它們對映到操作(action)。而ASP.NET Core Razor使用頁面路由和應用模型提供程式約定,來控制 Razor 頁面應用中的頁面路由、發現和處理。
使用AddRazorPagesOptions 擴充套件方法向 Startup 類中服務集合的 AddMvc 服務中新增和配置 Razor 頁面約定。
services.AddMvc() .SetCompatibilityVersion(CompatibilityVersion.Version_2_2) .AddRazorPagesOptions(options=> { //新增razor頁面路由和應用模型約定 //options.Conventions.Add(); });
在ASP.NET Core 的 Razor框架頁面中,路由和應用的約定有四大類。都需要實現IPageConvention介面。在MVC框架下路由需要實現IRouteBuilder介面。
(1) 模型約定 Conventions.Add
通過Conventions.Add新增的模型約定(Model conventions)。作用是：將路由模板和標頭(page header)新增到應用的頁面。模型約定有三種實現的介面IPageRouteModelConvention(路由模型約定)、IPageApplicationModelConvention(應用模型約定)、IPageHandlerModelConvention(處理程式模型約定)。
(2) 頁面路由操作約定 Page route action conventions
通過頁面路由操作約定。作用是：可以將路由模板新增到某個資料夾中的頁面以及單個頁面。AddFolderRouteModelConvention(資料夾路由模型約定)、AddPageRouteModelConvention(頁面路由模型約定)AddPageRoute(配置頁面路由)
(3) 頁面模型操作約定 Page model action conventions
通過頁面模型操作約定。作用是：可以將標頭新增到某個資料夾中的多個頁面，將標頭新增到單個頁面，以及配置篩選器工廠以將標頭新增到應用的頁面
AddFolderApplicationModelConvention(資料夾應用模型約定) AddPageApplicationModelConvention(頁面應用模型約定) ConfigureFilter(配置篩選器)
二. 模型約定
為IPageConvention新增委託，以新增應用於 Razor 頁面的模型約定。
2.1 IPageRouteModelConvention
將路由模型約定新增到所有頁面。使用約定建立IPageRouteModelConvention並將其新增到IPageConvention例項集合中，這些例項將在頁面路由模型構造過程中應用。下面示例應用將 {globalTemplate?} 路由模板新增到應用中的所有頁面。
/// <summary> /// 只在程式啟動時呼叫(每頁面路由對應執行一次apply) /// </summary> public class GlobalTemplatePageRouteModelConvention : IPageRouteModelConvention { ///<summary> ///運用到所有頁面路由模型中，制定頁面路由模板,比如訪問index頁。 ///路由模板可以是/index 也可以是/index/{可選引數} ///</summary> ///<param name="model"></param> public void Apply(PageRouteModel model) { var selectorCount = model.Selectors.Count; for (var i = 0; i < selectorCount; i++) { var selector = model.Selectors[i]; model.Selectors.Add(new SelectorModel { AttributeRouteModel = new AttributeRouteModel { //執行路由順序 Order = 1, //頁面路由模板 Template = AttributeRouteModel.CombineTemplates(selector.AttributeRouteModel.Template,"{globalTemplate?}") } }); } } }
將 MVC 新增到Startup.ConfigureServices中的服務集合時，會新增 Razor 頁面選項，例如：新增上面的約定。
services.AddMvc() .AddRazorPagesOptions(options => { options.Conventions.Add(new GlobalTemplatePageRouteModelConvention()); }) .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
在about頁繫結 @RouteData.Values["globalTemplate"]。如果在瀏覽器訪問: /about/globalRouteValue時,頁面顯示:route data for'globalTemplate'wasprovided:globalRouteValue。
在上面案例的路由模型約定的PageRouteModel例項中，在除錯下檢視about的路由規則生成如下： model.Selectors[1].AttributeRouteModel.Template的值為：
About/{globalTemplate?}
2.2 IPageApplicationModelConvention
將應用模型約定新增到所有頁面。使用約定建立IPageApplicationModelConvention並將其新增到IPageConvention例項集合中，這些例項將在頁面應用模型構造過程中應用。
為了演示此約定，示例應用包含了一個 AddHeaderAttribute 類。 類建構函式採用 name 字串和 values 字串陣列。 將在其 OnResultExecuting 方法中使用這些值來設定響應標頭。使用 AddHeaderAttribute 類將標頭 GlobalHeader 新增到應用中的所有頁面。
///<summary> ///頁面載入時呼叫(每一個路由地址) ///</summary> public class GlobalHeaderPageApplicationModelConvention : IPageApplicationModelConvention { public void Apply(PageApplicationModel model) { model.Filters.Add(new AddHeaderAttribute( "GlobalHeader", new string[] { "Global Header Value" })); } } public class AddHeaderAttribute : ResultFilterAttribute { private readonly string _name; private readonly string[] _values; public AddHeaderAttribute(string name, string[] values) { _name = name; _values = values; } public override void OnResultExecuting(ResultExecutingContext context) { context.HttpContext.Response.Headers.Add(_name, _values); base.OnResultExecuting(context); } }
services.AddMvc() .AddRazorPagesOptions(options => { options.Conventions.Add(new GlobalTemplatePageRouteModelConvention()); options.Conventions.Add(new GlobalHeaderPageApplicationModelConvention()); }) .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
在 /About 中請求示例的“關於”頁面，並檢查標頭以檢視結果：
2.3 IPageHandlerModelConvention
將處理程式模型約定新增到的所有頁面。使用約定建立IPageHandlerModelConvention並將其新增到IPageConvention例項集合中，這些例項將在頁面處理程式模型構造過程中應用。
public class GlobalPageHandlerModelConvention : IPageHandlerModelConvention { //頁面載入時呼叫(每一個路由地址)，在IPageApplicationModelConvention約定之後執行 public void Apply(PageHandlerModel model) { //目前還不清楚能做什麼 } }
services.AddMvc() .AddRazorPagesOptions(options => { options.Conventions.Add(new GlobalTemplatePageRouteModelConvention()); options.Conventions.Add(new GlobalHeaderPageApplicationModelConvention()); options.Conventions.Add(new GlobalPageHandlerModelConvention()); }) .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
三. 頁面路由操作約定
預設路由模型提供程式派生自IPageRouteModelProvider，可呼叫旨在為頁面路由配置提供擴充套件點的約定。
3.1 AddFolderRouteModelConvention
使用AddFolderRouteModelConvention建立並新增IPageRouteModelConvention，後者可以為指定資料夾下的所有頁面呼叫PageRouteModel上的操作。示例應用使用
AddFolderRouteModelConvention 將 {otherPagesTemplate?} 路由模板新增到 OtherPages 資料夾中的頁面：
options.Conventions.AddFolderRouteModelConvention("/OtherPages", model => { //OtherPages資料夾下的頁面，都用此路由模板。 var selectorCount = model.Selectors.Count; for (var i = 0; i < selectorCount; i++) { var selector = model.Selectors[i]; model.Selectors.Add(new SelectorModel { AttributeRouteModel = new AttributeRouteModel { //用於處理路由匹配,指定路由處理順序。按順序處理的路由 (-1、 0、 1、 2、 … n) Order = 2, Template = AttributeRouteModel.CombineTemplates (selector.AttributeRouteModel.Template,"{otherPagesTemplate?}") } }); } });
這裡將AttributeRouteModel的 Order 屬性設定為 2。在第一個路由資料值時(如:/page1/RouteDataValue，這裡的RouteDataValue就是第一個路由資料值)，可以保證之前模板{globalTemplate?}分配到優先順序。
當globalTemplate路由模板Order=1，otherPagesTemplate路由模板Order=2時。在瀏覽器輸入 :/OtherPages/Page1/RouteDataValue。路由值由globalTemplate模板取出。
RouteData.Values["otherPagesTemplate"] null RouteData.Values["globalTemplate"] "RouteDataValue"
3.2 AddPageRouteModelConvention
使用AddPageRouteModelConvention建立並新增IPageRouteModelConvention，後者可以為具有指定名稱的頁面呼叫PageRouteModel上的操作。
示例應用使用AddPageRouteModelConvention將 {aboutTemplate?} 路由模板新增到“About”頁面：
options.Conventions.AddPageRouteModelConvention("/About", model => { //About頁面,用此路由模板。 var selectorCount = model.Selectors.Count; for (var i = 0; i < selectorCount; i++) { var selector = model.Selectors[i]; model.Selectors.Add(new SelectorModel { AttributeRouteModel = new AttributeRouteModel { Order = 2, Template = AttributeRouteModel.CombineTemplates (selector.AttributeRouteModel.Template, "{aboutTemplate?}") } }); } });
這個功能就不在演示，功能與示例3.1相同，一個作用於資料夾下的所有pages頁面，一個作用於指定某個page頁面。重點關注三點：1是路由作用域，2是order路由順序，3是定義好Template路由規則。
參考文獻
官方資料:asp.net core routing