請求如何進入ASP.NET MVC框架

1、前言

　　對於WebForm開發，請求一般是一個以.aspx結尾的url，對應一個物理文件，從代碼的角度來講它實際上是一個控件（Page)。而在MVC中，一個請求對應的是一個Controller裏的Action。熟悉asp.net的朋友都知道，asp.net請求實際都是交給HttpHandler處理（實現了IHttpHandler的類型）。不管是.aspx，.ashx，.asmx 仍是MVC裏的Action，請求都會交給HttpHandler。具體是在管道事件中，會根據請求建立一個HttpHandler，並執行它的PR方法。對於aspx和ashx都很好理解，由於它們自己就實現了IHttpHandler接口，而MVC的Controller和Action都和HttpHandler沒有關係，它是如何實現的呢？接下來咱們就看一個請求是如何進入mvc框架內部的。

2、例子

　　WebForm和MVC都是創建在asp.net平臺上的，Webform出現得比較早，那麼MVC是如何作到在不影響底層框架，實現擴展的呢？這主要得益於asp.net的路由機制。路由機制並不屬於MVC，WebForm也可使用它。它的目的是讓一個請求與物理文件分離，原理是經過映射關係，將請求映射到指定的HttpHandler。例如咱們也能夠將一個/Admin/User.aspx?name=張三 的請求映射成可讀性更好的/Admin/張三。下面是兩種url的註冊方式：

        public static void RegisterRoutes(RouteCollection routes)
        {
            //MVC
            routes.MapRoute(
                name: "Default",
                url: "{controller}/{action}/{id}",
                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
            );

            //WebForm
            routes.MapPageRoute(
                routeName: "WebForm",
                routeUrl: "Admin/{user}",
                physicalFile: "~/Admin/User.aspx"
            );
        }

　　RouteCollection是一個Route集合，Route封裝了名稱、url模式、約束條件、默認值等路由相關信息。其中，MapPageRoute是RouteCollection定義的方法，而MapRoute是MVC擴展出來的(擴展方法的好處就是能夠在不修改原有代碼的狀況下添加所需的功能)。它們的目的都是同樣的，建立一個Route對象，添加到集合當中；咱們也能夠new 一個Route對象，而後調用RouteCollection.Add，效果是同樣的。下面咱們主要關注MVC的實現過程，WebForm其實也是相似的。

3、分析源碼

　　接下來咱們看MVC是如何利用路由機制實現擴展的。路由機制是經過一個UrlRoutingModule完成的，它是一個實現了IHttpModule的類，路由模塊已經默認幫咱們註冊好了。HttpModule經過註冊HttpApplication事件參與到管道處理請求中，具體是訂閱HttpApplication某個階段的事件。路由機制就是利用這個原理，UrlRoutingModule訂閱了PostResolveRequestCache 事件，實現url的映射。爲何是該事件呢？由於該事件的下一步就要完成請求和物理文件的映射，因此必需要此以前進行攔截。核心代碼以下：

    public class UrlRoutingModule : IHttpModule {
        public RouteCollection RouteCollection {
            get {
                if (_routeCollection == null) {
                    //全局的RouteCollection集合
                    _routeCollection = RouteTable.Routes;
                }
                return _routeCollection;
            }
            set {
                _routeCollection = value;
            }
        }
 
        protected virtual void Init(HttpApplication application) {
            //註冊PostResolveRequestCache事件
            application.PostResolveRequestCache += OnApplicationPostResolveRequestCache;
        }
 
        private void OnApplicationPostResolveRequestCache(object sender, EventArgs e) {
            //建立上下文
            HttpApplication app = (HttpApplication)sender;
            HttpContextBase context = new HttpContextWrapper(app.Context);
            PostResolveRequestCache(context);
        }
 
        public virtual void PostResolveRequestCache(HttpContextBase context) {
            //1.獲取RouteData
            RouteData routeData = RouteCollection.GetRouteData(context);
            if (routeData == null) {
                return;
            }
            //2.獲取IRouteHandler
            IRouteHandler routeHandler = routeData.RouteHandler;
            if (routeHandler == null) {
                
            }
            
            //RequestContext保證了HttpContext和RouteData,在後續使用
            RequestContext requestContext = new RequestContext(context, routeData);
 
            context.Request.RequestContext = requestContext;

            //3.獲取IHttpHandler
            IHttpHandler httpHandler = routeHandler.GetHttpHandler(requestContext);

            //從新映射處處理程序
            context.RemapHandler(httpHandler);
        }
    }　　

