MVC框架的原理详解

MVC框架的原理详解

前言：最近一段时间在学习MVC源码，说实话，研读源码真是一个痛苦的过程，好多晦涩的语法搞得人晕晕乎乎。这两天算是理解了一小部分，这里先记录下来，也给需要的园友一个参考，奈何博主技术有限，如有理解不妥之处，还希望大家斧正，博主感激不尽！

一、MVC原理解析

最近园子里Asp.Net Core火了一阵，不管微软的开源动作有多么迟缓，还是希望微软能够给力一次。作为Core的主要Web框架——MVC，虽然已经开源，但是读起来着实费劲，并且感觉很多核心部件都找不到。于是只能通过Reflector去反编译MVC5的组件以及参考博客园Fish Li等大神的文章去学习下MVC5的原理。
————————————————
Asp.Net Core MVC的开源地址：https://github.com/aspnet/Mvc
Asp.net MVC的开源地址：http://aspnetwebstack.codeplex.com/SourceControl/latest

1、MVC原理

之前的文章有介绍MVC的路由机制，其实路由机制算是MVC的原理的核心之一。在此我们还是要不厌其烦再来谈谈整个过程，因为这是理解MVC原理不可逾越的鸿沟。当我们收到一个URL的请求时，服务端收到请求，主要经历以下几个步骤：

1.请求被UrlRoutingModule部件拦截
2.封装请求上下文HttpContext，成为HttpContextWrapper对象。
3.根据当前的HttpContext，从Routes集合中得到与当前请求URL相符合的RouteData对象。
4.将RouteData与HttpContext请求封装成一个RequestContext对象。
5.根据RequestContext对象，从RouteData的RouteHandler中获取IHttpHandler（MVC里面会有一个IHttpHandler的实现类MvcHandler）。
6.执行IHttpHandler（MvcHandler），然后就是通过反射激活具体的controller，执行具体的action。

二、HttpHandler

上文说过MvcHandler是继承至IHttpHandler接口的！为什么这里大标题会用HttpHandler而不是MvcHandler呢？因为博主觉得，HttpHandler实在是太重要了，首先得理解了HttpHandler这么一个大的东西，然后再来看具体的MvcHandler才有意义。

1、HttpHandler、IHttpHandler、MvcHandler的说明

1.HttpHandler指所有实现IHttpHandler接口一类类型的统称，它是一个大的称谓。这些类型有一个共同的功能，那就是可以用来处理Http请求。
2.IHttpHandler是微软定义的一类接口，用来约束所有能够处理Http请求的类型的接口规则。
3.MvcHandler是Mvc里面实现IHttpHandler接口的类型，也就是说，MvcHandler是Mvc里面处理Http请求的类型。
总而言之，HttpHandler只是一个逻辑称谓，它并不具体存在。而IHttpHandler和MvcHandler是.net framework里面具体存在的接口和实现类，是前者的表现形式。

2、IHttpHandler解析

2.1、Asp.net管线事件简易说明

在处理该请求时将由 HttpApplication 类执行以下事件。 希望扩展 HttpApplication 类的开发人员尤其需要注意这些事件。

1. 对请求进行验证，将检查浏览器发送的信息，并确定其是否包含潜在恶意标记。 有关更多信息，请参见 ValidateRequest 和脚本侵入概述。
2. 如果已在 Web.config 文件的 UrlMappingsSection 节中配置了任何 URL，则执行 URL 映射。
3. 引发 BeginRequest 事件。
4. 引发 AuthenticateRequest 事件。
5. 引发 PostAuthenticateRequest 事件。
6. 引发 AuthorizeRequest 事件。
7. 引发 PostAuthorizeRequest 事件。
8. 引发 ResolveRequestCache 事件。
9. 引发 PostResolveRequestCache 事件。
10. 根据所请求资源的文件扩展名（在应用程序的配置文件中映射），选择实现 IHttpHandler 的类，对请求进行处理。 如果该请求针对从 Page 类派生的对象（页），并且需要对该页进行编译，则 ASP.NET 会在创建该页的实例之前对其进行编译。
11. 引发 PostMapRequestHandler 事件。
12. 引发 AcquireRequestState 事件。
13. 引发 PostAcquireRequestState 事件。
14. 引发 PreRequestHandlerExecute 事件。
15. 为该请求调用合适的 IHttpHandler 类的 ProcessRequest 方法（或异步版 IHttpAsyncHandler.BeginProcessRequest）。 例如，如果该请求针对某页，则当前的页实例将处理该请求。
16. 引发 PostRequestHandlerExecute 事件。
17. 引发 ReleaseRequestState 事件。
18. 引发 PostReleaseRequestState 事件。
19. 如果定义了 Filter 属性，则执行响应筛选。
20. 引发 UpdateRequestCache 事件。
21. 引发 PostUpdateRequestCache 事件。
22. 引发 EndRequest 事件。
23. 引发 PreSendRequestHeaders 事件。
24. 引发 PreSendRequestContent 事件。

