一、什么是特性路由?

特性路由是指将RouteAttribute或自定义继承自RouteAttribute的特性类标记在控制器或ACTION上,同时指定路由Url字符串,从而实现路由映射,相比之前的通过Routes.Add或Routes.MapHttpRoute来讲,更加灵活与直观。

若要使用特性路由功能需要先在Application_Start中开启映射到特性路由,代码如下:

GlobalConfiguration.Configuration.MapHttpAttributeRoutes();
//或在WebApiConfig.Register方法中直接使用增加:
config.MapHttpAttributeRoutes();

二、特性路由使用方法

1.基本路由映射

[Route("api/Values")]
public IEnumerable<string> Get()
{
return new string[] { "value1", "value2" };
}

访问地址:http://localhost:34732/api/values,结果如下:

2.路由映射到参数

[Route("api/Values/{id}")]
public string Get2(int id)
{
return "value:" + id.ToString();
}

访问地址:http://localhost:34732/api/values,结果如下:

3.多重特性路由

[Route("api/Values/{value1}/{value2}")]
[Route("api/Demo/{value2}/{value1}")]
public IEnumerable<string> Get3(string value1, string value2)
{
return new[] { value1, value2 };
}

访问地址:http://localhost:34732/api/values/a/b 或 http://localhost:34732/api/demo/a/b,结果如下:

       

4.缺省(默认)参数路由

        //第一种方法
[Route("api/Values/option/{key}/{value?}")]
public Dictionary<string, string> Get4(string key, string value = "test")
{
return new Dictionary<string, string>() {
{key,value}
};
} //第二种方法
[Route("api/Values/option/{key}/{value=test}")]
public Dictionary<string, string> Get5(string key, string value)
{
return new Dictionary<string, string>() {
{key,value}
};
}

访问地址:http://localhost:34732/api/Values/option/a, http://localhost:34732/api/Values/option/a/api  结果如下:

   

5.参数约束路由

[Route("api/Values/constraint/{id:range(1,10)}")]
public string Get6(int id)
{
return "value:" + id.ToString();
}

访问地址:http://localhost:34732/api/Values/constraint/10, http://localhost:34732/api/Values/constraint/11  结果如下:

   

系统已提供的参数约束使用方法如下表(图片来源于蒋金楠书中):

6.通配符(*)路由变量

[Route("api/Values/many/{isOk:bool}/{*getDate:datetime}")]
public IHttpActionResult Get7(bool isOk, DateTime? getDate = null)
{
return Json(new { Ok = isOk, Date = getDate });
}

访问地址:http://localhost:34732/api/Values/many/true/2016-3-13, http://localhost:34732/api/Values/many/false/2016/3/13  结果如下:

   

7.路由映射(绑定)到复杂参数

 [ModelBinder] //使其支持默认绑定
public class Point
{
public int x { get; set; } public int y { get; set; }
} //第一种形式
[Route("api/Values/model/{a.x:int}/{a.y:int}/{b.x:int}/{b.y:int}")]
public IEnumerable<Point> Get8(Point a, Point b)
{
return new[] { a, b };
} //第二种形式
[Route("api/Values/model")]
public IEnumerable<Point> Get9(Point a, Point b)
{
return new[] { a, b };
}

访问地址:http://localhost:34732/api/Values/model/1/2/3/4, http://localhost:34732/api/Values/model?a.x=10&a.y=20&b.x=30&b.y=40  结果如下:

  

8.统一定义路由前缀及取消路由前缀

