Attribute Routing

系列导航地址http://www.cnblogs.com/fzrain/p/3490137.html

题外话:由于这个技术点是新学的,并不属于原系列,但借助了原系列的项目背景,故命名外传系列,以后也可能在这个系列中附加一些新的技术。

前言

在Web Api 2.0中,提出了一种新的配置路由方式——基于特性的路由(Attribute-based Routing),在我们之前介绍的配置路由方式称为——基于公约的路由(Convention-based Routing),新的路由配置方式同样应用在MVC5中,因此本文就来介绍一下基于特性的路由。

在之前的一篇文章中,我们处理了这么一个业务——实现学生选课。我们是通过在“WebApiConfig”定制了一条路由数据来实现的,这条路由实现了选课以及根据课程Id来查询选择选择该课程的所有学生信息,感觉设计还可以。在实际应用中一般来说查询用的是最多的,使用Attribute Routing来注册路由会更灵活,控制起来也更方便,更符合Rest。本文以根据课程的名字来查询所有选择该课程的学生信息以及根据课程名字以及学生名字查询某一学生的信息。

基于特性的路由介绍

顾名思义,新路由将使用一个特性来实现路由注册,如下:

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public sealed class RouteAttribute : Attribute, IHttpRouteInfoProvider
{
public RouteAttribute();
public RouteAttribute(string template); public string Name { get; set; }
public int Order { get; set; }
public string Template { get; private set; }
}

这个类包含3个属性:Name指路由的名字,Order是指路由的顺序,Template就是我们要去匹配URL的模板

实现Attribute Routing

原理性的东西不多介绍的(我也没多研究 呵呵),能把学到的技术运用到实际中才是王道,上来一大堆原理容易晕,以后需要深入研究再看原理。

在“EnrollmentsController”中新增一个方法GetStudentsInfo:

[Route("api/enrollments/{courseName}/{studentName?}")]
public IEnumerable<StudentBaseModel> GetStudentsInfo(string courseName, string studentName="")
{
IQueryable<Student> query;
Course course= TheRepository.GetAllCourses().Where(c => c.Name == courseName).FirstOrDefault();
if (course==null )
{
return null ;
}
query = TheRepository.GetEnrolledStudentsInCourse(course.Id).OrderBy(s => s.LastName);
if (!string.IsNullOrWhiteSpace(studentName))
{
query = query.Where(s => s.FirstName == studentName);
}
var totalCount = query.Count(); System.Web.HttpContext.Current.Response.Headers.Add("X-InlineCount", totalCount.ToString()); var results = query .ToList()
.Select(s => TheModelFactory.Create(s)); return results; }

在我们的Action上使用了RouteAttribute。分析一下这个URL模板("api/enrollments/{courseName}/{studentName?}"),{courseName}会匹配到Action的courseName参数上,对于Action的另一个参数studentName是一个可选参数,也就是说请求中没有给出值那么就是默认的空字符串,有值得话就会被赋值,因此我们在“{studentName}”后面加上? 标记为可选的URI参数。

ok,就这么简单,测试一次:

结果:

呃,出错了。。。

一个新的问题

出错了,不过不管怎么说解决方案总归是有的,首先看下错误原因:是在LearningControllerSelector类的方法中出现了空引用,那么我们就不得不看下这个方法:

public override HttpControllerDescriptor SelectController(HttpRequestMessage request)
{
var controllers = GetControllerMapping(); //Will ignore any controls in same name even if they are in different namepsace var routeData = request.GetRouteData(); var controllerName = routeData.Values["controller"].ToString(); HttpControllerDescriptor controllerDescriptor; if (controllers.TryGetValue(controllerName, out controllerDescriptor))
{ var version = "2"; var versionedControllerName = string.Concat(controllerName, "V", version); HttpControllerDescriptor versionedControllerDescriptor;
if (controllers.TryGetValue(versionedControllerName, out versionedControllerDescriptor))
{
return versionedControllerDescriptor;
} return controllerDescriptor;
} return null; }