这里不可能把每个管线事件将清楚，但是在整个管线事件中，有两个重要的角色就是HttpHandler和HttpModule。在这些事件中，第10个事件【根据所请求资源的文件扩展名（在应用程序的配置文件中映射），选择实现 IHttpHandler 的类，对请求进行处理】 是HttpHandler创建的地方。

2.2、Asp.net中常见的HttpHandler类型

首先还是来看看IHttpHandler的定义

public interface IHttpHandler
{
    // 定义一个处理当前http请求的方法
    void ProcessRequest(HttpContext context);

    // 指示当前实例是否可以再次使用
    bool IsReusable { get; }
}

接口的定义很简单，ProcessRequest()方法里面传一个当前请求的上下文对象去处理当前的http请求。

为了处理异步请求，Framework里面还定义了一个异步的IHttpHandler接口：

public interface IHttpAsyncHandler : IHttpHandler
{
    // Methods
    IAsyncResult BeginProcessRequest(HttpContext context, AsyncCallback cb, object extraData);
    void EndProcessRequest(IAsyncResult result);
}

接口的两个方法应该也不难理解。

我们已经说了，HttpHandler的主要作用是处理http请求，原来在做webform的时候应该都写过后缀ashx的一般处理程序吧，这个一般处理程序就是通过实现IHttpHandler接口去实现的。我们是否曾经也写过类似这样的代码，新建一个TestHttpHandler.ashx文件，代码如下：

public class TestHttpHandler : IHttpHandler
    {

        public void ProcessRequest(HttpContext context)
        {
            context.Response.ContentType = "text/plain";

            var username = context.Request.QueryString["username"];
            var password = context.Request.QueryString["password"];
            if (username == "admin" && password == "admin")
            {
                context.Response.Write("用户admin登录成功");
            }
            else
            {
                context.Response.Write("用户名或者密码错误");
            }
        }

        public bool IsReusable
        {
            get
            {
                return false;
            }
        }
    }

然后运行，通过http://localhost:16792/TestHttpHandler.ashx?username=admin&password=admin去访问一般处理程序，即可得到正确的结果。

   public partial class TestPage : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {

        }
    }

将Page类转到定义：

发现原来Page类也是继承至IHttpHandler，这就是为什么我们可以通过地址http://localhost:16792/TestPage.aspx来访问这个页面的原因。当然，子类中的ProcessRequest()方法并没有显示的声明出来，因为在Page类里面已经有一个virtue的虚方法，如果需要，你也可以在TestPage这个类里面显示声明：

public partial class TestPage : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {

    }

    public void ProcessRequest(HttpContext context)
    {
        context.Response.Write("你好");
    }
}

然后你会发现这个时候请求会进到ProcessRequest()方法，而不会进到Page_Load()里面了，至于原因，这和Page类里面的封装有关系。当然这不是本文的重点，本文要说明的是所有实现了IHttpHandler接口的类型都可以在ProcessRequest()方法里面处理当前http请求。

当然，除了ashx和aspx以外，还有一类http的服务接口处理文件asmx也和IHttpHandler有着不可分割的联系，可以说，在asp.net里面，只要是处理Http请求的地方，IHttpHandler几乎“无处不在”。

2.3、自定义HttpHandler。

当然，除了上述asp.net自带的HttpHandler之外，我们也可以自定义HttpHandler处理特定的请求。比如我们新建一个TestMyHandler.cs页面：

public class TestMyHandler:IHttpHandler
{
    public bool IsReusable
    {
        get { return false; }
    }

    public void ProcessRequest(HttpContext context)
    {
        context.Response.Write("从asex页面进来");

        //throw new NotImplementedException();
    }
}

