ASP.NET Core 中三个 egg 疼的路由函数
端点路由 app.UseEndpoints 强调的是端点和路由,它的核心目的是将请求落地点与路由寻址方式解耦。在这里面有几个比较容易混淆的函数:
MapControllerRoute
MapDefaultControllerRoute
MapControllers
我相信很多开发人员不清楚它们有什么不同,以及该在什么时候用哪个。那么下面我们就来学习一下吧。
MapControllerRoute 它的官方定义是这样的,将控制器操作的终结点添加到 Microsoft.AspNetCore.Routing.IEndpointRouteBuilder 里,并指定具有给定名称、模式、默认值、约束和 dataTokens 的路由。conventional routing(约定路由), 通常是用在 MVC 项目中的,需要向它传递 name pattern defaults constraints dataTokens 参数。在项目中可以这样写:
当请求 url 满足{host}{controller_name}{action_name}{option_id}这样的格式时,将命中 Controller=controller_name Action=action_name 的方法,如果 url 没有提供 controller 和 action 名称,那么将会命中默认的 home 控制器中的 index 方法。简单地说这是 MVC 项目初期的写法,让用户发送请求的 url 去匹配 Controller 和 Action。但是约定路由并不非主流,这是因为约定路由对于用户来说并不友好,并且暴露了后端开发者定义的 Controller 和 Action 名称。而且实际上不应该让用户的 url 去匹配 Controller 和 Action 名称,应该让开发者去匹配用户想要使用的 url,这样就是特性路由。
MapDefaultControllerRoute 官方的定义是这样的:将控制器操作的终结点添加到 Microsoft.AspNetCore.Routing.IEndpointRouteBuilder 中,并添加默认路由 {controller=Home}/{action=Index}/{id?}。
endpoints.MapDefaultControllerRoute()
是上面约定路由的默认样例.MapControllers 官方定义是这样的:将控制器操作的终结点添加到 Microsoft.AspNetCore.Routing.IEndpointRouteBuilder 中,并且不指定任何路由。不对约定路由做任何假设,也就是说不使用约定路由,而是依赖用户的特性路由, 它一般用在 WebAPI 项目中。
全文梳理就会发现: 官方英文描述屡次出现的 route,其实特指的是约定路由。
这样的描述我其实是不苟同的:
路由在.NET 里面, 已经被普世认定为“约定路由”和“特性路由”,基于这种认知,我读了好几遍官方英文描述,其实没读出个所以然的。
官方英文描述使用 “route”来特指“约定路由”会误导开发者。
版权声明: 本文为 InfoQ 作者【喵叔】的原创文章。
原文链接:【http://xie.infoq.cn/article/d2eeb9212655dae128fa703d2】。未经作者许可,禁止转载。
评论