专栏首页大内老AASP.NET Web API中的Controller

ASP.NET Web API中的Controller

虽然通过Visual Studio向导在ASP.NET Web API项目中创建的 Controller类型默认派生与抽象类型ApiController,但是ASP.NET Web API框架本身只要求它实现IHttpController接口即可,所以我们将其统称为HttpController。既然HttpController指的是所有实现了IHttpController接口的类型,我们自然得先来了解一下这个接口的定义。如下面的代码片断所示,在IHttpController接口中仅仅定义了唯一的方法ExecuteAsync方法,它以异步的方式执行HttpController,并返回一个Task<HttpResponseMessage>对象。[本文已经同步到《How ASP.NET Web API Works?》]

   1: public interface IHttpController
   2: {
   3:     Task<HttpResponseMessage> ExecuteAsync(HttpControllerContext controllerContext, CancellationToken cancellationToken);
   4: }

HttpController可以视为对ASP.NET Web API的消息处理管道的延续。通过“ASP.NET Web API标准的“管道式”设计”的介绍我们知道位于管道末端的是一个HttpRoutingDispatcher对象。当SendAsync方法被执行的时候,HttpRoutingDispatcher会利用隶属于它的HttpControllerDispatcher来激活目标HttpController对象,随后调用该对象的ExecuteAsync方法并将返回的Task<HttpResponseMessage>对象作为返回值。右图揭示了包含激活的HttpController在内的消息处理管道的结构。

一、HttpControllerContext

与HttpMessageHandler的SendAsync方法有所不同,HttpController的ExecuteAsync方法并没有一个表示请求的类型为HttpRequestMessage的参数,取而代之的是一个HttpControllerContext类型的参数。HttpControllerContext定义在命名空间“System.Web.Http.Controllers”下,表示执行HttpController的上下文。

如下面的代码片断所示,通过定义在HttpControllerContext中的属性我们可以得到用于配置消息处理管道的HttpConfiguration对象和封装路由数据的HttpRouteData对象,以及表示当前请求的HttpRequestMessage对象。这三个属性可以在构建HttpControllerContext的时候直接通过构造函数的参数指定,我们也可以先创建一个空的HttpControllerContext对象之后直接对这些属性赋值。

   1: public class HttpControllerContext
   2: {
   3:     public HttpControllerContext();
   4:     public HttpControllerContext(HttpConfiguration configuration, IHttpRouteData routeData, HttpRequestMessage request);   
   5:     
   6:     public HttpConfiguration         Configuration { get; set; }
   7:     public IHttpRouteData            RouteData { get; set; }
   8:     public HttpRequestMessage        Request { get; set; }
   9:  
  10:     public IHttpController              Controller { get; set; }
  11:     public HttpControllerDescriptor     ControllerDescriptor { get; set; }
  12: }

一个HttpControllerContext对象表示执行HttpController的上下文,我们可以通过Controller属性来获取或者设置这个HttpController对象。除此之外,我们还可以利用另一个属性ControllerDescriptor获取或者设置用于描述HttpController的HttpControllerDescriptor对象(类型HttpControllerDescriptor定义在命名空间“System.Web.Http.Controllers”下)。

二、HttpControllerDescriptor

HttpControllerDescriptor封装了某个HttpController类型的元数据,我们可以将它视为某个HttpController类型的描述对象。HttpControllerDescriptor具有根据元数据创建对应HttpController的能力,实际上ASP.NET Web API的HttpController激活系统就是根据HttpControllerDescriptor来创建目标HttpController的。

如下面的代码片断所示,我们可以通过HttpControllerDescriptor的属性Configuration、ControllerName和ControllerType获取当前的HttpConfiguration对象和被描述HttpController的名称和类型。这三个属性可以在构建HttpControllerDescriptor时通过构造函数的参数显式指定,也可以先构建一个空的HttpControllerDescriptor对象,然后手工设置这些属性。

   1: public class HttpControllerDescriptor
   2: {   
   3:     public HttpControllerDescriptor();
   4:     public HttpControllerDescriptor(HttpConfiguration configuration, string controllerName, Type controllerType);
   5:  
   6:     public virtual IHttpController CreateController(HttpRequestMessage request);
   7:  
   8:     public virtual Collection<T> GetCustomAttributes<T>() where T: class;
   9:     public virtual Collection<T> GetCustomAttributes<T>(bool inherit) where T: class;
  10:     public virtual Collection<IFilter> GetFilters();
  11:    
  12:     public HttpConfiguration     Configuration { get; set; }
  13:     public string                ControllerName { get; set; }
  14:     public Type                  ControllerType { get; set; }
  15:  
  16:     public virtual ConcurrentDictionary<object, object> Properties { get; }
  17: }

HttpControllerDescriptor具有创建HttpController的能力主要体现在其CreateController方法上,该方法完成了目标方法的激活。换句话说,目标HttpController的激活是通过调用描述它的HttpControllerDescriptor对象的CreateController方法完成的。本章的核心就在于剖析此方法的实现逻辑。

我们可以通过HttpControllerDescriptor的GetCustomAttributes<T>方法得到应用在被描述HttpController类型上指定类型的特性列表。调用另一个方法GetFilters可以获取应用到目标HttpController类型上的所有Filter,Filter在ASP.NET Web API中是一个非常重要的概念,同时也是一种常见的扩展方式,我们会在本书第12章“过滤器”中对Filter进行单独介绍。

HttpControllerDescriptor还具有一个字典类型的只读属性Properties,它使我们可以将任何一个对象附加到某个HttpControllerDescriptor上。我们在HttpRequestMessage和HttpConfiguration类型中已经看到过了类似的设计。

三、ApiController

我们现在来介绍一下我们创建HttpController类型默认继承的基类ApiController。如下面的代码片断所示,除了实现接口IHttpController外,HttpController还采用标准的方式实现了另一个接口IDisposable。如果自定义HttpController需要实现一些资源回收的工作,可以将它们定义在重写的(受保护的)虚方法Dispose中。

   1: public abstract class ApiController : IHttpController, IDisposable
   2: {
   3:     public virtual Task<HttpResponseMessage> ExecuteAsync(HttpControllerContext controllerContext, CancellationToken cancellationToken);
   4:     protected virtual void Initialize(HttpControllerContext controllerContext);
   5:     
   6:     public void Dispose();
   7:     protected virtual void Dispose(bool disposing);
   8:   
   9:     public HttpControllerContext     ControllerContext { get; set; }
  10:     public HttpConfiguration         Configuration { get; set; }
  11:     public HttpRequestMessage        Request { get; set; }
  12:     public IHttpRouteData            RouteData { get; set; }
  13:  
  14:     public ModelStateDictionary     ModelState { get; }
  15:     public UrlHelper                Url { get; set; }
  16:     public IPrincipal               User { get; }
  17: }

ApiController的三个属性Configuration、Request和RouteData与此HttpControllerContext对象的同名属性具有相同的引用。表示执行当前ApiController上下文的HttpControllerContext对象可以通过ControllerContext属性获取,这是一个可读写的属性,意味着我们也可以通过设置该属性为其指定相应的上下文。如果我们没有对ControllerContext属性进行显式设置,该属性会在第一次被获取时被自动赋值。

ApiController的只读属性ModelState返回一个具有字典数据结构的ModelStateDictionary对象,包含其中的数据会被以“Model绑定”的形式绑定到目标Action方法的对应的参数。除此之外,此ModelStateDictionary还用于保存参数验证失败后的错误消息。另一个参数Url返回一个类型为UrlHelper的对象(UrlHelper定义在命名空间“System.Web.Http.Routing”下),我们利用它可以根据注册的HttpRoute和提供的路由变量生成一个完整的URL。

ApiController的User属性返回当前线程的Principal。相信读者还会记得在本书第3章“消息处理管道”中介绍HttpServer时我们谈到:如果当前线程的Principal为Null,作为消息处理管道“龙头”的HttpServer会在SendAsync方法执行过程中创建一个空的GenericPrincipal对象作为当前线程的“匿名”Principal。所以对于匿名请求来说,这个User属性会返回这个通过HttpServer设置的空GenericPrincipal对象。

从上面给出的代码片断我们还会看到ApiController包含一个受保护的Initialize方法,它会根据由指定HttpControllerContext提供的上下文信息对自身作相应的初始化。一旦Initialize方法被成功执行,当前ApiController对象将处于初始化状态。此Initialize在默认情况下会在实现的ExecuteAsync方法中被自动调用。在默认情况下,ASP.NET Web API的HttpController激活系统总是创建一个新的HttpController来处理每一个请求。对于其类型继承自ApiController的HttpController来说,如果在执行ExecuteAsync方法的时候发现当前的ApiController已经处于“初始化”的状态,系统会直接抛出一个InvalidOperationException异常。

