[水煮 ASP.NET Web API2 方法论](3-2)直接式路由/属性路由

问题

怎么样可以使用更贴近资源(Controller,Action)的方式定义路由。

解决方案

可以使用属性路由直接在资源级别声明路由。只要简单的在 Action 上使用属性路由 RouteAttribute,然后传一个相关路由模板就可以。属性路由与集中式路由在路由模板含义上基本是一样的,所有路由参数应该使用花括号,同时要与使用的 Action 相匹配。直接式路由支持默认路由,可选参数,约束。详细分析请往下走。

1 [Route("api/teams/{id}")]
2 public Team GetTeam(int id)
3 {
4     //忽略逻辑
5 }

要是启用属性路由的话,需要在应用程序启动的位置,使用 HttpConfiguration 调用 MapAttributeRoutes 的扩展方法。

Config.MapHttpAttributeRoutes();

工作原理

一个叫做 Attribute Routing 的开源类库已经成为了 ASP.NET WEB API 2 架构的核心部分。随之而来的是,解决了集中式路由在维护上给我们带来的痛苦,允许我们直接在 Controller 和 Action 上声明路由。

对于大多数开发者来说,与集中式路由相比,属性路由(上面所说的直接路由)是更加自然的方法,属性路由强调的是 WEB API 资源和 URI 之间的直接关系,URI 资源应该是可以通过 HTTP 直接访问。事实上,还是有一些流行的 .NET Web 框架,例如,ServiceStack、NancyFx 都有自己的方式来定义这种贴近资源的路由(嵌入资源)。

在应用程序启动时,调用 MapHtpAtrributeRoutes,其实是告诉 ASP.NET WEB API 扫描所有 Controller 上声明的属性路由。

究其缘由,属性路由的声明和集中式路由没有太大的区别。而且,他们的路由都是被添加到与前面上一篇集中式路由代码片段 3-1 一样的路由集合中。最大的不同就是,直接式路由(属性路由)是作为单一复合路由(内部的 SubRouteCollection 类型)被添加到路由集合中的,使用的路由 key 是 MS_attributerouteWebApi。

处理每个属性路由的时候,Controller(HttpControllerDescriptor)或 Action(HttpActionDescriptor)会标记出能够访问到的属性路由。这个过程的完成是通过在这些 descriptor 类型的 Properties 字典中添加 MS_IsAttributeRouted。

属性路由提供了一些路由自定义处理。事实上,不必强制在 Controller 和 Action 上使用 RouteAttribue 声明路由。通过实现 IDirectRouteFactory,可以自定义属性路由、甚至无属性路由,集中式逻辑路由。IDirectRouteFactory 的使用 和 IDirectRouteProvider 会在后面的 3-11 篇和 6-8 篇的时候再次讨论。

代码演示

与集中式路由相反,属性路由显得很自然,直接展示了 Controller 和 Action 之间的关系,也很容易声明复杂的路由。如代码片段 3-4 例子所示。

代码片段 3-4. 声明简单的属性路由

 1 public class TeamsController : ApiController
 2 {
 3     [Route("api/teams/{id}")]
 4     public Team GetTeam(int id)
 5     {
 6         //忽略逻辑
 7     }
 8
 9     [Route("api/teams")]
10     public IEnumerable<Team> GetTeams()
11     {
12         //忽略逻辑
13     }
14
15     [Route("api/teams/{teamId}/players")]
16     public IEnumerable<Player> GetPlayers(int teamId)
17     {
18         //忽略逻辑
19     }
20 }

属性路由也允许通过 RoutePrefixAttribute 定义路由前缀。但,只能在 Controller 级别声明,修改代码片段 3-4,为这个 Controller 中所有的路由定义一个公用前缀。使用 RoutePrefixAttribute 重写,如代码片段 3-5 所示。需要注意的是,当路由被显示的时候,所有在 Action 上指定的 RouteAttribute 是路由模板的一部分,被拼接在 RoutePrefixAttribute 之后。

代码片段 3-5. 属性路由和路由前缀

 1 [RoutePrefix("api/teams")]
 2 public class TeamsController : ApiController
 3 {
 4     [Route("{id}")]
 5     public Team GetTeam(int id)
 6     {
 7         // 忽略逻辑
 8     }
 9
10     [Route]
11     public IEnumerable<Team> GetTeams()
12     {
13         // 忽略逻辑
14     }
15
16     [Route("{teamId}/players")]
17     public IEnumerable<Player> GetPlayers(int teamId)
18     {
19         // 忽略逻辑
20     }
21 }

与集中式路由相同的是,属性路由也是依赖 HTTP 谓词分发。所以,由于对路由定义命名的约定(上一篇描述了 HTTP 谓词分发),代码片段 3-4 和 3-5 只能处理 HTTP GET 请求。

为了可以支持其他 HTTP 谓词类型,再在 Controller 中加几个 Action ,命名的时候,前缀使用 HTTP 谓词相关的动词或者标签。代码片段 3-6 有 POST 和 PUT 两个类型的 Action。他们都扩展了 TeamsController 的功能,可以创建 Team 资源,创建一个 Player 资源到一个给定的 Team 中,这两个都是 POST,以及一个更新 Team 的操作(PUT)。

代码片段 3-6. 补充定义,支持其他的 HTTP 谓词

 1 [Route]
 2 public HttpResponseMessage PostTeam(Team team)
 3 {
 4     // 忽略逻辑
 5 }
 6 [HttpPost]
 7 [Route("{teamId}/players")]
 8 public HttpResponseMessage AddPlayer(int teamId, Player player)
 9 {
10     // 忽略逻辑
11 }
12 [Route("{id}")]
13 public HttpResponseMessage PutTeam(int id, Team team)
14 {
15     // 忽略逻辑
16 }
时间: 2024-08-25 05:02:40

