ASP.NET路由系統實現原理：HttpHandler的動態映射

我們知道一個請求最終通過一個具體的HttpHandler進行處理，而我們熟悉的用於表示一個Web頁面的Page對象就是一個HttpHandler，被用於處理基於某個.aspx文件的請求。我們可以通過HttpHandler的動態映射來實現請求地址與物理文件路徑之間的分離。實際上ASP.NET路由系統就是采用了這樣的實現原理。如下圖所示，ASP.NET路由系統通過一個注冊到當前應用的自定義HttpModule對所有的請求進行攔截，並通過對請求的分析為之動態匹配一個用於處理它的HttpHandler。HttpHandler對請求進行處理后將相應的結果寫入HTTP回復以實現對請求的相應。

目錄
一、UrlRoutingModule
一、UrlRoutingModule
二、PageRouteHandler V.S. MvcRouteHandler
三、ASP.NET路由系統擴展
        實例演示：通過自定義Route對ASP.NET路由系統進行擴展

上圖所示的作為請求攔截器的HttpModule類型為UrlRoutingModule。如下面的代碼片斷所示，UrlRoutingModule對請求的攔截是通過注冊表示當前應用的HttpApplication的PostResolveRequestCache事件實現的。

public class UrlRoutingModule : IHttpModule
{
    //其他成員
    public RouteCollection RouteCollection { get; set; }
    public void Init(HttpApplication context)
    {
        context.PostResolveRequestCache += new EventHandler(this.OnApplicationPostResolveRequestCache);

    }
    private void OnApplicationPostResolveRequestCache(object sender,  EventArgs e);
}

UrlRoutingModule具有一個類型為RouteCollection的RouteCollection屬性，在默認的情況下引用這通過RouteTable的靜態屬性Routes表示的全局路由表。針對請求的HttpHandler的動態映射就實現在OnApplicationPostResolveRequestCache方法中，具體的實現邏輯非常簡單：通過HttpApplication獲得但前的HTTP上下文，並將其作為參數調用RouteCollection的GetRouteData方法得到一個RouteData對象。

通過RouteData的RouteHandler屬性可以得到一個實現了IRouteHandler的路由處理器對象，而調用后者的GetHttpHandler方法直接可以獲取對應的HttpHandler對象，而我們需要映射到當前請求的就是這么一個 HttpHandler。下面的代碼片斷基本上體現了定義在UrlRoutingModule的OnApplicationPostResolveRequestCache方法中的動態HttpHandler映射邏輯。

public class UrlRoutingModule : IHttpModule
{
    //其他成員
    private void OnApplicationPostResolveRequestCache(object sender, EventArgs e)
    {
        HttpContext context = ((HttpApplication)sender).Context;
        HttpContextBase contextWrapper = new HttpContextWrapper(context);
        RouteData routeData = this.RouteCollection.GetRouteData(contextWrapper);
        RequestContext requestContext = new RequestContext(contextWrapper, routeData);
        IHttpHandler handler = routeData.RouteHandler.GetHttpHandler(requestContext);
        context.RemapHandler(handler);
    }
}

二、 PageRouteHandler V.S. MvcRouteHandler

通過前面的介紹我們知道對於調用RouteCollection的GetRouteData獲得的RouteData對象，其RouteHandler來源於匹配的Route對象。對於通過調用RouteCollection的MapPageRoute方法注冊的Route來說，它的RouteHandler是一個類型為PageRouteHandler對象。

由於調用MapPageRoute方法的目的在於實現請求地址與某個.aspx頁面文件之間的映射，所以我們最終還是要創建的Page對象還處理相應的請求，所以PageRouteHandler的GetHttpHandler方法最終返回的就是針對映射頁面文件路徑的Page對象。此外，MapPageRoute方法中還可以控制是否對物理文件地址實施授權，而授權在返回Page對象之前進行。

定義在PageRouteHandler中的HttpHandler獲取邏輯基本上體現在如下的代碼片斷中，兩個屬性VirtualPath和CheckPhysicalUrlAccess表示頁面文件的地址和是否需要對物理文件地址實施URL授權，它們在構造函數中被初始化，而最終來源於調用RouteCollection的MapPageRoute方法傳入的參數。

public class PageRouteHandler : IRouteHandler
{
    public bool CheckPhysicalUrlAccess { get; private set; }
    public string VirtualPath { get; private set; }
    public PageRouteHandler(string virtualPath, bool checkPhysicalUrlAccess)
    {
        this.VirtualPath = virtualPath;
        this.CheckPhysicalUrlAccess = checkPhysicalUrlAccess;
    }
    public IHttpHandler GetHttpHandler(RequestContext requestContext)
    {
        if (this.CheckPhysicalUrlAccess)
        {
            //Check Physical Url Access
        }
        return (IHttpHandler)BuildManager.CreateInstanceFromVirtualPath(this.VirtualPath, typeof(Page))
    }
}