　　咱們關注主要方法PostResolveRequestCache，這裏有三個關鍵步驟。

　　步驟一. 獲取RouteData

　　RouteData是對Route的包裝，在後續的處理中使用。它的獲取是經過RouteCollection得到的，這個和上面註冊用到的RouteTable.Routes是同一個集合對象。調用RouteCollection的GetRouteData會遍歷它的每個項，也就是Route對象，而後調用Route對象的GetRouteData方法（MVC內部不少集合都用到了這種設計）。以下代碼：

        public RouteData GetRouteData(HttpContextBase httpContext) {
            using (GetReadLock()) {
                foreach (RouteBase route in this) {
                    RouteData routeData = route.GetRouteData(httpContext);
                    if (routeData != null) {                       
                        return routeData;
                    }
                }
            }
            return null;
        }

　　Route對象的GetRouteData方法以下：

        public override RouteData GetRouteData(HttpContextBase httpContext) {
            string requestPath = httpContext.Request.AppRelativeCurrentExecutionFilePath.Substring(2) + httpContext.Request.PathInfo;
 
            //結合默認值，匹配url
            RouteValueDictionary values = _parsedRoute.Match(requestPath, Defaults);
 
            if (values == null) {
                return null;
            }
 
            //包裝成RouteData，這裏爲何不放在if後面呢？
            RouteData routeData = new RouteData(this, RouteHandler);
 
            //匹配約束
            if (!ProcessConstraints(httpContext, values, RouteDirection.IncomingRequest)) {
                return null;
            }
 
            //RouteData的Values和DataTokens都來自於Route
            foreach (var value in values) {
                routeData.Values.Add(value.Key, value.Value);
            }
            if (DataTokens != null) {
                foreach (var prop in DataTokens) {
                    routeData.DataTokens[prop.Key] = prop.Value;
                }
            }
 
            return routeData;
        }

　　能夠看到，Route對象的GetRouteData方法會匹配url模式，和檢查約束條件，如何不符合會返回null。若是匹配，則new一個RouteData。

　　步驟2、獲取IRouteHandler接口對象

　　上面建立RouteData，參數分別是當前Route對象和它的RouteHandler屬性。RouteHandler是一個IRouteHandler，這是一個重要接口，它的定義以下：

    public interface IRouteHandler {
        IHttpHandler GetHttpHandler(RequestContext requestContext);
    }

　　很明顯，它是用於獲取IHttpHandler的。那麼Route對象的RouteHandler屬性又是在哪裏初始化的呢？咱們回到開始的註冊方法，routes.MapRoute，這個方法根據傳遞的參數建立一個Route對象，該方法的實現以下：

        public static Route MapRoute(this RouteCollection routes, string name, string url, object defaults, object constraints, string[] namespaces)
        {
            //建立一個Route對象，它的IRouteHandler爲MvcRouteHandler
            Route route = new Route(url, new MvcRouteHandler())
            {
                Defaults = CreateRouteValueDictionary(defaults),
                Constraints = CreateRouteValueDictionary(constraints),
                DataTokens = new RouteValueDictionary()
            };

            if ((namespaces != null) && (namespaces.Length > 0))
            {
                route.DataTokens["Namespaces"] = namespaces;
            }

            //將Route註冊到RouteCollection中
            routes.Add(name, route);

            return route;
        }

