咨詢電話：023-6276-4481
咨詢電話：023-6276-4481
熱門文章
電 話：023-6276-4481
郵箱：broiling@qq.com
地址：重慶市南岸區(qū)亞太商谷6幢25-2
ASP.NET Web API的核心框架是一個消息處理管道，這個管道是一組HttpMessageHandler的有序組合。這是一個雙工管道，請求消息從一端流入并依次經(jīng)過所有HttpMessageHandler的處理。在另一端，目標(biāo)HttpController被激活，Action方法被執(zhí)行，響應(yīng)消息隨之被生成。響應(yīng)消息逆向流入此管道，同樣會經(jīng)過逐個HttpMessageHandler的處理。這是一個獨(dú)立于寄宿環(huán)境的抽象管道，如何實(shí)現(xiàn)對請求的監(jiān)聽與接收，以及將接收的請求傳入消息處理管道進(jìn)行處理并將管道生成的響應(yīng)通過網(wǎng)絡(luò)回傳給客戶端，這就是Web API寄宿需要解決的問題。[本文已經(jīng)同步到《How ASP.NET Web API Works?》]
目錄
一、HttpMessageHandler
二、DelegatingHandler
三、HttpServer
四、HttpRoutingDispatcher
五、HttpControllerDispatcher
一、HttpMessageHandler
ASP.NET Web API的消息處理管道由一組HttpMessageHandler經(jīng)過“首尾相連”而成，ASP.NET Web API之所以具有較高的可擴(kuò)展性，主要源于采用的管道式設(shè)計。雖然ASP.NET Web API框架旨在實(shí)現(xiàn)針對請求的處理和響應(yīng)的回復(fù)，但是采用的處理策略因具體的場景而不同。
我們不可能也沒有必要創(chuàng)建一個“萬能”的處理器來滿足所有的請求處理需求，倒不如讓某個處理器只負(fù)責(zé)某個單一的消息處理功能。在具體的應(yīng)用場景中，我們可以根據(jù)具體的消息處理需求來選擇所需的處理器并組成一個完整的消息處理管道。在這里這個用于完成某個單一消息處理功能的處理器就是HttpMessageHandler。
這里的“消息處理”具有兩個層面的含義，既包括針對請求消息的處理，還包括針對響應(yīng)消息的處理。HttpMessageHandler直接或者間接繼承自具有如下定義的抽象類型HttpMessageHandler，該類型定義在命名空間“System.Net.Http”下。ASP.NET Web API通過類型HttpRequestMessage和HttpResponseMessage來表示管道處理的請求消息和響應(yīng)消息，所以對HttpMessageHandler的定義就很好理解了。
public abstract class HttpMessageHandler : IDisposable
{
public void Dispose();
protected virtual void Dispose(bool disposing);
protected abstract Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken);
}
如上面的代碼片斷所示，抽象類HttpMessageHandler定義了一個受保護(hù)的抽象方法SendAsync，這是一個采用針對Task的“并行編程模式”的異步方法，在后續(xù)的章節(jié)中我們會看到ASP.NET Web API的應(yīng)用程序接口基本上都采用這樣的定義方式。對于這個SendAsync方法來說，request參數(shù)表示傳遞給當(dāng)前HttpMessageHandler進(jìn)行處理的請求，這是一個HttpRequestMessage對象。另一個參數(shù)cancellationToken是一個用于發(fā)送取消操作信號的CancellationToken對象，如果讀者對.NET中的并行編程具有基本了解的話，相信對這個類型不會感到陌生。
針對請求消息和響應(yīng)消息的處理均體現(xiàn)在這個SendAsync方法上。具體來說，針對請求消息的處理直接實(shí)現(xiàn)在SendAsync方法中，而針對響應(yīng)消息的處理則通過其返回的Task<HttpResponseMessage>對象來完成。由HttpMessageHandler組成的消息處理管道以及請求消息和響應(yīng)消息在管道中的“流動”基本上可以通過右圖來體現(xiàn)。
抽象類HttpMessageHandler實(shí)現(xiàn)了IDisposable接口，它按照“標(biāo)準(zhǔn)”的方式實(shí)現(xiàn)Dispose方法。如下面的代碼片斷所示，當(dāng)我們調(diào)用Dispose方法的時候，HttpMessageHandler并沒有執(zhí)行任何資源回收操作。當(dāng)我們通過繼承這個抽象類自定義HttpMessagHandler的時候，可以將資源回收操作實(shí)現(xiàn)在重寫的Dispose方法中。
public abstract class HttpMessageHandler : IDisposable
{
//其他操作
public void Dispose()
{
this.Dispose(true);
GC.SuppressFinalize(this);
}
protected virtual void Dispose(bool disposing)
{}
}
我們說ASP.NET Web API消息處理管道是通過一組有序的HttpMessagHandler“首尾相連”而成，具體實(shí)現(xiàn)“管道串聯(lián)”是通過DelegatingHandler這個類型來完成的。顧名思義，DelegatingHandler具有委托功能，當(dāng)它自己負(fù)責(zé)的消息處理任務(wù)完成之后可以委托另一個HttpMessagHandler進(jìn)行后續(xù)的處理。如果這個被委托的也是一個DelegatingHandler對象，不就可以組成一個委托鏈了嗎？而這個委托鏈不就是由一個個DelegatingHandler組成的消息處理管道嗎？
如下面的代碼片斷所示，DelegatingHandler是一個繼承自HttpMessageHandler類的抽象類。上面我們所說的這個被委托的HttpMessagHandler由它的屬性InnerHandler表示。DelegatingHandler重寫了定義在其類的抽象方法SendAsync來調(diào)用InnerHandler屬性的同名方法。
public abstract class DelegatingHandler : HttpMessageHandler
{
protected internal override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken);
public HttpMessageHandler InnerHandler get; set; }
}
正如上面所說，如果ASP.NET Web API的消息處理管道均由DelegatingHandler組成（位于管道尾端的HttpMessageHandler除外），我們就可以根據(jù)其InnerHandler獲得對被委托的HttpMessageHandler對象的引用，由此便構(gòu)成具有如上圖所示的鏈?zhǔn)浇Y(jié)構(gòu)。組成ASP.NET Web API核心框架的消息處理管道就這么簡單。
一般來說，對于構(gòu)成ASP.NET Web API消息處理管道的所有HttpMessageHandler來說，除了處于尾端的那一個之外，其余的均為DelegatingHandler，那么通過InnerHandler屬性維持著“下一個” HttpMessageHandler。作為這個HttpMessageHandler鏈“龍頭”的是一個HttpServer對象，該類型定義在命名空間“System.Web.Http”下。
如下面的代碼片斷所示，HttpServer直接繼承自DelegatingHandler。它具有兩個重要的只讀屬性（Configuration和Dispatcher），我們可以通過前者得到用于配置整個消息處理管道的HttpConfiguration對象，另外一個屬性Dispatcher返回的是處于整個消息處理管道“尾端”的HttpMessageHandler。
public class HttpServer : DelegatingHandler
{
public HttpConfiguration Configuration { get; }
public HttpMessageHandler Dispatcher { get; }
public HttpServer();
public HttpServer(HttpMessageHandler dispatcher);
public HttpServer(HttpConfiguration configuration);
public HttpServer(HttpConfiguration configuration, HttpMessageHandler dispatcher);
protected override void Dispose(bool disposing);
protected virtual void Initialize();
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken);
}
HttpServer的Configuration和Dispatcher屬性均可以在相應(yīng)的構(gòu)造函數(shù)中初始化。如果在構(gòu)造HttpServer的時候沒有顯式指定這兩個屬性的值（調(diào)用默認(rèn)的無參構(gòu)造函數(shù)創(chuàng)建HttpServer），在默認(rèn)情況下會創(chuàng)建一個HttpConfiguration作為Configuration的屬性值，而作為Dispatcher屬性值的則是一個HttpRoutingDispatcher對象，該類型定義在命名空間“System.Web.Http.Dispatcher”下。除此之外。由于HttpConfiguration類型實(shí)現(xiàn)了IDisposable接口，所以HttpServer重寫了虛方法Dispose并在該方法中完成了對HttpConfiguration對象的釋放。
當(dāng)HttpServer對象被成功創(chuàng)建之后，對應(yīng)的消息處理管道的“一頭一尾”已經(jīng)確定下來。一頭指的就是HttpServer對象本身，一尾指的自然就是通過Dispatcher屬性引用的HttpMessageHandler對象了。ASP.NET Web API框架最大的擴(kuò)展性就在于我們可以根據(jù)具體的消息處理需求來“定制”這個消息處理管道，它允許我們將自定義的HttpMessageHandler按照如左圖所示的方式“安裝”到這一頭一尾之間，但是這些處于“中間位置”的HttpMessageHandler是如何注冊呢？
既然整個管道都是由HttpConfiguration進(jìn)行配置，那么自定義HttpMessageHandler的注冊自然也可以利用它來完成。如下面的代碼片斷所示，HttpConfiguration具有一個只讀的集合類型的MessageHandlers，需要注冊的HttpMessageHandler需要添加到此集合之中。由于這是一個元素類型為DelegatingHandler的集合，所以我們自定義的HttpMessageHandler必須繼承自DelegatingHandler。
public class HttpConfiguration : IDisposable
{
//其他成員
public Collection<DelegatingHandler> MessageHandlers { get; }
}
通過上面的給出的HttpServer類型定義我們可以看到它具有一個受保護(hù)的Initialize方法，該方法最終完成了對整個消息處理管道的構(gòu)建。在重寫的SendAsync方法中，如果自身尚未被初始化，該Initialize方法會自動被調(diào)用以確保整個消息處理管道已經(jīng)被成功構(gòu)建。
在默認(rèn)情況下，作為消息處理管道“龍頭”的HttpServer的Dispatcher屬性返回一個HttpRoutingDispatcher對象，它可以視為這個消息處理管道的最后一個HttpMessageHandler。Web API調(diào)用請求一般都是針對定義在某個HttpController中的某個Action方法，所以消息處理管道最終需要激活相應(yīng)的HttpController并執(zhí)行對應(yīng)的Action方法，HttpRoutingDispatcher完成了目標(biāo)HttpController的激活和Action方法的執(zhí)行。
如下面的代碼片斷所示，HttpRoutingDispatcher不再是DelegatingHandler的繼承者，它的直接基類是抽象類HttpMessageHandler。我們在構(gòu)建一個HttpRoutingDispatcher對象的時候需要指定一個HttpConfiguration對象，而通過參數(shù)defaultHandler指定的HttpMessageHandler對于創(chuàng)建的HttpRoutingDispatcher對象來說具有重要的意義，因?yàn)镠ttpController的激活、Action方法的選擇與執(zhí)行等后續(xù)操作實(shí)際上是由它來完成的。
public class HttpRoutingDispatcher : HttpMessageHandler
{
public HttpRoutingDispatcher(HttpConfiguration configuration);
public HttpRoutingDispatcher(HttpConfiguration configuration, HttpMessageHandler defaultHandler);
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken);
}
雖然ASP.NET Web API消息處理管道不具有一個類似于HttpContext的對象來保存基于當(dāng)前請求的上下文信息，但是表示請求消息的HttpRequestMessage對象具有一個通過Properties屬性表示的屬性字典，我們可以利用它來作為上下文數(shù)據(jù)的存放容器。
通過上面對HttpServer的介紹我們知道它會將當(dāng)前SynchronizationContext和HttpConfiguration添加到表示當(dāng)前請求的HttpRequestMessage對象的屬性字典中。與之類似，通過路由系統(tǒng)生成的HttpRouteData也以同樣的方式保存在HttpRequestMessage的屬性字典之中，我們可以直接調(diào)用HttpRequestMessage的如下兩個擴(kuò)展方法GetRouteData和SetRouteData進(jìn)行HttpRouteData的獲取和設(shè)置。
public static class HttpRequestMessageExtensions
{
//其他成員
public static IHttpRouteData GetRouteData(this HttpRequestMessage request);
public static void SetRouteData(this HttpRequestMessage request, IHttpRouteData routeData);
}
HttpRoutingDispatcher的SendAsync方法被執(zhí)行時，它會判斷作為參數(shù)的HttpRequestMessage對象的屬性字典中是否具有這樣一個HttpRouteData對象。如果此HttpRouteData對象存在，它會直接將請求交付給創(chuàng)建時指定的HttpMessageHandler進(jìn)行處理。這樣的情況會發(fā)生在Web Host寄宿模式下。
如果封裝路由數(shù)據(jù)的HttpRouteData對象尚未添加到表示被處理請求的HttpRequestMessage對象的屬性字典中，意味著針對請求的路由尚未發(fā)生，這種情況會發(fā)生在Self Host寄宿模式下。在這種情況下，HttpRoutingDispatcher會直接通過當(dāng)前HttpConfiguration的Routes屬性得到全局路由表，并將HttpRequestMessage對象作為參數(shù)調(diào)用其GetRouteData方法以實(shí)現(xiàn)針對當(dāng)前請求的路由解析。
如果執(zhí)行路由表的GetRouteData方法返回一個具體的HttpRouteData對象，意味著當(dāng)前請求與注冊的某個HttpRoute相匹配，HttpRoutingDispatcher會將這個HttpRouteData對象添加到HttpRequestMessage對象的屬性字典中。在這之后，ASP.NET Web API會將請求交付給創(chuàng)建時指定的HttpMessageHandler進(jìn)行后續(xù)處理。如果執(zhí)行GetRouteData方法返回Null，意味著當(dāng)前請求與注冊的路由規(guī)則不匹配，客戶端會得到一個狀態(tài)為“404， Not Found”的響應(yīng)。
我們從類型命名可以看出HttpRoutingDispatcher具有兩個基本的職能，即“路由（Routing）”和“消息分發(fā)（Dispatching）”。對于前者，它會調(diào)用當(dāng)前路由表對請求消息實(shí)施路由解析進(jìn)而生成用于封裝路由數(shù)據(jù)的HttpRouteData（如果這樣的HttpRouteData不存在于當(dāng)前請求的屬性字典中）。對于后者，它會將請求直接分發(fā)給在創(chuàng)建時指定的HttpMessageHandler來完成進(jìn)一步處理。
如果在構(gòu)建HttpRoutingDispatcher對象的時候沒有通過參數(shù)defaultHandler顯式指定這么一個HttpMessageHandler對象，默認(rèn)情況下從它手中接管請求的HttpMessageHandler是一個具有如下定義的HttpControllerDispatcher的對象，該類型定義在命名空間“System.Web.Http.Dispatcher”下。HttpControllerDispatcher在整個消息處理管道中顯得尤為重要，因?yàn)槟繕?biāo)HttpController的激活、Action方法的執(zhí)行和響應(yīng)生成均是由HttpControllerDispatcher來完成的。
public class HttpControllerDispatcher : HttpMessageHandler
{
public HttpControllerDispatcher(HttpConfiguration configuration);
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken);
public HttpConfiguration Configuration { get; }
}
在我們引入HttpControllerDispatcher對象之后，ASP.NET Web API的消息處理管道將具有如右圖所示的結(jié)構(gòu)。從這個結(jié)構(gòu)來看，貌似HttpControllerDispatcher才是整個消息處理管道的最后一個HttpMessageHandler。這種說法沒有錯，但我個人還是傾向于將HttpControllerDispatcher視為“隸屬于” HttpRoutingDispatcher的“內(nèi)部”HttpMessageHandler，所以仍將這個“包含” HttpControllerDispatcher的HttpRoutingDispatcher視為組成消息處理管道的最后一個HttpMessageHandler。
除此之外，“N個DelegagingHandler + 1個HttpMessageHander”這樣的鏈?zhǔn)浇Y(jié)構(gòu)也剛好與基于DelegagingHandler的委托鏈相匹配。對于讀者朋友來說，具體傾向于哪種說法并不重要，重要的是能夠深刻了解整個消息處理管道的是如何構(gòu)成的。
