asp.net core 系列 7 Razor框架路由(上)

時間  2019-11-12
標籤 asp.net asp core 系列 razor 框架 路由 欄目 ASP 简体版
原文   原文鏈接

一.概述

　　在上二篇中，主要是介紹了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 頁面約定。mvc

services.AddMvc()
                .SetCompatibilityVersion(CompatibilityVersion.Version_2_2)
                .AddRazorPagesOptions(options=> {

                     //添加razor頁面路由和應用模型約定
                    //options.Conventions.Add();
                });

在ASP.NET Core 的 Razor框架頁面中,路由和應用的約定有四大類。都須要實現IPageConvention接口。在MVC框架下路由須要實現IRouteBuilder接口。app

　　(1) 模型約定 Conventions.Add框架

　　　　經過Conventions.Add添加的模型約定(Model conventions)。做用是：將路由模板和標頭(page header)添加到應用的頁面。模型約定有三種實現的接口IPageRouteModelConvention(路由模型約定)、IPageApplicationModelConvention(應用模型約定)、IPageHandlerModelConvention(處理程序模型約定)。asp.net

 

　　(2)  頁面路由操做約定  Page route action conventionside

　　　　經過頁面路由操做約定。做用是：能夠將路由模板添加到某個文件夾中的頁面以及單個頁面。AddFolderRouteModelConvention(文件夾路由模型約定)、AddPageRouteModelConvention(頁面路由模型約定)AddPageRoute(配置頁面路由)函數

 

　　(3) 頁面模型操做約定 Page model action conventionsui

　　　　經過頁面模型操做約定。做用是：能夠將標頭添加到某個文件夾中的多個頁面，將標頭添加到單個頁面，以及配置篩選器工廠以將標頭添加到應用的頁面　　spa

AddFolderApplicationModelConvention(文件夾應用模型約定) AddPageApplicationModelConvention(頁面應用模型約定) ConfigureFilter(配置篩選器)

 

　　(4) 默認頁面應用模型提供程序 Default page app model provider

　　　　用戶能夠從默認模型提供程序繼承，以便爲處理程序發現和處理提供本身的實現邏輯 。

二. 模型約定

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
                                    {
                                        //用於處理路由匹配,指定路由處理順序。按順序處理的路由 (-一、 0、 一、 二、 … 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

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程