HttpModule && HttpHandler

在 ASP.NET 中使用 HTTP 模块实现 Intercepting Filter

发布日期： 2004-4-1 | 更新日期： 2004-4-21

使用 Microsoft .NET 的企业解决方案模式 > 分布式系统模式 > 在 ASP.NET 中使用 HTTP 模块实现 Intercepting Filter

版本： 1.0.1

本页内容

	上下文
	实现策略
	示例
	测试考虑事项
	结果上下文
	相关模式
	致谢

上下文

您要在 Microsoft? ASP.NET 中利用许多不同类型的请求来构建 Web 应用程序。有些请求被转到适当的网页，而其他请求必须在处理之前以某种方式进行记录或修改。

返回页首

实现策略

Intercepting Filter （截取筛选器）模式的 ASP.NET 实现是该模式中所描述的事件驱动型筛选器的一个例子。ASP.NET 提供了应用程序可以在请求处理期间钩挂的一系列事件。这些事件保证了请求的状态。各个筛选器都是通过一个 HTTP 模块实现的。HTTP 模块是一个实现 IHttpModule 接口并确定应该何时调用筛选器的类。ASP.NET 包括一组可由应用程序使用的 HTTP 模块。例如，SessionStateModule 由 ASP.NET 提供，以便向应用程序提供会话状态服务。您可以创建自己的自定义 HTTP 模块，以便根据应用程序的需要筛选请求或响应。

编写自定义 HTTP 模块的一般过程是：

•	实现 IHttpModule 接口。
•	处理 Init 方法并注册到您需要的事件。
•	处理事件。
•	如果必须清理，也可以选择实现 Dispose 方法。
•	在 web.config 文件中注册模块。

事件

下表显示了可以使用 ASP.NET 截取的、在处理请求期间产生的事件。所有事件都是按照发生的顺序列出的。

第一个列表显示了处理请求之前产生的事件。

•	BeginRequest. 此事件标志着这是一个新请求；每个请求都必须产生该事件。
•	AuthenticateRequest. 此事件标志着所配置的身份验证机制已经验证了请求。附加到此事件可向筛选器确保请求已通过身份验证。
•	AuthorizeRequest. 与 AuthenticateRequest 一样，此事件标志着现在请求在处理过程中又前进了一步，并且请求已经得到授权。
•	ResolveRequestCache. 输出缓存模块使用此事件来简化对已经缓存的请求所进行的处理。
•	AcquireRequestState. 此事件标志着应该获得各个请求状态。
•	PreRequestHandlerExecute. 此事件标志着请求处理程序将要执行。这是在调用此请求的 HTTP 处理程序之前您可以参与的最后一个事件。

下一个列表显示了处理请求之后产生的事件。这些事件是按照发生的顺序列出的：

•	PostRequestHandlerExecute. 此事件标志着 HTTP 处理程序已经完成了对请求的处理。
•	ReleaseRequestState. 此事件标志着应该存储请求状态，因为应用程序已经完成了对请求的处理。
•	UpdateRequestCache. 此事件标志着代码处理已完成，可以将文件添加到 ASP.NET 缓存中。
•	EndRequest. 此事件标志着已完成对请求的所有处理。这是应用程序结束时所调用的最后一个事件。

此外，以下三个请求处理前事件可以按不确定顺序引发：

•	PreSendRequestHeaders.此事件标志着 HTTP 头将要发送给客户端。因此可以在发送之前添加、删除或修改头信息。
•	PreSendRequestContent. 此事件标志着内容将要发送给客户端。这为发送之前修改内容提供了一个机会。
•	Error. 此事件标志着有未处理的异常。

下面的示例说明了请求在通过了 ASP.NET 运行库的身份验证之后是如何被截取的。对名为 UserLogger 的示例模块进行初始化时，它将把一个名为 OnAuthenticate 的成员函数连接到 AuthenticateRequest 事件。每次对新的请求进行身份验证时，都会调用 OnAuthenticate 函数。在本示例中，OnAuthenticate 函数将把通过了身份验证的用户的名称记录到 Intercepting Filter 模式应用程序事件日志中。

 
   

  
     1
  
    
  
    using
  
     System; 

  
     2
  
    
  
    using
  
     System.Web; 

  
     3
  
    
  
    using
  
     System.Security.Principal; 

  
     4
  
    
  
    using
  
     System.Diagnostics; 

  
     5
  
    
  
    public
  
     
  
    class
  
     UserLogModule : IHttpModule 

  
     6
  
    
  
    
  
    { 
 7   private HttpApplication httpApp; 
 8   public void Init(HttpApplication httpApp) 
 9   { 
10      this.httpApp = httpApp; 
11      httpApp.AuthenticateRequest += new EventHandler(OnAuthentication); 
12   } 
13   void OnAuthentication(object sender, EventArgs a) 
14   { 
15      HttpApplication application = (HttpApplication)sender; 
16      HttpResponse response = application.Context.Response; 
17      WindowsIdentity identity =  
18         (WindowsIdentity)application.Context.User.Identity; 
19      LogUser(identity.Name); 
20   } 
21   private void LogUser(String name) 
22   { 
23      EventLog log = new EventLog(); 
24      log.Source = "Intercepting Filter Pattern"; 
25      log.WriteEntry(name,EventLogEntryType.Information); 
26   } 
27   public void Dispose() 
28   {} 
29}
  
     

  
    30
  
    
 
   

示例模块必须添加到 web.config 文件中，以便 ASP.NET 运行库能够识别该模块。下面是为 UserLogModule 示例模块进行了更改的配置文件：

<httpModules> 

      <add name="UserLogModule" type="UserLogModule, ifilter" /> 

</httpModules> 

返回页首

示例

下面是内置在 Microsoft .NET 中的截取筛选器的示例：

•	DefaultAuthenticationModule. 此筛选器确保 Authentication 对象出现在 HttpContext 对象中。
•	FileAuthorizationModule. 此筛选器验证远程用户是否拥有访问所请求的文件时所需的 Microsoft Windows NT? 权限。
•	FormsAuthenticationModule. 此筛选器使 ASP.NET 应用程序能够使用窗体验证。
•	PassportAuthenticationModule.此筛选器提供了包装 PassportAuthentication 服务以便进行 Passport 身份验证的包装器。
•	SessionStateModule. 此筛选器为应用程序提供会话状态服务。
•	UrlAuthorizationModule. 此筛选器提供基于 URL 的授权服务，以便允许或拒绝对指定 URL 进行访问。
•	WindowsAuthenticationModule. 此筛选器使 ASP.NET 应用程序能够使用 Microsoft Windows? 或 Internet 信息服务 (IIS) 的身份验证机制。

返回页首

测试考虑事项

如果没有 ASP.NET 运行库，就不可能测试 HTTP 模块。因此，必须采用稍微不同的实现策略，尽可能将更多的功能与实现 IHttpModule 接口的类分开。在前面的示例中，记录用户名的代码不需要 ASP.NET 运行库。此功能可以放在名为 UserLog 的类中，该类独立于 ASP.NET。实现 IHttpModule 接口的 UserLogAdapter 类可以使用 UserLog 类。这样，其他类就可以使用 UserLog 类，而且，您也可以在没有 ASP.NET 环境的情况下对它进行测试。以下是前面所描述的同一功能，但它允许在没有 ASP.NET 运行库的情况下对记录功能进行测试：

 
   

  
     1
  
    
  
    using
  
     System; 

  
     2
  
    
  
    using
  
     System.Diagnostics; 

  
     3
  
    
  
    public
  
     
  
    class
  
     UserLog 

  
     4
  
    
  
    
  
    { 
 5   public static void Write(String name) 
 6   { 
 7      EventLog log = new EventLog(); 
 8      log.Source = "Intercepting Filter Pattern"; 
 9      log.WriteEntry(name,EventLogEntryType.Information); 
10   } 
11}
  
     

  
    12
  
    
  
    using
  
     System; 

  
    13
  
    
  
    using
  
     System.Web; 

  
    14
  
    
  
    using
  
     System.Security.Principal; 

  
    15
  
    
  
    public
  
     
  
    class
  
     UserLogAdapter 

  
    16
  
    
  
    
  
    { 
17   private HttpApplication httpApp; 
18   public void Init(HttpApplication httpApp) 
19   { 
20      this.httpApp = httpApp; 
21      httpApp.AuthenticateRequest += new EventHandler(OnAuthentication); 
22   } 
23   void OnAuthentication(object sender, EventArgs a) 
24   { 
25      HttpApplication application = (HttpApplication)sender; 
26      HttpResponse response = application.Context.Response; 
27      WindowsIdentity identity =  
28         (WindowsIdentity)application.Context.User.Identity; 
29      UserLog.Write(identity.Name); 
30   } 
31   public void Dispose() 
32   {} 
33}
  
     

  
    34
  
    
 
   

 

结果上下文

Intercepting Filter 模式的实现具有下列优缺点：

优点

•	使用事件驱动的筛选器。ASP.NET 运行库提供了许多事件，这使程序员能够钩挂到适当的位置来添加功能。这是一个优点，因为程序员可以根据事件来假设请求的当前状态。例如，如果事件是 AuthenticateRequest，您可以假设在调用您的筛选器之前请求已通过了身份验证。
•	实现灵活的配置。通过编辑 web.config 文件可添加或删除模块。不必更改源代码，不必重新启动 ASP.NET 运行库。
•	降低了对顺序的依赖性。Intercepting Filter 的一个缺点是，筛选器不应该与顺序相关。因为 ASP.NET 实现会使用事件，它通过使用事件来指示某个处理已经发生来缓解该问题。

缺点

如果不测试整个 ASP.NET 运行库，对实现了 IHttpModule 接口的类进行测试将很困难或不可能