[Web API] Web API 2 深入系列(4) Action的选择
目录
ApiController
HttpActionDescriptor
IHttpActionSelector
ApiController
在上节中,讲到如何选择并激活对应的IHttpController,而一般我们在开发中使用的是ApiController
public abstract class ApiController : IHttpController, IDisposable
{
public virtual Task<HttpResponseMessage> ExecuteAsync(HttpControllerContext controllerContext, CancellationToken cancellationToken)
{
this.Initialize(controllerContext);
HttpActionDescriptor actionDescriptor = services.GetActionSelector().SelectAction(controllerContext);
HttpActionContext actionContext = new HttpActionContext(controllerContext,actionDescriptor);
return services.GetActionInvoker().InvokeActionAsync(actionContext, cancellationToken);
}
}
在ApiController中,我们看到通过内置的DI容器选择出对应的HttpActionDescriptor.本节重点内容就是介绍SelectAction方法.
HttpActionDescriptor
在介绍IHttpActionSelector前,我们需要了解HttpActionDescriptor
public abstract class HttpActionDescriptor
{
//相关联的HttpControllerDescriptor
public HttpControllerDescriptor ControllerDescriptor { get; } { set; }
//Action名称(通过使用ActionName特性,Action名称可以和方法名称不同)
public abstract string ActionName { get; }
//Action返回值类型(void为null)
public abstract Type ReturnType { get; }
//支持的HttpMethod(默认一个Action方法支持一种HttpMethod,且默认为Post Method,可以使用AcceptVerbs特性支持多个)
public virtual Collection<HttpMethod> SupportedHttpMethods { get; }
//Action方法所有参数
public abstract Collection<HttpParameterDescriptor> Parameters { get; };
}
而HttpActionDescriptor默认实现为ReflectedHttpActionDescriptor,这里稍微展示下初始化HttpActionDescriptor过程
public class ReflectedHttpActionDescriptor : HttpActionDescriptor
{
//初始化HttpActionDescriptor的属性
public ReflectedHttpActionDescriptor(HttpControllerDescriptor controllerDescriptor, MethodInfo methodInfo)
: base(controllerDescriptor)
{
this.InitializeProperties(methodInfo);
this._parameters = new Lazy<Collection<HttpParameterDescriptor>>(() => this.InitializeParameterDescriptors());
}
private Collection<HttpParameterDescriptor> InitializeParameterDescriptors()
{
return this.ParameterInfos.Select(item => new ReflectedHttpParameterDescriptor((HttpActionDescriptor) this, item)).ToList();
}
}
IHttpActionSelector
IHttpActionSelector是选择Action最核心的类
public interface IHttpActionSelector
{
//选择符合标准的Action
HttpActionDescriptor SelectAction(HttpControllerContext controllerContext);
//获取HttpController所有Action
ILookup<string, HttpActionDescriptor> GetActionMapping(HttpControllerDescriptor controllerDescriptor);
}
IHttpActionSelector默认的实现为ApiControllerActionSelector
public class ApiControllerActionSelector : IHttpActionSelector
{
ILookup<string, HttpActionDescriptor> GetActionMapping(HttpControllerDescriptor controllerDescriptor);
{
//找到所有符合要求的方法
var methods = controllerDescriptor.ControllerType
.GetMethods(BindingFlags.Instance | BindingFlags.Public), methodInfo =>
!methodInfo.IsSpecialName && !methodInfo.GetBaseDefinition().DeclaringType.IsAssignableFrom(TypeHelper.ApiControllerType)
&& methodInfo.GetCustomAttribute<NonActionAttribute>() == null);
return methods.Select(method => new HttpActionDescriptor(controllerDescriptor,method))...;
}
}
注意:GetActionMapping会在请求每个HttpController第一次的时候 缓存当前所有HttpActionDescriptor
当我们找到HttpController下所有HttpActionDescriptor,还需要最后一步通过SelectAction筛选出最终的Action
由于这块源码稍微复杂,这里把关键的几步及对应的方法名说明下
public virtual HttpActionDescriptor SelectAction(HttpControllerContext controllerContext)
{
1. Action名称过滤
如果路由中配置Action变量,则会先过滤ActionName.调用方法GetInitialCandidateList
2. Http方法过滤
对于Get Put Post默认都通过,调用方法FindActionsForVerb
3. 必须的参数能绑定上
在Action方法上的必须参数,在路由参数和Request参数中能获取到,调用方法FindActionMatchRequiredRouteAndQueryParameters
4. 参数个数符合最多的匹配
当多个Action方法都满足以上3个条件时,取最多参数符合的那个,调用方法FindActionMatchMostRouteAndQueryParameters
5. 取唯一匹配
最终匹配结果为1个Action方法则成功,多个或零失败,在SelectAction方法本身调用
}
这里稍微举个例子来解释SelectAction
public class DemoController : ApiController
{
public string Get(int x)
public string Get(int x, int y)
public string Get(string x, string y)
public string Get(string x, string y, string z)
}
分别请求如下地址,并列出对应的匹配方法
demo?x=1 OK
public string Get(int x)
demo?x=1&y=2 Erro
public string Get(int x, int y)
public string Get(string x, string y)
demo?x=1&y=2&z=3 OK
public string Get(string x, string y, string z)
(OK表示请求成功,Erro表示请求失败)
备注:
- Action的选择明显比Controller的激活要复杂
- 文章中的代码并非完整WebAPI代码,一般是经过自己精简后的.
- 本篇内容使用MarkDown语法编辑
首发地址:http://neverc.cnblogs.com/p/5956432.html
[Web API] Web API 2 深入系列(4) Action的选择的更多相关文章
- ASP.NET Web API - ASP.NET MVC 4 系列
Web API 项目是 Windows 通信接口(Windows Communication Foundation,WCF)团队及其用户激情下的产物,他们想与 HTTP 深度整合.WCF ...
- 如何用Baas快速在腾讯云上开发小程序-系列1:搭建API & WEB WebSocket 服务器
版权声明:本文由贺嘉 原创文章,转载请注明出处: 文章原文链接:https://www.qcloud.com/community/article/221059001487422606 来源:腾云阁 h ...
- Java web与web gis学习笔记(二)——百度地图API调用
系列链接: Java web与web gis学习笔记(一)--Tomcat环境搭建 Java web与web gis学习笔记(二)--百度地图API调用 JavaWeb和WebGIS学习笔记(三)-- ...
- HTML5权威指南--Web Storage,本地数据库,本地缓存API,Web Sockets API,Geolocation API(简要学习笔记二)
1.Web Storage HTML5除了Canvas元素之外,还有一个非常重要的功能那就是客户端本地保存数据的Web Storage功能. 以前都是用cookies保存用户名等简单信息. 但是c ...
- 初试ASP.NET Web API/MVC API(附Demo)
写在前面 HTTP RESTful 创建Web API 调用Web API 运行截图及Demo下载 ASP.NET Web API是一个框架,可以很容易构建达成了广泛的HTTP服务客户端,包括浏览 ...
- 我所理解的RESTful Web API [Web标准篇]
REST不是一个标准,而是一种软件应用架构风格.基于SOAP的Web服务采用RPC架构,如果说RPC是一种面向操作的架构风格,而REST则是一种面向资源的架构风格.REST是目前业界更为推崇的构建新一 ...
- 重构Web Api程序(Api Controller和Entity)续篇
昨天有写总结<重构Web Api程序(Api Controller和Entity)>http://www.cnblogs.com/insus/p/4350111.html,把一些数据交换的 ...
- web api写api接口时返回
web api写api接口时默认返回的是把你的对象序列化后以XML形式返回,那么怎样才能让其返回为json呢,下面就介绍两种方法: 方法一:(改配置法) 找到Global.asax文件,在Applic ...
- Google Maps API Web Services
原文:Google Maps API Web Services 摘自:https://developers.google.com/maps/documentation/webservices/ Goo ...
随机推荐
- jquery如何获取第一个或最后一个子元素?
通过children方法,children("input:first-child") 1 2 $(this).children("input:first-child&qu ...
- 每周一书-《鸟哥的Linux私房菜》获奖公布
<鸟哥的Linux私房菜>一书的赠书活动时间为2016年10月19日到10月31日, 也就是今天结束. 首先要感谢QQ号为:1084830483(路在远方),来自哈尔滨工程大学的同学赠送给 ...
- 《3D Math Primer for Graphics and Game Development》读书笔记2
<3D Math Primer for Graphics and Game Development>读书笔记2 上一篇得到了"矩阵等价于变换后的基向量"这一结论. 本篇 ...
- 《Entity Framework 6 Recipes》中文翻译系列 (26) ------ 第五章 加载实体和导航属性之延缓加载关联实体和在别的LINQ查询操作中使用Include()方法
翻译的初衷以及为什么选择<Entity Framework 6 Recipes>来学习,请看本系列开篇 5-7 在别的LINQ查询操作中使用Include()方法 问题 你有一个LINQ ...
- 使用angular中ng-repeat , track by的用处
我们见到最简单的例子是: <div ng-repeat="link in links" ></div> 如果item的值有重复的,比如links=[&quo ...
- Vue脚手架工具vue-cli和调试组件vue-devtools
https://github.com/vuejs/vue-cli npm install vue-cli -g vue init webpack my-project cd my-project // ...
- SSISDB6:Operation
SSISDB使用Operation表示对SSIS Project所做的任何操作,在执行一次Operation时,SSISDB会记录Operation的Message,当触发Event时,会记录Even ...
- php的mysql\mysqli\PDO(二)mysqli
原文链接:http://www.orlion.ga/1147/ mysqli有面向对象风格和面向过程风格,个人感觉还是用面向对象风格比较好(毕竟是面向对象) 1.mysqli::_construct( ...
- 浏览器内核、渲染引擎、js引擎
[1]定义 浏览器内核分成两部分渲染引擎和js引擎,由于js引擎越来越独立,内核就倾向于只指渲染引擎 渲染引擎是一种对HTML文档进行解析并将其显示在页面上的工具 [2]常见引擎 渲染引擎: fire ...
- Eclipse迁移到Android studio步骤如下:
一.从Eclipse中导出:1.将你的ADT插件版本升级到22.0以上.2.在Eclipse中,选择File-->Export.3.在弹出的导出窗口中,打开Android的文件夹,选择“Gene ...