ASP.NET Core Razor 页面路由详解
在服务器端Web应用程序框架中,其中非常重要的设计是开发人员如何将URL与服务器上的资源进行匹配,以便正确的处理请求。最简单的方法是将URL映射到磁盘上的物理文件,在Razor页面框架中,ASP.NET团队就是这样实现的。
关于Razor页面框架如何将URL与文件相匹配,有一些规则您必须了解,以及如何根据需要自定义规则改变输出的结果。如果您将Razor页面与WebForm框架进行比较,您还需要了解取代的Url参数以及在URL中传递数据的机制。
规则一,Razor页面需要一个根目录。默认情况下,该根目录是Pages,位于Web应用程序项目的根目录中。您可以在Startup类的ConfigureServices方法中配置其它文件夹作为根目录。以下是将根目录更改为位于应用程序“Content”文件夹:
publicvoidConfigureServices(IServiceCollectionservices) { services .AddMvc(). AddRazorPagesOptions(options=>{ options.RootDirectory="/Content"; }); }
规则二,URL映射到Razor页面,URL不包含文件扩展名。
规则三,“Index.cshtml”是一个默认文档,这意味着如果
URL | 映射文件 | www.domain.com | /Pages/Index.cshtml | www.domain.com/index | /Pages/Index.cshtml | www.domain.com/index | /Pages/Index.cshtml | www.domain.com/account | /Pages/account.cshtml或者/Pages/account/index.cshtml |
---|
在最后一个例子中,URL映射到两个不同的文件-根目录中的“account.cshtml”、“account”文件夹中的“index.cshtml”。Razor页面框架无法识别要选择哪一个文件,因此如果您在应用程序中实际同时拥有这两个文件,那么如果您尝试浏览www.domain.com/account,会抛出如下异常:
AmbiguousActionException:Multipleactionsmatched.Thefollowingactionsmatchedroutedataandhadallconstraintssatisfied:
Page:/account/Index
Page:/account
URL传递参数
就像大多数其它框架一样,参数可以作为查询字符串在URL中传递,例如:www.domain.com/product?id=1;或者,您可以将其作为路由参数传递,因此上述示例将变为www.domain.com/product/1。URL的一部分必须映射到参数名称,在页面的路由模板来实现的,@page指令的一部分:
@page"{id}"
该模板告诉框架将页面名称之后URL的第一段作为“id”的路由参数。您可以通过多种方式访问路由参数的值。第一个是使用RouteData字典:
@page"{id}" { varproductId=RouteData.Values["id"]; }
或者,您可以向该页面的OnGet()方法添加与路由参数相同名称的参数,并将其值分配给公共属性:
@page"{id}" @{ @functions{ publicintId{get;set;} publicvoidOnGet(intid) { Id=id; } } }TheIdis@Id
如果您使用的是PageModel,那么是这样实现的:
usingMicrosoft.AspNetCore.Mvc.RazorPages; namespaceRazorPages.Pages { publicclassProductModel:PageModel { publicintId{get;set;} publicvoidOnGet(intid) { Id=id; } } }
@page"{id}" @modelProductModelTheIdis@Model.Id
最后,您可以在公有属性使用BindProperty特性,并省略该OnGet方法中的参数。Razor文件内容保持不变,但是PageModel代码略有更改:
usingMicrosoft.AspNetCore.Mvc.RazorPages; namespaceRazorPages.Pages { publicclassProductModel:PageModel { [BindProperty(SupportsGet=true)] publicintId{get;set;} publicvoidOnGet() { } } }
约束
此外,在此示例中参数的约束是它必须有一个值。URLwww.domain.com/product/apple与www.domain.com/product/21一样有效,都是可以与路由匹配。如果您希望id值为整数,则可以通过将数据类型添加到模板来指定约束:
@page"{id:int}"
现在,如果您尝试通过“apple”作为参数值,应用程序将返回404NotFound状态码。
您可以指定值不是必需的,可以将参数设置为可为空类型:
@page"{id:int?}"
如果您的应用程序允许使用“apple”作为参数值,则可以指定只允许使用A-Z和a-z的字符:
@page"{id:alpha}"
您可以与最小长度要求相结合:
@page"{id:alpha:minlength(4)}"
更多的约束信息,可以查看微软文档。
友好URL
友好的URL能够将URL映射到磁盘上的任意文件,打破根据文件名一对一的映射关系。您可以使用这个特性来不改变URL以进行SEO优化而不能重命名文件的问题,例如,如果希望所有请求由一个文件进行处理。友好URL在Startup类型的ConfigureServices方法中配置,调用RazorPagesOption类的AddPageRoute方法。以下示例将URLwww.domain.com/product映射到Razor页面“extras”文件夹“products.cshtml”文件:
publicvoidConfigureServices(IServiceCollectionservices) { services .AddMvc() .AddRazorPagesOptions(options=> { options.Conventions.AddPageRoute("/extras/products","product"); }); }
如果您在WebForms中使用过友好URL,则应注意AddPageRoute方法的参数顺序与WebFormsMapPageRoute方法相反,文件路径作为第一个参数。此外,AddPageRoute将路由模板作为第二参数,而不是路由定义,其中任何约束被单独定义。
最后一个例子说明将所有请求映射到单个文件。如果站点内容存储在特定位置(数据库,Markdown文件),并且由单个文件(例如“index.cshtml”)负责根据URL定位内容,然后将其处理为HTML,则可以执行此操作:
publicvoidConfigureServices(IServiceCollectionservices) { services .AddMvc() .AddRazorPagesOptions(options=>{ options.Conventions.AddPageRoute("/index","{*url}"); }); }
路由模板(*)通配符表示“全部”。即使使用此配置,磁盘上的现有文件和URL之间的匹配规则仍然正常运行。
总结
Razor页面中的路由系统非常直观,基于文件位置,但如果需要覆盖默认约定,它也非常强大,可配置。
原文:《RoutinginRazorPages》https://www.mikesdotnetting.com/article/310/routing-in-razor-pages
翻译:SweetTang
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。