1. 程式人生 > >ASP.NET WEB API 特性路由

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,從而提示找不到頁面,如下: