ASP.NET WebAPI框架解析第二篇（HttpModule的创建和使用）

我们先看一下执行流程图

图中画红圈的部分便是HttpModule，在说创建HttpModule之前，先说一下HttpApplication对象，HttpApplication对象由Asp.net框架创建，每个请求对应一个HttpApplcation实例对象，Asp.Net框架内部维护了一个HttpApplication对象池，可以复用该对象，以便节省服务器资源。HttpApplication对象内部有许多事件，其中的一些事件如下：

BeginRequest Asp.net处理的第一个事件，表示处理的开始

AuthenticateRequest 验证请求，一般用来取得请求用户的信息

PostResolveRequestCache 已经完成缓存的获取操作

……

EndRequest 本次请求处理完成

其中PostResolveRequestCache 这个事件就被路由模块监听了。我们看看一个标准HttpModule模块的接口定义是怎么样的。

public interface IHttpModule

{
     void Init(HttpApplication context);

void Dispose();

}

注意到Init(HttpApplication context)这个方法，每注册一个HttpModule模块，Asp.Net框架内部通过反射获取对应的程序集，并通过反射调用Init方法，Context参数便是处理一个Http请求的HttpApplication实例对象。那怎么让我们注册的模块参与到处理Http请求中呢？前面提到HttpApplication内部有许多事件，而我们的HttpModule中的Init方法会被Asp.Net框架调用，所以我们可以利用这个去注册相应的事件，执行我们的代码，我们在这里可以做很多事，比如自定义验证、自定义授权，图片压缩，图片加水印，服务器日志记录、恶意请求拦截等等。

为了演示自定义HttpModule的使用，我们创建一个寄宿模式为WebHost的WebAPI，为了便于理解ASP.NET WebAPI的组成，我们不直接创建一个WebAPI模板的项目。

1.使用VS2017创建一个空的解决方案

2.新建一个空的.NetFramwork类库项目和一个空的ASP.NET Web应用

我们对WebAPI类库项目引用WebAPI所需的System.Web.Http.dll。我在I:\Program Files (x86)\Microsoft Visual Studio\Shared\Packages\Microsoft.AspNet.WebApi.Core.5.2.7\lib\net45路径下找到了该dll。

然后在WebAPI项目下建立一个类，使用命名空间System.Web.Htpp，继承该命名空间下的ApiController即可，然后定义一个方法，我定义的如下。注意类名一定要以Controller结尾，否则在路由匹配成功后，WebAPI框架内部不能通过路由解析到的值去反射构建对应的控制器实例对象。

然后对WebHost项目引用如下dll（我都是在I:\Program Files (x86)\Microsoft Visual Studio\Shared\Packages\目录下找到的，实在找不到就创建一个WEBAPI模板然后到项目目录下的Package文件中去拷贝）

System.Web.Http.dll

System.Web.Http.WebHost.dll

System.Net.Http.Formatting.dll

WebHost项目还要保持对WebAPI项目的引用。

为WebHost项目添加Global.asax文件，VS为我们自动创建了一个Global类，并继承于System.Web命名空间下的HttpApplication类。这个类就是处理Http请求的类。我们也可以在这里监听相应的事件，监听函数格式以XXX_XXX的形式定义，至于为什么要这么定义的原因是为了便于通过反射进行注册。有些事件只能在这里监听，比如Application_Start，Application_Start在整个应用生命周期中只会执行一次，相当于静态构造函数.我们在Application_Start中去注册全局的路由表，在WebHost模式下，WebAPI的路由系统实际上由ASP.NET的路由系统完成的，当然WebAPI本身的路由系统也可以完成。我们注册以下路由表。

protected void Application_Start(object sender, EventArgs e)

{
     GlobalConfiguration.Configuration.Routes.MapHttpRoute(name: "first",routeTemplate: "webapi/{controller}/{action}");

}

然后在VS2017环境下使用IIS Express启动，然后在浏览器输入http://localhost:63210/webapi/home/index，注意在我这里端口号是63210。便可得到如下结果。

我们回顾一下这个流程。

->客户端（在这里是浏览器）发起HTTP请求

->IIS Express接收到该请求

->IIS Express发现该请求路径不是已知的静态资源类型，进而把请求交给Asp.Net托管代码处理

->Asp.Net从HttpApplication池中取一个实例对象去处理该Http请求

->注册相应HttpModule模块，并调用Init()函数，这个时候HttpContext还没有形成，我们只能在这里注册相应的监听事件函数。

->HttpContext形成，HttpApplication实例对象内部的事件轮流触发，其中有一个PostMapRequestHandler事件，在这个事件触发后，会调用相应HttpHandler执行相应的处理，后面再说HttpHandler

->必要的事件触发完成之后生成Http报文并交由IIS Express返回给客户端

->客户端接受Http报文并解析显示在客户端中。

这只是一个大概的过程，具体比这复杂，但我们关注点在HttpModule上，所以足够了。

我们现在尝试自己创建HttpModule

我在WebHost项目下建立了一个文件夹，然后新建了一个AuthorizeHttpModule，模拟授权，功能很简单，看Http请求头中是否包含name字段，并且值为HK，否则，向Http响应报文中的Body部分写入内容，并拦截请求。

namespace WebHost.HttpModules

{
     public class AuthorizeHttpModule : IHttpModule
     {
         public void Dispose()
         {
             return;
         }

public void Init(HttpApplication context)
         {
             //此时HttpContext还未构建完成，不能在这里操作HttpContext
             //注册事件监听函数
             context.BeginRequest += Authorize;
         }
         private void Authorize(object sender,EventArgs e)
         {
             HttpApplication app = sender as HttpApplication;

if (app.Request.Headers.Get("name") != "HK")
             {
                 //不加这一行客户端可能不能自动正确的解析字符编码
                 app.Response.Headers.Add("content-Type", "text/html;charset=utf-8");
                 //通过Write(string s)写入的字符串在内部默认被转换为utf-8编码。C#string默认编码为UTF-16
                 //要先写入原始的字符串编码，调用BinaryWrite(byte[] bytes)
                 app.Response.Write("验证不通过!");
                 app.CompleteRequest();
             }
         }
     }

}

在WebHost项目目录下的Web.Config中配置HttpModule信息，以便Asp.Net框架读取。注意，有个全局的Web.Config文件，其中默认注册了许多HttpModule，其中有一个HttpModule(WebDAVModule)会截断Put和Delete请求。

如上，我添加了system.webServer节点（IIS集成模式下是这样配置，经典模式自行搜索），并在子节点modules下添加了自定义的HttpModule，其中name是HttpModule名称，ASP.NET内部会以这个名称作为Key，type表示HttpModule的类型名，以便反射读取相应的类型对象。该类型所在的程序集必须在Web应用程序的Bin目录，否则不能正常加载，由于我创建的HttpMudle是在WebHost项目中，所以不会出现问题。我们现在启动IIS Express看看效果。

可以看到我们的HttpModule起作用了。我们用PostMan为请求头添加一个字段name，值为HK，然后请求/webapi/home/index试试看

可以看到没有被拦截。前面我们提到了一个HttpHandler，这个HttpHandler实际上是最终处理页面的处理者，后面再说。