ASP.NET Web API是如何根据请求选择Action的?[上篇] 【转】
http://www.cnblogs.com/leo_wl/p/3316548.html
ASP.NET Web API是如何根据请求选择Action的?[上篇]
Web API的调用请求总是针对定义在某个HttpController中的某个Action方法,请求响应的内容来源于调用目标Action方法的执行结果。 当ASP.NET Web API为当前请求成功激活目标HttpController之后,后续的操作就是为请求在该HttpController中选择出对应的Action方 法。[本文已经同步到《How ASP.NET Web API Works?》]
HttpActionSelector
在对用于描述定义在HttpController中的Action方法的HttpActionDescriptor对象具有充分了解之后,我们开始 正式介绍真正用于选择目标Action方法的HttpActionSelector对象。ASP.NET Web API中的HttpActionSelector均实现了IHttpActionSelector接口。
1: public interface IHttpActionSelector
2: {
3: ILookup<string, HttpActionDescriptor> GetActionMapping(HttpControllerDescriptor controllerDescriptor);
4: HttpActionDescriptor SelectAction(HttpControllerContext controllerContext);
5: }
如上面的代码片断所示,IHttpActionSelector接口中定义了两个方法。GetActionMapping方法返回定义在指定 HttpController中所有Action与其名称的映射。该方法唯一的参数表示用于描述目标HttpController的 HttpControllerDescriptor对象,返回类型ILookup<string, HttpActionDescriptor>,其Key和Element分别表示Action的名称和用于描述Action方法的 HttpActionDescriptor对象。
由于同一个HttpController类型中可以定义多个同名的Action方法重载,我们也可以通过ActionNameAttribute特 性为多个Action方法指定相同的Action名称,所以多个Action方法可以共享相同的名称,所以GetActionMapping方法才会返回 一个ILookup<string, HttpActionDescriptor>对象。
针对请求对目标Action的选择实现在SelectAction方法中,作为该方法唯一参数的是表示当前HttpController上下文的 HttpControllerContext对象,我们可以从中获取表示当前请求的HttpRequestMessage对象和通过ASP.NET Web API路由系统生成的HttpRouteData。该方法返回的HttpActionDescriptor正是对最终用于处理当前请求的Action方法 的描述。
ApiControllerActionSelector
与我们在前面介绍的众多“标准化组件”一样,ASP.NET Web API默认用于选择目标Action的HttpActionSelector也是注册在当前的ServicesContainer中,我们可以直接通过 ServicesContainer具有如下定义的扩展方法GetActionSelector得到这个注册的HttpActionSelector。
1: public static class ServicesExtensions
2: {
3: //其他成员
4: public static IHttpActionSelector GetActionSelector(this ServicesContainer services);
5: }
通过分析如下所示的DefaultServices构造函数的定义我们知道默认使用的HttpActionSelector是一个类型为ApiControllerActionSelector的对象。
1: public class DefaultServices : ServicesContainer
2: {
3: // 其他成员
4: public DefaultServices(HttpConfiguration configuration)
5: {
6: //其他操作
7: this.SetSingle<IHttpActionSelector>(new ApiControllerActionSelector());
8: }
9: }
ApiControllerActionSelector定义在“System.Web.Http.Controllers”命名空间下,基本的成员定义如下所示。
1: public class ApiControllerActionSelector : IHttpActionSelector
2: {
3: public ApiControllerActionSelector();
4: public virtual ILookup<string, HttpActionDescriptor> GetActionMapping(HttpControllerDescriptor controllerDescriptor);
5: public virtual HttpActionDescriptor SelectAction(HttpControllerContext controllerContext);
6: }
有效的Action方法
现在我们来着重讨论ApiControllerActionSelector的GetActionMapping方法的实现。实现逻辑其实很简单:它 通过作为参数的HttpControllerDescriptor得到HttpController的真实类型,并调用GetMethods方法获得描述 所有方法成员MethodInfo列表,然后从中筛选出所有“有效”的Action方法并以此创建 ReflectedHttpActionDescriptor对象。那么一个有效的Action方法具有怎样的“资质”呢?
对于一个实现了IHttpController接口的HttpController类型来说,其拥有的所有MethodInfo必须同时满足如下的条件才会被视为有效的Action方法并被用于创建对应的HttpActionDescriptor对象:
- 必须是公有的实例方法。
- MethodInfo的IsSpecialName属性值为False(表示属性成员Getter和Setter的MethodInfo不会被用于创建HttpActionDescriptor)。
- 从ApiController类型中继承的方法不是有效的Action方法
所有有效的MethodInfo被选择出来并连同指定的HttpControllerDescriptor一起生成一组 ReflectedHttpActionDescriptor对象集合,它被转换成一个ILookup<string, HttpActionDescriptor>对象后直接作为GetActionMapping方法的返回值。如下的代码片断基本反映了 GetActionMapping方法中最初生成HttpActionDescriptor与其Action名称映射的逻辑。
1: public class ApiControllerActionSelector : IHttpActionSelector
2: {
3: //其他成员
4: public ILookup<string, HttpActionDescriptor> GetActionMapping(HttpControllerDescriptor controllerDescriptor)
5: {
6: IEnumerable<ReflectedHttpActionDescriptor> actionDescriptor =
7: from method in controllerDescriptor.ControllerType.GetMethods()
8: where method.IsPublic && !method.IsStatic && !method.IsSpecialName&& !method.DeclaringType.IsAssignableFrom(typeof(ApiController))
9: select new ReflectedHttpActionDescriptor(controllerDescriptor,method);
10: return actionDescriptor.ToLookup(action => action.ActionName, action => (HttpActionDescriptor)action);
11: }
12: }
为了避免频繁、重复地对类型的方法成员进行反射而影响性能,定义在上面代码片断的操作仅仅会在第一次调用GetActionMapping方法时被执行。生成的ReflectedHttpActionDescriptor会被缓存起来以服务于后续调用。
ActionMethodSelector
HttpActionSelector的终极目标是根据当前请求从目标HttpController中选择出正确的Action方法,这个目标实现 在它的SelectAction方法中。在系统介绍实现在ApiControllerActionSelector的SelectAction方法中的 Action选择机制之前,我们还需要了解另一个与之相关的对象:ActionMethodSelector。
ActionMethodSelector的目的在于判断某个Action方法是否与当前请求相匹配,它们均实现了具有 如下定义的IActionMethodSelector接口。IActionMethodSelector仅仅是定义在程序集 System.Web.Http.dll中的一个内部接口而已,它定义了一个唯一的方法IsValidForRequest,方法的两个参数分别是表示当 前 HttpController上下文的HttpControllerContext对象和代码目标Action方法的MethodInfo。执行该方法得 到的布尔值表明目标Action方法是否能够用于处理当前请求。
1: internal interface IActionMethodSelector
2: {
3: bool IsValidForRequest(HttpControllerContext controllerContext, MethodInfo methodInfo);
4: }
ASP.NET Web API仅仅定义了唯一一个实现了这个IActionMethodSelector接口的类型,它就是具有如下定义的NonActionAttribute。顾名思义,如果在某个方法上应用了这个特性,意味着目标方法不是一个合法的Action方法。从给出的代码片断可以看出NonActionAttribute直接在实现的IsValidForRequest方法中返回False。
1: [AttributeUsage(AttributeTargets.Method, AllowMultiple=false, Inherited=true)]
2: public sealed class NonActionAttribute : Attribute, IActionMethodSelector
3: {
4: bool IActionMethodSelector.IsValidForRequest(HttpControllerContext controllerContext, MethodInfo methodInfo)
5: {
6: return false;
7: }
8: }
对于NonActionAttribute特性来说,有一点值得强调:虽然应用了该特性的方法被认为不再是一个合法的Action方法,但是ApiControllerActionSelector的GetActionMapping方法并不会使用它来判断Action方法的有效性。
在《下篇》中我们将以实例的形式讨论该主题最为核心的内容:ASP.NET Web API如何利用HttpActionSelector在目标HttpController成功激活之后如何从中选择出匹配的Action方法来处理当前的请求的。
ASP.NET Web API是如何根据请求选择Action的?[上篇] 【转】的更多相关文章
- ASP.NET Web API是如何根据请求选择Action的?[下篇]
ASP.NET Web API是如何根据请求选择Action的?[下篇] 再<上篇>中我们简单介绍了用于实现Action选择机制的HttpActionSelector,接下来我们来讨论本章 ...
- ASP.NET Web API是如何根据请求选择Action的?[上篇]
ASP.NET Web API是如何根据请求选择Action的?[上篇] Web API的调用请求总是针对定义在某个HttpController中的某个Action方法,请求响应的内容来源于调用目标A ...
- ASP.NET Web API是如何根据请求选择Action的?[下篇] 【转】
再<上篇>中我们简单介绍了用于实现Action选择机制的HttpActionSelector,接下来我们来讨论本章最为核心的内 容:ASP.NET Web API如何利用HttpActio ...
- Self Host模式下的ASP. NET Web API是如何进行请求的监听与处理的?
构成ASP.NET Web API核心框架的消息处理管道既不关心请求消息来源于何处,也不需要考虑响应消息归于何方.当我们采用Web Host模式将一个ASP.NET应用作为目标Web API的宿主时, ...
- 【转】WCF和ASP.NET Web API在应用上的选择
文章出处:http://www.cnblogs.com/shanyou/archive/2012/09/26/2704814.html 在最近发布的Visual Studio 2012及.NET 4. ...
- WCF和ASP.NET Web API在应用上的选择
小分享:我有几张阿里云优惠券,用券购买或者升级阿里云相应产品最多可以优惠五折!领券地址:https://promotion.aliyun.com/ntms/act/ambassador/shareto ...
- [转载]WCF和ASP.NET Web API在应用上的选择
http://www.cnblogs.com/shanyou/archive/2012/09/26/2704814.html http://msdn.microsoft.com/en-us/libra ...
- WCF和ASP.NET Web API在应用上的选择(转)
出处:http://www.cnblogs.com/shanyou/archive/2012/09/26/2704814.html 在最近发布的Visual Studio 2012及.NET 4.5中 ...
- ASP.NET Web API 2.0新特性:Attribute Routing1
ASP.NET Web API 2.0新特性:Attribute Routing[上篇] 对于一个针对ASP.NET Web API的调用请求来说,请求的URL和对应的HTTP方法的组合最终决定了目标 ...
随机推荐
- javascript计算两个时间的差
function GetDateDiff(startTime, endTime, diffType) { //将xxxx-xx-xx的时间格式,转换为 xxxx/xx/xx的格式 startTime ...
- winform DataGridView添加合计行
使用方法 /* DataTable dt= DBUtility.DB.FromSql(sql).ToDataTable(); DataGridViewAddSumRow sumRow = new Da ...
- 利用js生成二维码
$('#barcode').qrcode({ width: 300, height: 300, render: !!document.createElement('canvas').getContex ...
- Servlet+Json代码
package com.brmoney.servlet; import java.io.IOException; import java.io.PrintWriter; import java.uti ...
- 【bzoj5018】[Snoi2017]英雄联盟 背包dp
题目描述 正在上大学的小皮球热爱英雄联盟这款游戏,而且打的很菜,被网友们戏称为「小学生」.现在,小皮球终于受不了网友们的嘲讽,决定变强了,他变强的方法就是:买皮肤!小皮球只会玩N个英雄,因此,他也只准 ...
- 洛谷 [P3377] 左偏树(可并堆)
可并堆,就是可以合并的堆 注意并查集不能路径压缩,不然删除根节点时会出错 #include <iostream> #include <cstring> #include < ...
- 显示3行,还要省略号(这个属性比较合适WebKit浏览器或移动端(绝大部分是WebKit内核的)浏览器)
div{ overflow : hidden; text-overflow: ellipsis; display: -webkit-box; -webkit-line-clamp:; -webkit- ...
- t4-editor使用方法 Visual T4
原文发布时间为:2011-05-17 -- 来源于本人的百度文章 [由搬家工具导入] http://visualstudiogallery.msdn.microsoft.com/40a887aa-f3 ...
- css3 实现多行文本折行
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8&quo ...
- JDBC加载驱动的方法+statement
加载驱动方法 1.Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver"); 2. DriverManager.r ...