ASP.NET MVC的Route對象是通過調用RouteCollection的擴展方法MapRoute方法進行注冊的，它對應的RouteHandler是一個類型為MvcRouteHandler的對象。如下面的代碼片斷所示，MvcRouteHandler用於獲取處理當前請求的HttpHandler是一個MvcHandler對象。MvcHandler實現對Controller的激活、Action方法的執行以及對請求的相應，毫不誇張地說，整個MVC框架實現在MvcHandler之中。

public class MvcRouteHandler : IRouteHandler
{
    //其他成員
    public IHttpHandler GetHttpHandler(RequestContext requestContext)
    {
        return new MvcHandler(requestContext)
    }
}

三、 ASP.NET路由系統擴展

到此為止我們已經對ASP.NET的路由系統的實現進行了詳細介紹，總的來說，整個路由系統是通過對HttpHandler的動態注冊的方式來實現的。具體來說，UrlRoutingModule通過對代表Web應用的HttpApplication的PostResolveRequestCache事件的注冊實現了對請求的攔截。對於被攔截的請求，UrlRoutingModule利用注冊的路由表對其進行匹配和解析，進而得到一個包含所有路由信息的RouteData對象。最終借助該對象的RouteHandler創建出相應的HttpHandler映射到當前請求。從可擴展性的角度來講，我們可以通過如下三種方式來實現我們需要的路由方式。

• 通過集成抽象類RouteBase創建自定義Route定制路由邏輯。
• 通過實現接口IRouteHandler創建自定義RouteHandler定制HttpHandler提供機制。
• 通過實現IHttpHandler創建自定義HttpHandler來對請求處理。

實例演示：通過自定義Route對ASP.NET路由系統進行擴展

定義在ASP.NET路由系統中默認的路由類型Route建立了定義成文本模板的URL模式與某個物理文件之間的映射，如果我們對WCF REST有一定的了解，應該知道其中也有類似的實現。具體來說，WCF REST借助於System.UriTemplate這個對象實現了同樣定義成某個文本模板的URI模式與目標操作之間的映射。篇幅所限，我們不能對WCF REST的UriTemplate作詳細的介紹，有興趣的讀者可以參考《UriTemplate、UriTemplateTable與WebHttpDispatchOperationSelector》。[源代碼從這里下載]

我們創建一個新的ASP.NET Web應用，並且添加針對程序集System.ServiceModel.dll的引用（UriTemplate定義在該程序集中），然后創建如下一個針對UriTemplate的路由類型UriTemplateRoute。

public class UriTemplateRoute:RouteBase
{
    public UriTemplate   UriTemplate { get; private set; }
    public IRouteHandler     RouteHandler { get; private set; }
    public RouteValueDictionary     DataTokens { get; private set; }

    public UriTemplateRoute(string template, string physicalPath, object dataTokens = null)
    {
        this.UriTemplate = new UriTemplate(template);
        this.RouteHandler = new PageRouteHandler(physicalPath);
        if (null != dataTokens)
        {
            this.DataTokens = new RouteValueDictionary(dataTokens);
        }
        else
        {
            this.DataTokens = new RouteValueDictionary();
        }
    }
    public override RouteData GetRouteData(HttpContextBase httpContext)
    {
        Uri uri = httpContext.Request.Url;
        Uri baseAddress = new Uri(string.Format("{0}://{1}", uri.Scheme, uri.Authority));
        UriTemplateMatch match = this.UriTemplate.Match(baseAddress, uri);
        if (null == match)
        {
            return null;
        }
        RouteData routeData = new RouteData();
        routeData.RouteHandler = this.RouteHandler;
        routeData.Route = this;
        foreach (string name in match.BoundVariables.Keys)
        {
            routeData.Values.Add(name,match.BoundVariables[name]);
        }
        foreach (var token in this.DataTokens)
        {
            routeData.DataTokens.Add(token.Key, token.Value);
        }
        return routeData;
    }
    public override VirtualPathData GetVirtualPath(RequestContext requestContext, RouteValueDictionary values)
    {
        Uri uri = requestContext.HttpContext.Request.Url;
        Uri baseAddress = new Uri(string.Format("{0}://{1}", uri.Scheme, uri.Authority));
        Dictionary<string, string> variables = new Dictionary<string, string>();
        foreach(var item in values)
        {
            variables.Add(item.Key, item.Value.ToString());
        }

        //確定段變量是否被提供
        foreach (var name in this.UriTemplate.PathSegmentVariableNames)
        {
            if(!this.UriTemplate.Defaults.Keys.Any(key=> string.Compare(name,key,true) == 0) &&
                !values.Keys.Any(key=> string.Compare(name,key,true) == 0))
            {
                return null;
            }
        }
        //確定查詢變量是否被提供
        foreach (var name in this.UriTemplate.QueryValueVariableNames)
        {
            if(!this.UriTemplate.Defaults.Keys.Any(key=> string.Compare(name,key,true) == 0) &&
                !values.Keys.Any(key=> string.Compare(name,key,true) == 0))
            {
                return null;
            }
        }

        Uri virtualPath = this.UriTemplate.BindByName(baseAddress, variables);
        string strVirtualPath = virtualPath.ToString().ToLower().Replace(baseAddress.ToString().ToLower(),"");
        VirtualPathData virtualPathData =  new VirtualPathData(this, strVirtualPath);
        foreach (var token in this.DataTokens)
        {
            virtualPathData.DataTokens.Add(token.Key, token.Value);
        }
        return virtualPathData;
    }
}

