ASP.NET Core中三个egg疼的路由函数

2021-12-03 08:17:47 浏览数 (1)

端点路由app.UseEndpoints强调的是端点和路由,它的核心目的是将请求落地点与路由寻址方式解耦。在这里面有几个比较容易混淆的函数:

  • MapControllerRoute
  • MapDefaultControllerRoute
  • MapControllers

我相信很多开发人员不清楚它们有什么不同,以及该在什么时候用哪个。那么下面我们就来学习一下吧。

  1. MapControllerRoute 它的官方定义是这样的,将控制器操作的终结点添加到Microsoft.AspNetCore.Routing.IEndpointRouteBuilder里,并指定具有给定名称、模式、默认值、约束和 dataTokens 的路由。 conventional routing(约定路由), 通常是用在MVC项目中的,需要向它传递name pattern defaults constraints dataTokens 参数。在项目中可以这样写:
代码语言:javascript复制
endpoints.MapControllerRoute(
  name:"default",
  pattern:"{controller=Home}/{action=index}/{id?}"
);

当请求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,这样就是特性路由。

  1. MapDefaultControllerRoute 官方的定义是这样的:将控制器操作的终结点添加到Microsoft.AspNetCore.Routing.IEndpointRouteBuilder中,并添加默认路由 {controller=Home}/{action=Index}/{id?}。 endpoints.MapDefaultControllerRoute()是上面约定路由的默认样例.
  2. MapControllers 官方定义是这样的:将控制器操作的终结点添加到 Microsoft.AspNetCore.Routing.IEndpointRouteBuilder中,并且不指定任何路由。不对约定路由做任何假设,也就是说不使用约定路由,而是依赖用户的特性路由, 它一般用在WebAPI项目中。

全文梳理就会发现: 官方英文描述屡次出现的route,其实特指的是约定路由。

这样的描述我其实是不苟同的:

路由在.NET里面, 已经被普世认定为“约定路由”和“特性路由”,基于这种认知,我读了好几遍官方英文描述,其实没读出个所以然的。

官方英文描述使用 “route”来特指“约定路由”会误导开发者。

0 人点赞