当然，要使用这个自定义的Handler需要在web.config里面加上配置。

<system.webServer>
   <handlers>
        <add name="asex" verb="*" path="*.asex" type="MyTestMVC.TestMyHandler, MyTestMVC" preCondition="integratedMode" />
    </handlers>
</system.webServer>

这个配置的意思是所有的url以asex结尾的请求都交给TestMyHandler这个类去处理。得到效果：

3、MvcHandler解析

上文介绍了那么多IHttpHandler的用法，都是在WebForm里面的一些实现，我们知道了所有实现了IHttpHandler的类都可以处理Http请求。同样在MVC里面，也定义了一个实现IHttpHandler接口的类型——MvcHandler，用于处理当前的http请求。通过反编译工具可以看到：

public class MvcHandler : IHttpAsyncHandler, IHttpHandler, IRequiresSessionState
{
    // 省略若干字段// 所有方法
    static MvcHandler();
    public MvcHandler(RequestContext requestContext);
    protected internal virtual void AddVersionHeader(HttpContextBase httpContext);
    protected virtual IAsyncResult BeginProcessRequest(HttpContext httpContext, AsyncCallback callback, object state);
    protected internal virtual IAsyncResult BeginProcessRequest(HttpContextBase httpContext, AsyncCallback callback, object state);
    protected internal virtual void EndProcessRequest(IAsyncResult asyncResult);
    private static string GetMvcVersionString();
    protected virtual void ProcessRequest(HttpContext httpContext);
    protected internal virtual void ProcessRequest(HttpContextBase httpContext);
    private void ProcessRequestInit(HttpContextBase httpContext, out IController controller, out IControllerFactory factory);
    private void RemoveOptionalRoutingParameters();
    IAsyncResult IHttpAsyncHandler.BeginProcessRequest(HttpContext context, AsyncCallback cb, object extraData);
    void IHttpAsyncHandler.EndProcessRequest(IAsyncResult result);
    void IHttpHandler.ProcessRequest(HttpContext httpContext);

    // 省略若干属性
}

MvcHandler实现了IHttpHandler、 IHttpAsyncHandler两个接口，异步请求这里先不做介绍。重点还是来看看ProcessRequest()方法

将HttpContext转换为HttpContextBase对象，继续转到定义。

这里声明了一个IController和IControllerFactory对象，通过this.ProcessRequestInit()方法创建具体的Controller实例。我们将ProcessRequestInit()方法转到定义

我们将代码复制出来，写入相应的注释：

　　　　 private void ProcessRequestInit(HttpContextBase httpContext, out IController controller, out IControllerFactory factory)
{
    //1.得到当前的上下文
    HttpContext current = HttpContext.Current;
    if (current != null && ValidationUtility.IsValidationEnabled(current) == true) ValidationUtility.EnableDynamicValidation(current);
    this.AddVersionHeader(httpContext);
    this.RemoveOptionalRoutingParameters();

    //2.从路由对象RouteData中获取当前请求的Controller名称
    string requiredString = this.RequestContext.RouteData.GetRequiredString("controller");

    //3.得到Controller工厂对象
    factory = this.ControllerBuilder.GetControllerFactory();

    //4.根据当前RequestContext对象，从Controller工厂创建具体的Controller对象
    controller = factory.CreateController(this.RequestContext, requiredString);
    if (controller == null) throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, MvcResources.ControllerBuilder_FactoryReturnedNull, new object[] { factory.GetType(), requiredString }));
}

通过上文的注释很好理解整个控制器的实例化过程。本打算看下Controller工厂如何创建以及控制器如何实例化的，奈何这部分反编译不了。我们暂且理解为反射吧，这些实现细节并不影响我们理解整个过程。

创建控制器成功之后，就是执行Action方法了，这个过程在上面反编译的第二张图片的 controller.Execute(this.RequestContext); 方法得到体现。所以，除去细节，理解MvcHandler的ProcessRequest()方法并不是太难。

三、HttpModule

除了HttpHandler之外，Asp.net里面还有另外一个重要的角色——HttpModule。和HttpHandler类似，HttpModule指所有实现了IHttpModule接口的一类类型的统称。至于HttpModule、IHttpModule、UrlRoutingModule各个名称的含义和上述HttpHandler相同，在此不做重复说明。

