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

一、什么是特性路由？

特性路由是指將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，從而提示找不到頁面，如下：