看了这段代码我们不难发现这个方法是我们重写了基类的方法,目的是为了实现现版本控制(详情可移步:http://www.cnblogs.com/fzrain/p/3558765.html),在我们重写的方法中我们用到了RouteData中包含的Controller的名字,而这个名字是由基于公约的路由与URI匹配得到的,因此我们这里肯定是没有的。因为我们的项目混合了2钟路由配置,而自定义的方法是针对基于公约的路由配置,因此对于Attribute Routing我们直接使用默认的选择方式:

在“var controllerName = routeData.Values["controller"].ToString(); ”代码之前加一个判断:

if (string.IsNullOrWhiteSpace(routeData.Route.RouteTemplate))
{
return base.SelectController(request);
}

再次请求就会得到如下结果:

结果正确,解决方案感觉还可以再考虑考虑,大家有什么好的建议可以提。但是不管怎么说,有一点是明确的:对于基于特性的路由规则,不需要包含Controller的名字,在本案列中感觉上是寻找Acton上的路由模板来匹配请求的URI,然后确定对应的Action。

总结

基于特性路由(Attribute Routing)是一种新的定制路由规则方式,与传统的配置方式相比更灵活,但同时比较分散,在web api中,2钟路由配置方式可以共存,所以本文只是介绍一种新的配置方式,做项目时也可以多一种选择。

本文参考相关链接:http://www.cnblogs.com/aehyok/p/3449851.html

http://www.cnblogs.com/artech/p/attribute-routing-01.html

源码地址:https://github.com/fzrain/WebApi.eLearning

Attribute Routing的更多相关文章

  1. 使用ASP.NET Web Api构建基于REST风格的服务实战系列教程【外传】——Attribute Routing

    系列导航地址http://www.cnblogs.com/fzrain/p/3490137.html 题外话:由于这个技术点是新学的,并不属于原系列,但借助了原系列的项目背景,故命名外传系列,以后也可 ...

  2. WebApi 2:属性路由 [Route()],attribute routing

    原文:http://www.asp.net/web-api/overview/web-api-routing-and-actions/attribute-routing-in-web-api-2 属性 ...

  3. WebApi2官网学习记录---Attribute Routing

    从WebApi 1迁移到WebAPI 2要改变配置代码如下: WebApi 1: protected void Application_Start() { // WARNING - Not compa ...

  4. Web API 路由 [二] Attribute Routing

    1) 启用.在App_Start - WebApiConfig.cs下 //在Register函数添加如下代码: config.MapHttpAttributeRoutes(); 2) 使用.Cont ...

  5. ASP.NET Web API 2中的属性路由(Attribute Routing)

    如何启用属性路由并描述属性路由的各种选项? Why Attribute Routing? Web API的第一个版本使用基于约定的路由.在这种类型的路由中,您可以定义一个或多个路由模板,这些模板基本上 ...

  6. Create a REST API with Attribute Routing in ASP.NET Web API 2

    原文:http://www.asp.net/web-api/overview/web-api-routing-and-actions/create-a-rest-api-with-attribute- ...

  7. [译] ASP.NET MVC 6 attribute routing – the [controller] and [action] tokens

    原文:http://www.strathweb.com/2015/01/asp-net-mvc-6-attribute-routing-controller-action-tokens/ 当在Web ...

  8. ASP.NET Web API 中 特性路由(Attribute Routing) 的重名问题

    刚才忘了说了,在控制器名重名的情况下,特性路由是不生效的.不然的话就可以利用特性路由解决同名的问题了. 而且这种不生效是真的不生效,不会提示任何错误,重名或者什么的,直接会报告404,所以也是个坑.

  9. ASP.NET Web API 2.0新特性:Attribute Routing1

    ASP.NET Web API 2.0新特性:Attribute Routing[上篇] 对于一个针对ASP.NET Web API的调用请求来说,请求的URL和对应的HTTP方法的组合最终决定了目标 ...

随机推荐

  1. 详细解释VB连接access几种方法数据库

    在VB中,连接ACCESS数据库的方法主要有以下三种 使用ADO对象,通过编写代码訪问数据库 Connection 对象 ODBC数据源 使用ADO Data 控件高速创建数据库连接 有三种连接方法 ...

  2. [Android 4.4.3] 泛泰A870 Mokee4.4.3 20140610 RC2.0 通过刷第三版 by syhost

    欢迎关注泛泰非盈利专业第三方开发团队 VegaDevTeam  (本team 由 syhost suky zhaochengw(z大) xuefy(大星星) tenfar(R大师) loogeo cr ...

  3. react.js 从零开始(五)React 中事件的用法

    事件系统   虚拟事件对象 事件处理器将会传入虚拟事件对象的实例,一个对浏览器本地事件的跨浏览器封装.它有和浏览器本地事件相同的属性和方法,包括 stopPropagation() 和 prevent ...

  4. 模拟linux下的ls -l命令

    #include <stdio.h> #include <stdlib.h> #include <string.h> #include <unistd.h&g ...

  5. 我的MYSQL学习心得(五)

    原文:我的MYSQL学习心得(五) 我的MYSQL学习心得(五) 我的MYSQL学习心得(一) 我的MYSQL学习心得(二) 我的MYSQL学习心得(三) 我的MYSQL学习心得(四) 我的MYSQL ...

  6. Codeforces 135A-Replacement(思维)

    A. Replacement time limit per test 2 seconds memory limit per test 256 megabytes input standard inpu ...

  7. C++语言债券系列之十一——友元函数和拷贝构造函数

    1.好友功能 (1)友元函数类的普通功能外定义. 定义友元函数和相同的正常功能.在类必须声明的正常功能为好友. (2)友元函数不是一个成员函数. 你不能反对打电话.但直接调用:友元函数访问类的公共.p ...

  8. EpPlus读取生成Excel帮助类+读取csv帮助类+Aspose.Cells生成Excel帮助类

    大部分功能逻辑都在,少量自定义异常类和扩展方法 ,可用类似代码自己替换 //EpPlus读取生成Excel帮助类+读取csv帮助类,epplus只支持开放的Excel文件格式:xlsx,不支持 xls ...

  9. EF中的EntityState几个状态的说明

    之前使用EF,我们都是通过调用SaveChanges方法把增加/修改/删除的数据提交到数据库,但是上下文是如何知道实体对象是增加.修改还是删除呢?答案是通过EntityState枚举来判断的,我们看一 ...

  10. C# 反射技术应用

    反射(Reflection)是.NET中的重要机制,通过放射,可以在运行时获得.NET中每一个类型(包括类.结构.委托.接口和枚举等)的成员,包括方法.属性.事件,以及构造函数等.还可以获得每个成员的 ...