[水煮 ASP.NET Web API2 方法论](3-2)直接式路由/属性路由的相关文章

[水煮 ASP.NET Web API2 方法论](3-9)空气路由的设置

阅读导航 问题 解决方案 工作原理 代码演示 在此解释一下,空气路由,是本人臆想出来,觉着更能表达 IgnoreRoute 的意图,如果看着辣眼睛^^,请见谅. 问题 我们在之定义过集中式路由,集中式路由有一个特点就是短路,但是现在我们不想让某些路由工作(匹配并由路由引擎处理请求).那么我们应该怎么办呢? 解决方案 其实思路很简单,就是想把某些路由忽略了.ASP.NET WEB API 提供了一个叫做的 StopRoutingHandler 的处理器,简单说,他就是一个消息处理器,可以通过他来强

[水煮 ASP.NET Web API2 方法论](3-5)路由约束

问题 怎么样限制路由中参数的值. 解决方案 ASP.NET WEB API 允许我们通过 IHttpRouteConstraint 接口设置路由约束.集中式路由和直接式路由都可以使用 IHttpRouteConstraint. 框架提供了 18 个接口,他提供了大部分类型的约束,例如,路由参数长度相关的约束,可以确保值都在定义范围内,或者限制数据类型.当然也可以通过实现接口 IHttpRouteConstraint 来自定义约束逻辑. 工作原理 IHttpRoutConstraint 是一个 H

[水煮 ASP.NET Web API2 方法论](1-5)ASP.NET Web API Scaffolding(模板)

问题 我们想快速启动一个 ASP.NET Web API 解决方案. 解决方案 APS.NET 模板一开始就支持 ASP.NET Web API.使用模板往我们的项目中添加 Controller,在我们解决方案的 Controllers 文件夹上右键,选择"添加"->"Scaffolding". 即用模式,可以从下面选择一个: Web API2 Controller Web API2 Controller with      actions, using En

[水煮 ASP.NET Web API2 方法论](12-3)OData 查询

问题 Web API 怎么支持通用的 OData 系统查询项,例如 $select 或 $filter. 解决方案 为了在 Web API 中启用查询项,我们需要在 Action 上使用 EnableQueryAttribute. 如果 Action 没有返回集合,而是返回单个对象的实例,调用端仍然可以使用 $expand 和 $select 两个查询语句,要达到这个目的,我们必须将返回对象包装在 SingleResult<T> 中.集合和单个对象实例作为返回值的例子如订单 12-7 所示 清

[水煮 ASP.NET Web API2 方法论](1-7)CSRF-Cross-Site Request Forgery

问题 通过 CSRF(Cross-Site Request Forgery)防护,保护从 MVC 页面提交到ASP.NET Web API 的数据. 解决方案 ASP.NET 已经加入了 CSRF 防护功能,只要通过 System.web.Helpers.AntiForgery 类(System.Web.WebPages 的一部分)就可以. 他会生成两个 Token: Cookie Token 基于字符串的 Token 基于字符串的 Token 是可以嵌入到表单或者请求头(使用 Ajax 的情况

[水煮 ASP.NET Web API2 方法论](3-4)设置路由可选项

问题 怎么样创建一个路由,不管客户端传不传这个参数,都可以被成功匹配. 解决方案 ASP.NET WEB API 的集中式路由和属性路由都支持路由声明可选参数. 在用集中式路由中可以通过 RouteParameter.Optional 指定一个可选参数,RouteParameter.Optional 等同于MVC 中的 UrlParameter.Option. 属性路由,通过在可选参数后面添加一个问好作为后缀.同时,必须为其指定默认值 工作原理 从根本上看,ASP.NET WEB API 支持的

[水煮 ASP.NET Web API2 方法论](12-1)创建 OData

问题 怎样用在 Web API 中创建 OData 服务. 解决方案 对于我们来说,在 Web API 中使用 OData最简单的方式就是使用 ASP.NET 模板来创建Odata Controller.在 Controllers 文件夹上鼠标右键->添加->新建项. 显示一个如图 12-1 的对话框,在这里我们可以选择两个 "Web API 2 OData" 相关的模板.Vistual Studio 将会生成相关的 OData Controller,同时,从 NuGet

[水煮 ASP.NET Web API2 方法论](1-4)从 MVC Controller 链接到 API Controller 以及反向链接

问题 想创建一个从 ASP.NET MVC controller 到 ASP.NET Web API controller 的直接链接,或者反向链接. 解决方案 可以使用 System.Web.Http.Routing.UrlHelp 的实例来创建一个指向 Controller的链接,来暴露ApiController(作为 Url 属性).着和在 RequestContext 上一样,会被附加到 HttpRequestMessage 实例.为了达到这个目的,我们需要调用链接方法或路由方法,然后传

[水煮 ASP.NET Web API2 方法论](1-8)添加 Session 状态

问题 ASP.NET Web API 构建 Web 应用程序时,要求使用 Session 在服务器存储一些用户特定的信息 解决方案 ASP.NET Web API 不支持 Session,因为 API 根本不依赖于System.Web.他想试图摆脱伪造 Session,非 HTTP这样的概念. 然而,如果我们 在 ASP.NET 运行时中运行 ASP.NET Web API,还想启用 Session.我们可以通过两种方式来做: 全局:应用于整个 API 局部:应用于指定路由 启用全局方式,我们需