ASP.NET Web API Selfhost宿主环境中管道、路由

前言

前面的几个篇幅对Web API中的路由和管道进行了简单的介绍并没有详细的去说明一些什么,然而ASP.NET Web API这个框架由于宿主环境的不同在不同的宿主环境中管道中的实现机制和路由的处理方式有着很大的不同,所以我会将对应不同的宿主环境来分别的做出简单的讲解。

 

 

ASP.NET Web API路由、管道

  • ASP.NET Web API 开篇介绍示例

  • ASP.NET Web API 路由对象介绍

  • ASP.NET Web API 管道模型

  • ASP.NET Web API selfhost宿主环境中管道、路由

  • ASP.NET Web API webhost宿主环境中管道、路由

 

ASP.NET Web API SelfHost宿主环境管道

首先我们先来看个示意图,大概的描述了在SelfHost宿主环境中管道形态。

1

wKiom1PheNXAw4NlAALM-TfFVAM821.jpg

因为在WebHost宿主环境中ASP.NET Web API的管道请求接收以及响应的返回最后都是由ASP.NET来包办的(下一篇中讲解),而在SelfHost宿主环境中就苦逼了,没有那么简单了。

 

我们按照图1中示意的来讲解,首先在SelfHost宿主环境中的项目启动之后(当然项目要使用Web API框架的),会有一个HttpBinding对象(System.Web.Http.SelfHost.Channels),那这个HttpBinding类型的对象是干嘛的呢?Httpbinding对象对应着一些个BindingElement对象,而这些BindingElement又各自生成对应的管道层监听器,这样就如图1中所示的那样,现在我们看一下如下的示例代码,看看HttpBinding到底对应着哪些BindingElement对象。

示例代码1-1

   publicclassHttpBinding : Binding, IBindingRuntimePreferences
   {
        publicHttpBinding()
        {
            this.Initialize();
        }
        privatevoidInitialize()
        {
            this._security=newHttpBindingSecurity();
            this._httpTransportBindingElement=newHttpTransportBindingElement();
            this._httpTransportBindingElement.ManualAddressing=true;
            this._httpsTransportBindingElement=newHttpsTransportBindingElement();
            this._httpsTransportBindingElement.ManualAddressing=true;
            this._httpMessageEncodingBindingElement=newHttpMessageEncodingBindingElement();
       }
}


在示例代码1-1中我们可以清楚的看到在HttpBinding对象的构造函数中分别的对几种BindingElement进行了实例化赋值,我们只对其中的HttpTransportBindingElementHttpMessageEncodingBindingElement进行讲解也就是图1中所示的那样。

HttpTransportBindingElement对象的主要职责就是生成相对应的管道监听器,这里对应的就是IChannelListener<TChannel>泛型类型了,而生成好对应的管道监听器之后,监听器之后会开始监听与之对应的管道层,与HttpTransportBindingElement对象以及监听器对应的也就是TransprotChannel管道层了,它负责请求消息的接收和响应消息的发送。

HttpMessageEncodingBindingElement类型的对象所做操作同HttpTransportBindingElement类型一致,都是先要生成对应的管道监听器,在这里与之对应的就是HttpMessageEncodingChannelListener类型,在监听器生成好之后也会去监听对应的EncodingChannel管道层,而EncodingChannel管道层主要的作用就是将请求信息封装为HttpMessage类型的消息对象,之后由HttpMessage消息对象进入ASP.NET Web API框架的管道系统中。

 

上面说的是在请求未到达ASP.NET Web API框架的管道系统中的时候在外部的一些处理和操作,下面我们就要说明一下内部,在上篇的《ASP.NET Web API 管道模型》篇幅中有示例代码演示过在SelfHost环境下管道的注册,我们这里看一下在SelfHost环境中Web API框架自身的管道系统里的对象的一些类型。

 

HttpSelfHostServer消息处理程序(实现类-管道头)System.Web.Http.SelfHost

   publicsealedclassHttpSelfHostServer : HttpServer
   {
        publicHttpSelfHostServer(HttpSelfHostConfigurationconfiguration);
        publicHttpSelfHostServer(HttpSelfHostConfigurationconfiguration, HttpMessageHandlerdispatcher);
        publicTaskCloseAsync();
        protectedoverridevoidDispose(booldisposing);
        publicTaskOpenAsync();
}


可以看到HttpSelfHostServer类型继承自HttpServer,在上篇中我们也就提到过HttpServer是继承自DelegatingHandler抽象类型的消息处理程序基类,DelegatingHandlerHttpMessageHandler的不同之处就是多了个指向下一个处理程序的引用,当然了作为一个管道系统中第一个消息处理程序必须是要有指向下一个处理程序引用的这么一个标识,这样是合理的。我们再看HttpSelfHostServer类型的构造函数的参数类型。

