web api Route属性定义

小渣渣

ASP.NET Web API路由，简单来说，就是把客户端请求映射到对应的Action上的过程。在"ASP.NET Web API实践系列03,路由模版, 路由惯例, 路由设置"一文中，体验了通过模版、惯例、HTTP方法来设置路由，这种做法的好处是把路由模版统一放在了App_Start文件夹下的WebApiConfig类中，方便管理，但缺点是不够灵活。


REST把一切都看成资源，有时候，一个资源连带子资源，比如Customer和Orders密切关联，我们可能希望输入这样的请求：customers/1/orders，但仅仅凭借惯例，很难实现这种路由。而实际上，ASP.NET Web API为我们准备了Route特性，该特性可以直接打到Action上，使用非常灵活、直观。

下面就在ASP.NET MVC4下来体验Route特性的使用方法。

允许Route特性


首先需要在WebApiConfig中设置。

登录可见。

以上的MapHttpAttributeRoutes方法只在ASP.NET Web API较新的版本中才有，如果你的版本比较低，可以通过"NuGet程序包管理器控制台"卸载旧版本，安装最新版本。

登录可见。

接下来，在Global.asax中，需要把原先注册WebApiConfig的方式注释掉，采纳新的方式，如下：

登录可见。

这时候运行项目可能会报如下错误：

这是因为在下载使用ASP.NET Web API最新版本的时候，顺带下载了一个最新版本的icrosoft.AspNet.WebApi.HelpPage。可以把最新版的HelpPage卸载掉，再下载相对老的版本。

Uninstall-Package Microsoft.AspNet.WebApi.HelpPage –Force
Install-Package Microsoft.AspNet.WebApi.HelpPage -Pre


使用Route特性

创建一个Cusomter类。

登录可见。

创建一个Order类。

登录可见。

创建一个Database类，用来获取Order集合。

登录可见。

创建一个空的API控制器，编写如下：

登录可见。

在浏览器中输入如下：

如果你使用的是ASP.NET MVC4进行开发，在程序第一次运行的时候，可能会报如下错误：

[A]System.Web.WebPages.Razor.Configuration.HostSection 无法强制转换为 [B]System.Web.WebPages.Razor.Configuration.HostSection。类型 A 源自“System.Web.WebPages.Razor, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35”(在上下文“Default”中的“C:/Windows/Microsoft.Net/assembly/GAC_MSIL/System.Web.WebPages.Razor/v4.0_2.0.0.0__31bf3856ad364e35/System.Web.WebPages.Razor.dll”位置处)。类型 B 源自“System.Web.WebPages.Razor, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35”(在上下文“Default”中的“C:/Windows/Microsoft.NET/Framework/v4.0.30319/Temporary ASP.NET Files/vs/feb7ce97/a525d58a/asse

这是因为，在下载最新版本的ASP.NET Web API的时候，用到了Razor的最新版本。需要在根目录下的Web.config中作如下配置：

登录可见。

使用RoutePrefix特性


如果想给某个API控制器中的所有Action加上一个前缀，可把RoutePrefix特性打在API控制器上。

比如我们希望是这样的格式：http://localhost/api/customers/1/orders


这样来修改OrdersController。

登录可见。

还可以在Route特性中使用~来重写Action的前缀规则。

登录可见。

RoutePrefix特性定义的前缀还可以带参数变量：

登录可见。

路由约束

可以通过"{参数变量名称:约束}"来约束路由中的参数变量。

登录可见。

以上，如果片段变量id为int类型，就路由到第一个Action，如果不是，路由到第二个Action。

ASP.NET Web API内置约束包括：

{x:alpha} 约束大小写英文字母
{x:bool}
{x:datetime}
{x:decimal}
{x:double}
{x:float}
{x:guid}
{x:int}
{x:length(6)}
{x:length(1,20)} 约束长度范围
{x:long}
{x:maxlength(10)}
{x:min(10)}
{x:range(10,50)}
{x:regex(正则表达式)}


可以为一个参数变量同时设置多个约束：

登录可见。

实现IHttpRouteConstraint接口，可自定义约束规则。实现一个不能为0的约束。

登录可见。

在App_Start文件夹中的WebApiConfig中注册自定义约束。

登录可见。

使用自定义约束。

登录可见。

可选参数及其默认值

如果一个路由参数变量是可选的，同时必须给该参数一个默认值。

登录可见。

在约束后面加?，表示可选，在方法参数中给id设置默认值。

给路由设置名称

登录可见。

路由优先顺序

Route特性设置的路由优先顺序是根据惯例和RouteOrder属性来确定的。

惯例是：

1、静态片段变量
2、带约束的片段变量
3、不带约束的片段变量
4、带约束的通配符片段变量
5、不带约束的通配符片段变量

RouteOrder属性的默认值是0，属性值越小，排在越前面。

登录可见。

以上，路由的优先顺序是：

orders/details  静态片段变量，RouteOrder属性值为0
orders/{id} 带约束的片段变量，RouteOrder属性值为0
orders/{customerName} 不带约束的片段变量，RouteOrder属性值为0
orders/{*date} 带约束的通配符片段变量，RouteOrder属性值为0
orders/pending RouteOrder属性值为1