1、HttpModule能干什么

通过上文，我们知道HttpHandler的作用非常明确：处理Http请求，生成相应结果。那么，HttpModule又是干什么的呢？

HttpHandler的作用是处理某一类别的请求，比如ashx、aspx、asmx等，在某些情况下，各类请求可能都需要进行某些相同的处理（比如请求拦截、身份认证、检查功能等），不可能在每个类别的HttpHandler里面都去实现这些相同的代码，这个时候怎么办呢？处理某一类通用请求，提高代码的复用率。是不是想到了我们的面向切面编程（AOP），没错，HttpModule就是负责做这个事，HttpModule通过事件订阅的方式，将某类HttpHandler都需要的功能抽取出来，这些功能可以编译成类库供各个模块调用。这种采用事件（观察者）的设计模式使得系统设计上更加灵活。

2、HttpModule的使用

先来看看IHttpModule的定义

public interface IHttpModule
{
    //初始化
    void Init(HttpApplication context);
   
    //释放
    void Dispose();
}

接口定义很简单，一个初始化组件的方法，一个释放对象的方法。

我们来写一个测试的例子具体看看HttpModule如何注册事件，我们新建一个IHttpModule的实现类：

namespace MyTestMVC
{
    public class TestMyModule:IHttpModule
    {
        public void Dispose()
        {
            //throw new NotImplementedException();
        }

        public void Init(HttpApplication app)
        {
            //事件注册
            app.BeginRequest += app_BeginRequest;
            app.EndRequest += app_EndRequest;
        }

        void app_EndRequest(object sender, EventArgs e)
        {
            var app = (HttpApplication)sender;
            app.Context.Response.Write("请求结束");
        }

        void app_BeginRequest(object sender, EventArgs e)
        {
            var app = (HttpApplication)sender;
            app.Context.Response.Write("请求开始");
        }
    }
}

在Init方法里面，通过HttpApplication对象来注册请求的事件。这样，每次发起一次http请求的时候都进到这两个方法。

当然，这些注册就能执行了吗？想得美，系统哪里知道你这个自定义HttpModule的存在，所以必须要在Web.config里面声明一下。

<system.web>
    <httpModules>
        <add name="TestMyModule" type="MyTestMVC.TestMyModule, MyTestMVC" />
    </httpModules>
  </system.web>

查阅资料后发现，原来IIS经典模式下必须要这样配置：

<system.webServer>
    <modules>
        <add name="TestMyModule" type="MyTestMVC.TestMyModule, MyTestMVC" preCondition="integratedMode" />
    </modules>
</system.webServer>

没办法，用微软的东西就要遵守别人的游戏规则。改成这样之后得到结果：

文中的“你好”来自这里：

既然HttpModule是事件注册机制的，那么如果需要在同一个事件里面去实现不同的功能，也就是说同一个事件注册多次是否可行呢？我们来试一把：

假如TestMyModule.cs这个自定义Module的作用是功能检查：

TestMyModule.cs
然后新建一个TestMyModule2.cs这个自定义Module，去实现请求拦截的功能：

TestMyModule2.cs
最后在Web.config里面配置两个Module：

<system.webServer>
    <modules>
        <add name="TestMyModule" type="MyTestMVC.TestMyModule, MyTestMVC" preCondition="integratedMode" />
        <add name="TestMyModule2" type="MyTestMVC.TestMyModule2, MyTestMVC" preCondition="integratedMode" />
    </modules>
</system.webServer>

3、HttpModule和HttpHandler如何区分

通过上文的HttpModule的应用，我们看到在Init方法里面可以拿到当前应用的HttpApplication对象，拿到这个貌似就可以拿到当前请求上下文里面的Request、Response了，是不是就可以处理当前的http请求了，从这点上来说，HttpModule也能处理http请求，或者说具有处理http请求的能力。既然HttpHandler和HttpModule都可以处理http请求，那在使用的时候如何区分呢？上文说过，HttpModule的作用类似AOP，是针对某些通用功能（请求拦截、身份认证、检查功能）的，而HttpHandler常用来处理某一类（ashx、aspx、asmx）http请求，两者的侧重点不同，至于具体在实际中如何使用，你可以自行考量。

4、UrlRoutingModule解析

