ASP.NET WEB API必知必会:特性路由

一、什么是特性路由?

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

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

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

二、特性路由使用方法

1.基本路由映射

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

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

ASP.NET WEB API必知必会:特性路由_第1张图片

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,结果如下:

ASP.NET WEB API必知必会:特性路由_第2张图片       ASP.NET WEB API必知必会:特性路由_第3张图片

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  结果如下:

ASP.NET WEB API必知必会:特性路由_第4张图片   

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  结果如下:

ASP.NET WEB API必知必会:特性路由_第5张图片   

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

ASP.NET WEB API必知必会:特性路由_第6张图片

ASP.NET WEB API必知必会:特性路由_第7张图片

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  结果如下:

 ASP.NET WEB API必知必会:特性路由_第8张图片  ASP.NET WEB API必知必会:特性路由_第9张图片

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  结果如下:

ASP.NET WEB API必知必会:特性路由_第10张图片  ASP.NET WEB API必知必会:特性路由_第11张图片

 

上面曾讲到过参数约束,其实除了系统提供的约束,还可以自定义实现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

两个资源文件内容如下:

ASP.NET WEB API必知必会:特性路由_第12张图片   ASP.NET WEB API必知必会:特性路由_第13张图片

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  结果如下:

ASP.NET WEB API必知必会:特性路由_第14张图片  

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

ASP.NET WEB API必知必会:特性路由_第15张图片


你可能感兴趣的:(Web,api,asp.net)