HttpSelfHostConfiguration类型是继承自HttpConfiguration类型的,在上篇中我们也说过,HttpConfiguration中可以配置管道中的大多数信息,这个大家可以自己去看一下。在重载构造函数中有了第二个构造函数参数,HttpMessageHandler类型的参数,在默认使用HttpSelfHostServer的时候假使不使用这个重载的构造函数,那么在HttpSelfHostServer实例化的之前先实例化之前,其基类HttpServer的构造函数开始执行,所以在看下HttpServer类型的构造函数的时候我们可以看到这里默认设置的HttpMessageHandler类型的参数到底是什么样子的。

publicHttpServer() : this(newHttpConfiguration())
        {
        }
        
        publicHttpServer(HttpMessageHandlerdispatcher) : this(newHttpConfiguration(), dispatcher)
        {
        }
        
        publicHttpServer(HttpConfigurationconfiguration) : this(configuration, newHttpRoutingDispatcher(configuration))
        {
        }
        
        publicHttpServer(HttpConfigurationconfiguration, HttpMessageHandlerdispatcher)
        {
            this._initializationLock=newobject();
            if (configuration==null)
            {
                throwSystem.Web.Http.Error.ArgumentNull("configuration");
            }
            if (dispatcher==null)
            {
                throwSystem.Web.Http.Error.ArgumentNull("dispatcher");
            }
            this._dispatcher=dispatcher;
            this._configuration=configuration;
        }


这里大家可以清楚的看到是HttpRoutingDispatcher类型作为管道的最后一个处理程序的类型,对于这个类型以及详细的信息,在下面的路由小节中会有说明。

 

ASP.NET Web API SelfHost宿主环境路由

对于路由的其他知识这里就不说了,就是简要的提一下在SelfHost中路由、管道的一些细节。

2

wKiom1PheQiRQ6ibAAPispqhnxE995.jpg

这里要详细说明的就是HttpRoutingDispatcher类型中的SendAsync()方法,看下源码中的实现这样更清楚。

   publicclassHttpRoutingDispatcher : HttpMessageHandler
   {
        //Fields
        privatereadonlyHttpConfiguration_configuration;
        privatereadonlyHttpMessageInvoker_defaultInvoker;
 
        //Methods
        publicHttpRoutingDispatcher(HttpConfigurationconfiguration)
            : this(configuration, newHttpControllerDispatcher(configuration))
        {
        }
        protectedoverrideTask<HttpResponseMessage>SendAsync(HttpRequestMessagerequest, CancellationTokencancellationToken)
        {
            IHttpRouteDatarouteData;
            if (!request.Properties.TryGetValue<IHttpRouteData>(HttpPropertyKeys.HttpRouteDataKey, outrouteData))
            {
                routeData=this._configuration.Routes.GetRouteData(request);
                if (routeData==null)
                {
                    returnTaskHelpers.FromResult<HttpResponseMessage>(request.CreateErrorResponse(HttpStatusCode.NotFound, Error.Format(SRResources.ResourceNotFound, newobject[] { request.RequestUri }), SRResources.NoRouteData));
                }
                request.Properties.Add(HttpPropertyKeys.HttpRouteDataKey, routeData);
            }
            RemoveOptionalRoutingParameters(routeData.Values);
            HttpMessageInvokerinvoker= (routeData.Route.Handler==null) ?this._defaultInvoker : newHttpMessageInvoker(routeData.Route.Handler, false);
            returninvoker.SendAsync(request, cancellationToken);
        }
   }


我们先看一下HttpRoutingDispatcher类型中构造函数,可以看到在定义的构造函数后面紧接着又在实例基类的构造函数,并且第二个HttpMessageHandler类型的参数为HttpControllerDispatcher实例的对象,这个我们先记住就行了。

下面我们还是回到HttpRoutingDispatcher类型的SendAsync()方法中,首先我们会看到从HttpRequestMessage对象实例的Properties属性集合中获取路由数据对象。

SelfHost的环境下这是获取不到的,为啥?因为上面以及之前的篇幅中在管道的处理中没有提到过处理路由并且生成路由数据的。所以这个时候会根据HttpConfiguration中的HttpRouteCollection类型的属性Routes,Routes属性再根据SendAsync()方法的参数类型为HttpRequestMessagerequest信息获取路由数据对象IHttpRouteData

在匹配成功获取到路由数据对象(IHttpRouteData)之后便会添加至HttpRequestMessage对象实例(request)的Properties属性集合中。

之前对于路由的了解,最后的执行的Handler都是起初定义在路由对象中的,而在实际情况中,我们注册路由的时候并没有,假使这种情况就在现在发生,可以看到routeData.Route.Hander==null这个是成立的,所以执行的是我们先前说过的在构造函数中的HttpControllerDispatcher类型的实例的SendAsync()方法(实际当中HttpControllerDispatcher类型被HttpMessageInvoker类型所封装)。

 

HttpControllerDispatcher类型就跟Web API控制器有关了,这里就不提前说了,后面一定会讲到。