好了，上面介绍那么多HttpModule的使用，都是在为了解Mvc里面的UrlRoutingModule做铺垫。上文说过UrlRoutingModule的作用是拦截请求，那么它是如何做的呢，还是来反编译看看吧。

public class UrlRoutingModule : IHttpModule
{
    // Fields
    private static readonly object _contextKey;
    private static readonly object _requestDataKey;
    private RouteCollection _routeCollection;

    // Methods
    static UrlRoutingModule();
    public UrlRoutingModule();
    protected virtual void Dispose();
    protected virtual void Init(HttpApplication application);
    private void OnApplicationPostResolveRequestCache(object sender, EventArgs e);
    [Obsolete("This method is obsolete. Override the Init method to use the PostMapRequestHandler event.")]
    public virtual void PostMapRequestHandler(HttpContextBase context);
    public virtual void PostResolveRequestCache(HttpContextBase context);
    void IHttpModule.Dispose();
    void IHttpModule.Init(HttpApplication application);

    // Properties
    public RouteCollection RouteCollection { get; set; }
}

这部分代码是我们上述路由理论的代码实践，所以这段代码很重要，我们将代码拷贝出来：

　　　　 public virtual void PostResolveRequestCache(HttpContextBase context)
{
    //1.传入当前上下文对象，得到与当前请求匹配的RouteData对象
    RouteData routeData = this.RouteCollection.GetRouteData(context);
    if (routeData != null)
    {
        //2.从RouteData对象里面得到当前的RouteHandler对象。其实这里的RouteHandler属性对应就是一个MvcRouteHandler的对象。
        IRouteHandler routeHandler = routeData.RouteHandler;
        if (routeHandler == null) throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, SR.GetString("UrlRoutingModule_NoRouteHandler"), new object[0]));
        if (!(routeHandler is StopRoutingHandler))
        {
            //3.根据HttpContext和RouteData得到RequestContext对象
            RequestContext requestContext = new RequestContext(context, routeData);
            context.Request.RequestContext = requestContext;

            //4.根据RequestContext对象得到处理当前请求的HttpHandler（MvcHandler）。
            IHttpHandler httpHandler = routeHandler.GetHttpHandler(requestContext);
            if (httpHandler == null)
            {
                object[] args = new object[] { routeHandler.GetType() };
                throw new InvalidOperationException(string.Format(CultureInfo.CurrentUICulture, SR.GetString("UrlRoutingModule_NoHttpHandler"), args));
            }
            if (httpHandler is UrlAuthFailureHandler)
            {
                if (!FormsAuthenticationModule.FormsAuthRequired) throw new HttpException(0x191, SR.GetString("Assess_Denied_Description3"));
                UrlAuthorizationModule.ReportUrlAuthorizationFailure(HttpContext.Current, this);
            }
            else
                //5.请求转到HttpHandler进行处理（进入到ProcessRequest方法）。这一步很重要，由这一步开始，请求才由UrlRoutingModule转到了MvcHandler里面
                context.RemapHandler(httpHandler);
        }
    }
}

总结

1.请求被UrlRoutingModule部件拦截————通过注册HttpApplication对象的PostResolveRequestCache事件来实现拦截
2.封装请求上下文HttpContext，成为HttpContextWrapper对象。————将UrlRoutingModule的Init()方法转到定义，可以看到这么一句： HttpContextBase context = new HttpContextWrapper(((HttpApplication) sender).Context);
3.根据当前的HttpContext，从Routes集合中得到与当前请求URL相符合的RouteData对象。————将UrlRoutingModule的Init()方法转到定义，最终会找到PostResolveRequestCache()方法，方法里面有一句 RouteData routeData = this.RouteCollection.GetRouteData(context);
4.将RouteData与HttpContext请求封装成一个RequestContext对象。————同样在上述方法里面 RequestContext requestContext = new RequestContext(context, routeData);
5.根据RequestContext对象，从RouteData的RouteHandler中获取IHttpHandler（MVC里面会有一个IHttpHandler的实现类MvcHandler）。————同样在该方法里面 IHttpHandler httpHandler = routeHandler.GetHttpHandler(requestContext);
6.执行IHttpHandler（MvcHandler）。———— context.RemapHandler(httpHandler); 将请求交给MvcHandler处理。
7.然后就是通过反射激活具体的controller，执行具体的action。————在MvcHandler的ProcessRequest()方法里面的执行逻辑.