　　在建立Route時，除了傳遞url模式外，還默認幫咱們傳遞了一個MvcRouteHandler，它實現了IRouteHandler接口。
　　步驟3、獲取IHttpHandler接口對象

　　有了MvcRouteHandler，就能夠調用它的GetHttpHandler方法獲取IHttpHandler了，該方法實現以下：

        protected virtual IHttpHandler GetHttpHandler(RequestContext requestContext)
        {
            //設置session狀態
            requestContext.HttpContext.SetSessionStateBehavior(GetSessionStateBehavior(requestContext));

            //返回一個實現了IHttpHandler的MvcHandler
            return new MvcHandler(requestContext);
        }

　　能夠看到，它返回了一個MvcHandler，MvcHandler就實現了IHttpHandler接口。因此開頭說的，請求本質都是交給HttpHandler的，其實MVC也是這樣的，請求交給了MvcHandler處理。咱們能夠看MvcHandler定義和主要方法：

    public class MvcHandler : IHttpAsyncHandler, IHttpHandler, IRequiresSessionState
    {
         protected internal virtual IAsyncResult BeginProcessRequest(HttpContextBase httpContext, AsyncCallback callback, object state)
        {
            IController controller;
            IControllerFactory factory;

            //這個方法裏會激活Controller對象
            ProcessRequestInit(httpContext, out controller, out factory);

            IAsyncController asyncController = controller as IAsyncController;
            if (asyncController != null)
            {
                // asynchronous controller
                BeginInvokeDelegate beginDelegate = delegate(AsyncCallback asyncCallback, object asyncState)
                {
                    try
                    {
                        //調用Controller的BeginExecute方法
                        return asyncController.BeginExecute(RequestContext, asyncCallback, asyncState);
                    }
                    catch
                    {
                        factory.ReleaseController(asyncController);
                        throw;
                    }
                };

                EndInvokeDelegate endDelegate = delegate(IAsyncResult asyncResult)
                {
                    try
                    {
                        asyncController.EndExecute(asyncResult);
                    }
                    finally
                    {
                        factory.ReleaseController(asyncController);
                    }
                };

                SynchronizationContext syncContext = SynchronizationContextUtil.GetSynchronizationContext();
                AsyncCallback newCallback = AsyncUtil.WrapCallbackForSynchronizedExecution(callback, syncContext);
                return AsyncResultWrapper.Begin(newCallback, state, beginDelegate, endDelegate, _processRequestTag);
            }
            else
            {
                // synchronous controller
                Action action = delegate
                {
                    try
                    {
                        controller.Execute(RequestContext);
                    }
                    finally
                    {
                        factory.ReleaseController(controller);
                    }
                };

                return AsyncResultWrapper.BeginSynchronous(callback, state, action, _processRequestTag);
            }
        }
    }

　　能夠看到，MvcHandler的任務就是激活Controller，並執行它的Execute方法。這個過程和Webform裏的頁面處理是很類似的，.aspx請求到來，會根據虛擬路徑找到實現IHttpHandler的Page（相似於路由機制根據url模式找到MvcHandler）,而後進入Page的頁面週期（相似於Mvc的激活Controller，而後執行Action過程）。

4、總結

接下來，簡單總結一下請求進入到MVC框架的過程：

1.添加路由對象Route到全局的RouteCollection，Route的IRouteHandler初始化爲MvcRouteHandler。

2. UrlRoutingModule註冊 HttpApplication PostResolveRequestCache事件，實現請求攔截。

3. 請求到來， 在處理事件中遍歷RouteCollection，調用每個Route對象的GetRouteData獲取RouteData包裝對象。

4. 調用MvcRouteHandler的GetHttpHandler獲取MvcHandler。

5. 調用HttpContext的RemapHandler將請求映射到MvcHandler處理程序。

6. 執行MvcHandler的PR方法，激活Controller，執行Action。