深入理解WebAPI中的特性路由

特性路由简介

Web API 2引入了一种新的路由方式——特性路由，这种方式允许开发者直接在控制器或动作方法上使用特性来定义路由。这不仅使得路由更加直观，也更容易管理复杂的URI结构，尤其是在资源间存在嵌套关系的情况下，如客户与订单的关系。

例如，对于一个需要访问特定客户的所有订单的情况，可以使用如下特性路由：
[Route("customers/{customerId}/orders")]

启用特性路由需要在Web API配置中调用MapHttpAttributeRoutes方法，如下所示：

config.MapHttpAttributeRoutes();

API版本控制

特性路由还支持API的版本化，通过不同的URL路径来区分不同版本的API。例如：
/api/v1/products 和 /api/v2/products

HTTP方法指定

默认情况下，Web API会根据动作方法的命名约定（如Get、Post等）自动选择HTTP方法。但也可以通过显式地添加HTTP方法特性来覆盖这一行为，如[HttpGet]、[HttpPost]等。

路由前缀

当一个控制器下的多个动作方法共享相同的路由前缀时，可以通过[RoutePrefix]特性来简化路由定义。例如：
[RoutePrefix("api/books")] 可以应用到控制器上，然后每个动作方法只需定义相对路径即可。

路由约束

路由约束允许开发者对路由参数施加条件限制，确保只有符合特定模式的请求才能匹配到相应的动作方法。常见的约束类型包括数字、字符串长度、日期时间等。例如：
[Route("users/{id:int}")] 仅匹配包含整数ID的用户请求。

此外，还可以自定义路由约束，通过实现IHttpRouteConstraint接口来满足特定需求。

可选URI参数与默认值

在定义路由时，可以通过在参数后添加问号来指定该参数为可选，或者直接为其提供一个默认值。例如：
[Route("api/books/locale/{lcid:int?}")] 或 [Route("api/books/locale/{lcid:int=1033}")]

路由名称与链接生成

每个路由都可以有一个名称，这对于生成链接特别有用。例如，通过给路由指定名称，可以在其他地方方便地生成指向该路由的链接。这在处理资源创建后的重定向操作时非常实用。

路由顺序

虽然可以通过[Route("xxx", RouteOrder=n)]特性来指定路由的优先级，但在大多数情况下，通过精心设计的路由规则来避免冲突更为推荐，这也能使代码更加清晰易懂。