[RoutePrefix("api/demo")] //定义路由前缀
public class DemoController : ApiController
{ [Route("Values")] //这里只需定义除路由前缀外的部份,完整路由:api/demo/Values
public IEnumerable<string> Get()
{
return new string[] { "value1", "value2" };
} [Route("~/api/Values/{id}")] //这里通过~/取消路由前缀,完整路由:api/Values/{id}
public string Get(int id)
{
return "value:" + id.ToString();
}

访问地址:http://localhost:34732/api/demo/values, http://localhost:34732/api/values/1  结果如下:

  

上面曾讲到过参数约束,其实除了系统提供的约束,还可以自定义实现IHttpRouteConstraint的约束类,下面是一个中英文切换的语言约束示例,代码实现如下:

首先定义一个中英文语言约束类:

public class CultureRouteConstraint : IHttpRouteConstraint
{
private static List<string> allowCultureList;
static CultureRouteConstraint()
{
allowCultureList = new List<string> { "zh-cn","en-us"}; //CultureInfo.GetCultures(CultureTypes.AllCultures).Select(c => c.Name).ToList();
} public bool Match(System.Net.Http.HttpRequestMessage request, IHttpRoute route, string parameterName, IDictionary<string, object> values, HttpRouteDirection routeDirection)
{
if (values.ContainsKey(parameterName))
{
return allowCultureList.Any(c => c.Equals(values[parameterName].ToString(), StringComparison.OrdinalIgnoreCase));
}
return false;
}
}

然后将其添加到默认路由约束解析器(DefaultInlineConstraintResolver)的参数与约束映射字典中,代码如下:

DefaultInlineConstraintResolver defaultInlineConstraintResolver = new DefaultInlineConstraintResolver();
defaultInlineConstraintResolver.ConstraintMap.Add("culture", typeof(CultureRouteConstraint)); // Web API routes
config.MapHttpAttributeRoutes(defaultInlineConstraintResolver);

最后就可以像使用普通约束一样来使用该约束,在使用约束前,定义两个资源文件,分别为:默认资源文件(中文):Resources.resx,英文资源文件:Resources.en-us.resx

两个资源文件内容如下:

   

WEB API 的ACTION定义如下:

[Route("api/Values/constraint/{culture:culture}/{name}")]
public string Get10(string culture,string name)
{
CultureInfo currentCultureInfo = CultureInfo.CurrentCulture;
CultureInfo currentCultureUIInfo = CultureInfo.CurrentUICulture;
try
{
Thread.CurrentThread.CurrentCulture = Thread.CurrentThread.CurrentUICulture =
new CultureInfo(culture);
return Resources.ResourceManager.GetString(name.ToString()); }
finally //因为线程池有复用功能,所以此处需要恢复到默认状态
{
Thread.CurrentThread.CurrentCulture = currentCultureInfo;
Thread.CurrentThread.CurrentUICulture = currentCultureUIInfo;
}
}

访问地址:http://localhost:34732/api/Values/constraint/zh-cn/hello, http://localhost:34732/api/Values/constraint/en-us/hello  结果如下:

  

如果访问其它的语言,比如:http://localhost:34732/api/Values/constraint/zh-tw/hello,就会因约束限制而无法映射到ACTION,从而提示找不到页面,如下:

ASP.NET WEB API 特性路由的更多相关文章

  1. ASP.NET MVC , ASP.NET Web API 的路由系统与 ASP.NET 的路由系统是怎么衔接的?

      ASP.NET MVC 的路由实际上是建立在 ASP.NET 的路由系统之上的. MVC 路由注册通常是这样的: RouteTable 是一个全局路由表, 它的 Routes 静态属性是一个 Ro ...

  2. 2.3属性在 ASP.NET Web API 2 路由

    路由是 Web API 如何匹配 URI 的行动.Web API 2 支持一种新型的路由,称为属性路由.顾名思义,属性路由使用属性来定义路由.属性路由给你更多的控制 Uri 在您的 web API.例 ...

  3. ASP.NET Web API 特性

    ASP.NET MVC 4 包含了 ASP.NET Web API, 这是一个创建可以连接包括浏览器.移动设备等多种客户端的 Http 服务的新框架, ASP.NET Web API 也是构建 RES ...

  4. ASP.NET Web API编程——路由