举个简单的例子,假设我们定义了如下一个继承自ApiController的DemoController类型,并通如下的方式将原本为受保护的Initialize方法转换成一个公有方法,以方便我们后续的调用。

   1: public class DemoController : ApiController
   2: {
   3:     public new void Initialize(HttpControllerContext controllerContext)
   4:     {
   5:         base.Initialize(controllerContext);
   6:     }
   7: }

然后我们执行如下一段代码,它的特别之处在于在调用DemoController对象的ExecuteAsync方法之前调用了Initialize方法对其作了初始化处理。

   1: DemoController controller = new DemoController ();
   2: HttpControllerContext controllerContext = new HttpControllerContext(new HttpConfiguration(), new HttpRouteData(new HttpRoute()), new HttpRequestMessage());
   3: controller.ControllerContext = controllerContext;
   4: controller.Initialize(controllerContext);
   5: controller.ExecuteAsync(controllerContext, new CancellationToken(false));

当执行ApiController的ExecuteAsync方法的时候会抛出如右图所示的InvalidOperation异常,并提示“Cannot reuse an 'ApiController' instance. 'ApiController' has to be constructed per incoming message. Check your custom 'IHttpControllerActivator' and make sure that it will not manufacture the same instance.”错误消息已经表明了ApiController是不能“重用”的,用于处理每一个请求的ApiController都应该是“全新”的。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • WCF服务端运行时架构体系详解[续篇]

    终结点分发器在自己的运行时中对请求消息的处理最终肯定体现在相应操作的执行。如果从服务描述的角度来看,操作是一个OperationDescription对象。而服...

    蒋金楠
  • WCF技术剖析之十二:数据契约(Data Contract)和数据契约序列化器(DataContractSerializer)

    大部分的系统都是以数据为中心的(Data Central),功能的实现表现在对相关数据的正确处理。而数据本身,是有效信息的载体,在不同的环境具有不同的表示。一个...

    蒋金楠
  • 通过扩展改善ASP.NET MVC的验证机制[实现篇]

    在《使用篇》中我们谈到扩展的验证编程方式,并且演示了本解决方案的三大特性:消息提供机制的分离、多语言的支持和多验证规则的支持,我们现在来看看这样的验证解决方案最...

    蒋金楠
  • 步步为营:三层架构+ASP.NET MVC 架构的快速搭建(入门篇)

    上一篇博客中《两天完成一个小型工程报价系统》,许多朋友向我讨源码。其实我之后没发了,确实那种三层架构没什么意思,只是我个人的孤芳自赏,很多的处理都不是很成熟。...

    用户1161731
  • SPA初试-1

    即每一个页面对应着一个状态,一个状态有一个状态名,还有一个模板/模板url,这样我们就可以将不同页面的内容写到不同的html里,然后通过templateUrl将...

    嘿嘿嘿
  • 一天一个设计模式:装饰者模式

    装饰者模式又称为包装(wrapper)模式。装饰者模式对客户端透明的方式扩展对象的功能,是继承关系的一个替代方案。

    用户1134788
  • 深入剖析 RabbitMQ —— Spring 框架下实现 AMQP 高级消息队列协议(中)

    上面章节已为大家介绍 RabbitMQ 在 Spring 框架下的结构及实现原理,这章里将(从Producer 端的事务、回调函数(ConfirmCallbac...

    风尘浪子
  • 代理模式

    mySoul
  • 自由流动的世界

    今天,我才得知美国最近有一条颇为轰动的消息。 5月10日,美国加州帕萨迪纳郡的社区媒体pasadenanow.com宣布,他们将在印度雇用两个记者,报道社区...

    ruanyf
  • 面对毫无基础的业务人员,好的分析师解释逻辑,而不是细节

    “每天一个数据分析师”新一期内容奉上,请享用~ 人物档案 谢宇,中国联通广西分公司的大数据负责人,有超过7年的电信行业数据挖掘经验,目前主要负责大数据应用规划、...

    CDA数据分析师

扫码关注云+社区

领取腾讯云代金券