如上面的代碼片斷所示，UriTemplateRoute具有UriTemplate、DataTokens和RouteHandler三個只讀屬性，前兩個通過構造函數的參數進行初始化，后者則是在構造函數中創建的PageRouteHandler對象。

用於對入棧請求進行匹配判斷的GetRouteData方法中，我們解析出基於應用的基地址並量連同請求地址作為參數調用UriTemplate的Match方法，如果返回的UriTemplateMatch對象不為Null，則意味着URL模板的模式與請求地址匹配。在匹配的情況下我們創建並返回相應的RouteData對象，否則直接返回Null。

在用於生成出棧URL的GetVirtualPath方法中，我們通過定義在URL模板中的模板（包括變量名包含在屬性PathSegmentVariableNames的路徑段變量和包含在QueryValueVariableNames屬性的查詢變量）是否在提供的RouteValueDictionary字段或者默認變量列表（通過屬性Defaults表示）從判斷URL模板是否與提供的變量列表匹配。在匹配的情況下通過調用UriTemplate的BindByName方法得到一個完整的Uri。由於該方法返回的是相對路徑，所以我們需要將應用基地址剔除並最終創建並返回一個VirtualPathData對象。如果不匹配，則直接返回Null。

在創建的Global.asax文件中我們采用如下的代碼對我們自定義的UriTemplateRoute進行注冊，選用的場景還是我們上面采用的天氣預報的例子。我個人具有基於UriTemplate的URI模板比針對Route的URL模板更好用，其中一點就是它在定義默認值方法更為直接。如下面的代碼片斷所示，我們直接將默認值定義在模板中（("{areacode=010}/{days=2}）。

public class Global : System.Web.HttpApplication
{
    protected void Application_Start(object sender, EventArgs e)
    {
        UriTemplateRoute route = new UriTemplateRoute("{areacode=010}/{days=2}",
            "~/Weather.aspx", new { defualtCity = "BeiJing", defaultDays = 2});
        RouteTable.Routes.Add("default", route);
    }
}

在注冊的路由對應的目標頁面Weather.aspx的后台代碼中，我們定義了如下一個GenerateUrl根據指定的區號（areacode）和預報天數（days）創建一個Url，而Url的生成直接通過調用RouteTable的Routes屬性的GetVirtualPathData方法完成。生成的URL連同當前頁面的RouteData的屬性通過如下所示的HTML輸出來。

<body>
    <form id="form1" runat="server">
    <div>
        <table>
            <tr>
                <td>Router:</td>
                <td><%=RouteData.Route != null? RouteData.Route.GetType().FullName:"" %></td>
            </tr>
            <tr>
                <td>RouteHandler:</td>
                <td><%=RouteData.RouteHandler != null? RouteData.RouteHandler.GetType().FullName:"" %></td>
            </tr>
            <tr>
                <td>Values:</td>
                <td>
                    <ul>
                        <%foreach (var variable in RouteData.Values)
                          {%>
                        <li><%=variable.Key%>=<%=variable.Value%></li>
                        <% }%>
                    </ul>
                </td>
            </tr>
            <tr>
                <td>DataTokens:</td>
                <td>
                    <ul>
                        <%foreach (var variable in RouteData.DataTokens)
                          {%>
                        <li><%=variable.Key%>=<%=variable.Value%></li>
                        <% }%>
                    </ul>
                </td>
            </tr>
             <tr>
                <td>Generated Url:</td>
                <td>
                    <%=GenerateUrl("0512",3)%>
                </td>
            </tr>
        </table>
    </div>
    </form>
</body>

由於注冊的URL模板所包含的段均由具有默認值的變量構成，所以當我們請求根地址時，會自動路由到Weather.aspx。下圖是我們在瀏覽器訪問應用根目錄的截圖，上面顯示了我們注冊的UriTemplateRoute生成的RouteData的信息和生成URL（/0512/3）。