    路由过程大致分为三个阶段: 1)请求URI匹配已存在路由模板 2)选择控制器 3)选择操作 1匹配已存在的路由模板 路由模板 在WebApiConfig.Register方法中定义路由,例如模板默认生 ...

  5. [翻译]ASP.NET Web API的路由

    原文:Routing in ASP.NET Web API 在我们新建一个Web API项目时,会在App_Start文件夹下的WebApiConfig.cs中定义一个默认路由: config.Rou ...

  6. 2.4使用属性在 ASP.NET Web API 2 路由创建一个 REST API

    Web API 2 支持一种新型的路由,称为属性路由.属性路由的一般概述,请参阅属性路由 Web API 2 中.在本教程中,您将使用属性路由创建一个 REST API 集合的书.API 将支持以下操 ...

  7. ASP.NET Web API 路由对象介绍

    ASP.NET Web API 路由对象介绍 前言 在ASP.NET.ASP.NET MVC和ASP.NET Web API这些框架中都会发现有路由的身影,它们的原理都差不多,只不过在不同的环境下作了 ...

  8. ASP.NET Web API路由系统:路由系统的几个核心类型

    虽然ASP.NET Web API框架采用与ASP.NET MVC框架类似的管道式设计,但是ASP.NET Web API管道的核心部分(定义在程序集System.Web.Http.dll中)已经移除 ...

  9. ASP.NET Web API 2.0新特性:Attribute Routing1

    ASP.NET Web API 2.0新特性:Attribute Routing[上篇] 对于一个针对ASP.NET Web API的调用请求来说,请求的URL和对应的HTTP方法的组合最终决定了目标 ...

随机推荐

  1. 后缀自动机求多串LCS——spojlcs2

    /* 每个状态存最长匹配长度,然后多个串匹配过程中取最小的最长匹配长度 和LCS1不同的地方:LCS只要维护住当前匹配长度和最长匹配长度即可,但是多串匹配需要维护的是每个状态结点(即后缀树上)的信息 ...

  2. 源码安装zabbix-oracle

    源码安装zabbix_agent4.0.3   1.源码包下载地址:https://www.zabbix.com/download_sources 2.下载完后上传在任意目录用root用户创建以下脚本 ...

  3. 2018-2019-2-20175323 java实验五 网络编程与安全

    20175323 java实验五 网络编程与安全 任务一 ①编写MyBC.java实现中缀表达式转后缀表达式的功能 ②编写MyDC.java实现从上面功能中获取的表达式中实现后缀表达式求值的功能 基本 ...

  4. sublime 分屏 实现代码整体前后移

    view->layout->column2 或者快捷键 command+alt+n (mac) "Tab"键整体后移,"Shift+Tab"整体前移

  5. 线性可分SVM中线性规划问题的化简

    在网上找了许多关于线性可分SVM化简的过程,但似乎都不是很详细,所以凭借自己的理解去详解了一下. 线性可分SVM的目标是求得一个超平面(其实就是求w和b),在其在对目标样本的划分正确的基础上,使得到该 ...

  6. [AH2017/HNOI2017]单旋

    题目 \(\rm splay\)水平太差,于是得手玩一下才能发现规律 首先插入一个数,其肯定会成为其前驱的右儿子或者是后继的左儿子,进一步手玩发现前驱的右儿子或者是后继的左儿子一定只有一个是空的,我们 ...

  7. Oracle SQL外连接

    SQL提供了多种类型的连接方式,它们之间的区别在于:从相互交叠的不同数据集合中选择用于连接的行时所采用的方法不同.连接类型        定义内连接           只连接匹配的行左外连接     ...

  8. pycharm连接数据库及相应操作

    1.连接数据库 2.pycharm中数据库的操作

  9. Yii2 中使用ts

    在运行环境 vagrant Ubuntu box 中安装 sass ,typescript等 安装需要的软件: sudo su -c "gem install sass" # 可选 ...

  10. CF886F Symmetric Projections

    题意:给你平面上n个点,问有多少条过原点的直线,使得这些点在该直线上的投影(做垂直,对应点)形成对称图形?n<=2000. 标程: #include<bits/stdc++.h> # ...