ASP.NET WEB API必知必會：特性路由

1、什麼是特性路由？

特性路由是指將RouteAttribute或自定義繼承自RouteAttribute的特性類標記在控制器或ACTION上，同時指定路由 Url字符串，從而實現路由映射，相比以前的經過Routes.Add或Routes.MapHttpRoute來說，更加靈活與直觀。

若要使用特性路由功能須要先在Application_Start中開啓映射到特性路由，代碼以下：

1 2 3

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

2、特性路由使用方法

1.基本路由映射

1 2 3 4 5

[Route("api/Values")] publicIEnumerable<string> Get() {     returnnewstring[] {"value1","value2"}; }

訪問地址：http://localhost:34732/api/values,結果以下：

2.路由映射到參數

1 2 3 4 5

[Route("api/Values/{id}")] publicstringGet2(intid) {     return"value:"+ id.ToString(); }

訪問地址：http://localhost:34732/api/values,結果以下：

3.多重特性路由

1 2 3 4 5 6

[Route("api/Values/{value1}/{value2}")] [Route("api/Demo/{value2}/{value1}")] publicIEnumerable<string> Get3(stringvalue1,stringvalue2) {     returnnew[] { value1, value2 }; }

訪問地址：http://localhost:34732/api/values/a/b 或 http://localhost:34732/api/demo/a/b，結果以下：

       

4.缺省（默認）參數路由

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

//第一種方法 [Route("api/Values/option/{key}/{value?}")]         publicDictionary<string,string> Get4(stringkey,stringvalue ="test")         {             returnnewDictionary<string,string>() {                 {key,value}             };         }           //第二種方法         [Route("api/Values/option/{key}/{value=test}")]         publicDictionary<string,string> Get5(stringkey,stringvalue)         {             returnnewDictionary<string,string>() {                 {key,value}             };         }

訪問地址：http://localhost:34732/api/Values/option/a, http://localhost:34732/api/Values/option/a/api  結果以下：

   

5.參數約束路由

1 2 3 4 5

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

訪問地址：http://localhost:34732/api/Values/constraint/10, http://localhost:34732/api/Values/constraint/11  結果以下：

   

系統已提供的參數約束使用方法以下表（圖片來源於蔣金楠書中）：

6.通配符（*）路由變量

1 2 3 4 5

[Route("api/Values/many/{isOk:bool}/{*getDate:datetime}")] publicIHttpActionResult Get7(boolisOk, DateTime? getDate =null) {     returnJson(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.路由映射（綁定）到複雜參數

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

[ModelBinder]//使其支持默認綁定     publicclassPoint     {         publicintx {get;set; }           publicinty {get;set; }     }   //第一種形式         [Route("api/Values/model/{a.x:int}/{a.y:int}/{b.x:int}/{b.y:int}")]         publicIEnumerable<Point> Get8(Point a, Point b)         {             returnnew[] { a, b };         }   //第二種形式         [Route("api/Values/model")]         publicIEnumerable<Point> Get9(Point a, Point b)         {             returnnew[] { 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.統必定義路由前綴及取消路由前綴

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

[RoutePrefix("api/demo")]//定義路由前綴 publicclassDemoController : ApiController {       [Route("Values")]//這裏只需定義除路由前綴外的部份，完整路由：api/demo/Values     publicIEnumerable<string> Get()     {         returnnewstring[] {"value1","value2"};     }         [Route("~/api/Values/{id}")]//這裏經過~/取消路由前綴，完整路由：api/Values/{id}     publicstringGet(intid)     {         return"value:"+ id.ToString();     }

訪問地址：http://localhost:34732/api/demo/values, http://localhost:34732/api/values/1  結果以下：

  

 

上面曾講到過參數約束，其實除了系統提供的約束，還能夠自定義實現IHttpRouteConstraint的約束類，下面是一箇中英文切換的語言約束示例，代碼實現以下：

首先定義一箇中英文語言約束類：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

publicclassCultureRouteConstraint : IHttpRouteConstraint {     privatestaticList<string> allowCultureList;     staticCultureRouteConstraint()     {         allowCultureList =newList<string> {"zh-cn","en-us"};//CultureInfo.GetCultures(CultureTypes.AllCultures).Select(c => c.Name).ToList();     }       publicboolMatch(System.Net.Http.HttpRequestMessage request, IHttpRoute route,stringparameterName, IDictionary<string,object> values, HttpRouteDirection routeDirection)     {         if(values.ContainsKey(parameterName))         {             returnallowCultureList.Any(c => c.Equals(values[parameterName].ToString(), StringComparison.OrdinalIgnoreCase));         }         returnfalse;     } }

而後將其添加到默認路由約束解析器（DefaultInlineConstraintResolver）的參數與約束映射字典中，代碼以下：

1 2 3 4 5

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

最後就能夠像使用普通約束同樣來使用該約束，在使用約束前，定義兩個資源文件，分別爲：默認資源文件（中文）：Resources.resx，英文資源文件：Resources.en-us.resx

兩個資源文件內容以下：

   

WEB API 的ACTION定義以下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

[Route("api/Values/constraint/{culture:culture}/{name}")] publicstringGet10(stringculture,stringname) {     CultureInfo currentCultureInfo = CultureInfo.CurrentCulture;     CultureInfo currentCultureUIInfo = CultureInfo.CurrentUICulture;     try     {         Thread.CurrentThread.CurrentCulture = Thread.CurrentThread.CurrentUICulture =             newCultureInfo(culture);         returnResources.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，從而提示找不到頁面，以下：