开发者社区> 技术小牛人> 正文

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")]
public IEnumerable<string> Get()
{
    return new string[] { "value1""value2" };
}

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

2.路由映射到参数

1
2
3
4
5
[Route("api/Values/{id}")]
public string Get2(int id)
{
    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}")]
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.缺省(默认)参数路由

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
        //第一种方法
[Route("api/Values/option/{key}/{value?}")]
        public Dictionary<stringstring> Get4(string key, string value = "test")
        {
            return new Dictionary<stringstring>() {
                {key,value}
            };
        }
 
        //第二种方法
        [Route("api/Values/option/{key}/{value=test}")]
        public Dictionary<stringstring> Get5(string key, string value)
        {
            return new Dictionary<stringstring>() {
                {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)}")]
public string Get6(int id)
{
    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}")]
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.路由映射(绑定)到复杂参数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
    [ModelBinder] //使其支持默认绑定
    public class Point
    {
        public int x { getset; }
 
        public int y { getset; }
    }
 
//第一种形式
        [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.统一定义路由前缀及取消路由前缀

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[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的约束类,下面是一个中英文切换的语言约束示例,代码实现如下:

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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<stringobject> values, HttpRouteDirection routeDirection)
    {
        if (values.ContainsKey(parameterName))
        {
            return allowCultureList.Any(c => c.Equals(values[parameterName].ToString(), StringComparison.OrdinalIgnoreCase));
        }
        return false;
    }
}

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

1
2
3
4
5
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定义如下:

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}")]
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,从而提示找不到页面,如下:

本文转自 梦在旅途 博客园博客,原文链接:http://www.cnblogs.com/zuowj/p/5273221.html  ,如需转载请自行联系原作者

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
6.3 ASP.NET Core Web API技术选择
ASP.NET Core Web API技术选择
61 0
ASP.NET Core Web API 帮助页
ASP.NET Core Web API 帮助页
115 0
ASP.NET Core WEB API 使用element-ui文件上传组件el-upload执行手动文件文件,并在文件上传后清空文件
ASP.NET Core WEB API 使用element-ui文件上传组件el-upload执行手动文件文件,并在文件上传后清空文件
273 0
Oracle+ASP.Net Core Web API在云服务器上的部署
暑假数据库课程设计,我们小组选择vue+web api+Oracle开发网站,需要云服务器部署项目,对比后选择了阿里云服务器,并选择飞天加速计划——高校学生在家实践活动,一番摸索后实现了oracle数据库的建立与web api的发布,目前使用感觉良好。
162 0
ASP.NET Core 3.0一个jwt的轻量角色/用户、单个API控制的授权认证库
ASP.NET Core 3.0一个jwt的轻量角色/用户、单个API控制的授权认证库
102 0
小范笔记:ASP.NET Core API基础知识与Axios前端提交数据
小范笔记:ASP.NET Core API基础知识与Axios前端提交数据
579 0
ASP.NET MVC (四、ASP.NET Web API应用程序与跨域操作)(7)
ASP.NET MVC (四、ASP.NET Web API应用程序与跨域操作)(7)
82 0
ASP.NET MVC (四、ASP.NET Web API应用程序与跨域操作)(6)
ASP.NET MVC (四、ASP.NET Web API应用程序与跨域操作)(6)
71 0
ASP.NET MVC (四、ASP.NET Web API应用程序与跨域操作)(5)
ASP.NET MVC (四、ASP.NET Web API应用程序与跨域操作)(5)
85 0
ASP.NET MVC (四、ASP.NET Web API应用程序与跨域操作)(4)
ASP.NET MVC (四、ASP.NET Web API应用程序与跨域操作)(4)
67 0
+关注
技术小牛人
文章
问答
视频
文章排行榜
最热
最新
相关电子书
更多
PWA:移动Web的现在与未来
立即下载
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
相关实验场景
更多