在 asp.net 开发服务器上调试 httpmodule

Question

我想在我的 ASP.NET 应用程序（v 3.5，Visual Studio 2008）中集成一些 http 模块，并且我不确定如何在运行 Web 时触发的 ASP.NET 开发服务器中调试或使用此类模块应用程序。

我是否需要在解决方案中包含模块源，或者我可以将 DLL 放入 BIN 中吗？ 我来自 1.1 世界，还不习惯 asp.net 开发服务器。

Answer 1

请按照以下步骤添加 HTTP 模块：

1. 创建一个名为 MyModule 的新 Visual Studio .NET C# 类库项目。
2. 设置对 System.Web.dll 程序集的引用。

3. 将以下指令添加到类中：

   使用 System.Web;                     
     

4. 重命名该类 SyncModule.cs，然后更改类定义以反映这一点。

5. 实现IHttpModule接口。 您的类定义应如下所示：

   公共类SyncModule：IHttpModule                     
     

6. 决定您将订阅哪些事件。 以下列表概述了您可以订阅的 HttpApplication 对象中的可用事件：

   • AcquireRequestState：调用此事件以允许模块获取或创建请求的状态（例如会话）。
   • AuthenticateRequest：当安全模块需要在处理请求之前对用户进行身份验证时，调用此事件。
   • AuthorizeRequest：当请求需要授权时，安全模块调用此事件。 身份验证后调用。
   • BeginRequest：调用此事件以通知模块新请求正在开始。
   • Dispose：调用此事件来通知模块应用程序由于某种原因正在结束。 允许模块执行内部清理。
   • EndRequest：调用此事件通知模块请求已结束。
   • Error：调用此事件以通知模块在请求处理过程中发生错误。
   • PostRequestHandlerExecute：调用此事件通知模块处理程序已完成对请求的处理。
   • PreRequestHandlerExecute：调用此事件通知模块即将调用请求的处理程序。
   • PreSendRequestContent：调用此事件通知模块内容即将发送到客户端。
   • PreSendRequestHeaders：调用此事件通知模块 HTTP 标头即将发送到客户端。
   • ReleaseRequestState：调用此事件以允许模块释放状态，因为处理程序已完成对请求的处理。
   • ResolveRequestCache：身份验证后调用此事件。 缓存模块使用此事件来确定请求是否应由其缓存处理，或者处理程序是否应处理该请求。
   • UpdateRequestCache：在处理程序响应后调用此事件。 缓存模块应使用响应更新其缓存。

7. 实现IHttpModule接口的Init和Dispose方法如下：

   public void Init(HttpApplication 应用程序) 
     { 
        app.BeginRequest += new EventHandler(OnBeginRequest); 
     } 
     公共无效处理（）{} 
     

8. 为事件创建委托，如下所示：

   public delegate void MyEventHandler(Object s, EventArgs e);     
     

9. 定义 MyEventHandler 类型的私有局部变量来保存对事件的引用：

   private MyEventHandler _eventHandler = null;                     
     

10. 创建一个事件，将委托挂接到 Global.EventHandler 中的方法。继承自 HttpApplication 对象的 asax 文件或类：

    公共事件 MyEventHandler MyEvent 
      { 
         添加 { _eventHandler += 值;   } 
         删除 { _eventHandler -= 值;   } 
      } 
      

11. 创建 OnBeginRequest 方法，它挂接到 HttpApplication 的 BeginRequest 事件：

    public void OnBeginRequest(Object s, EventArgs e) 
      { 
         HttpApplication app = s as HttpApplication； 
         app.Context.Response.Write("来自自定义模块中 OnBeginRequest 的问候。
    "); 
         if(_eventHandler!=null) 
            _eventHandler(this, 空); 
      }         
      

12. 编译项目

源：http://support.microsoft.com/kb/307996

将 HTTP 模块添加到您的 web.config 中将如下所示：

<system.web>
    <httpModules>
       <add name="CustomHttpModule" type="MyCustomHttpModule"/>
    </httpModules>
</system.web>

Answer 2

在 HttpModule 中未命中断点的两个常见原因是：

断点位于模块构造期间调用的代码中。

这个总是让我着迷。 如果您想调试模块的构造您应该手动附加调试器。
要在 Windows 7 上执行此操作（在 Vista 上类似）：

1. 调试 | 附加到进程...
2. 选中在所有会话中显示进程。
3. 选择您的工作进程实例 (w3wp.exe)
4. 单击附加。

刷新浏览器，您现在应该到达断点。

由于配置问题，该模块实际上并未被加载。

如果您可以判断模块代码肯定正在执行，那么这不是问题。 但有时，虽然模块在其他计算机上加载正常，但它可能无法加载到您的开发盒上，因为您有不同版本的 IIS 并且没有必要的配置。

如果是这种情况，请确保该模块针对所有所需的 IIS 版本正确连接。

对于 IIS 5.1 和 IIS 6...

<system.web>
  <httpModules>
    <add name="CustomHttpModule" type="MyCustomHttpModule"/>
  </httpModules>
</system.web>

...以及 IIS 7+

<system.webServer>
  <modules runAllManagedModulesForAllRequests="true">
    <add name="CustomHttpModule" type="MyCustomHttpModule"/>
  </modules>
</system.webServer>

Answer 3

请注意，这似乎并不是开箱即用的。 确保不仅包含新模块的类名，还显式定义其命名空间和（为了完整性）程序集。 如果您未能做到这一点，则很可能最终会导致 IIS 抱怨无法加载您刚刚编码的新 HTTP 模块。

下面是一个例子。

而不是：

<add name="CustomHttpModule" type="MyCustomHttpModule"/>

使用：

<add name="CustomHttpModule" type="MyCustomRootNamespace.MyCustomHttpModule, MyCustomAssembly"/>

如果不这样做，您的项目可能无法加载。

您可能收到的具体错误取决于您定义模块的明确程度。 如果省略命名空间，您将看到：

Could not load type 'MyCustomHttpModule'.

省略命名空间并包含程序集，您将看到：

Could not load type 'MyCustomHttpModule' from assembly 'MyCustomAssembly'. 

如果您看到另一条错误消息，则您遇到的问题与此处讨论的问题不同。

Answer 4

您可以编写 System.Diagnostics.Debugger.Break

(); 行 //显式调用Break进行调试，

在HttpModule构建过程中显式调用断点。

它将要求附加进程（例如 w3wp.exe），然后调试点将命中。

谢谢

Answer 5

您可能还想确保您使用的是 Web 应用程序项目（即您在 VS2003 中使用的项目），而不是网站“项目”，因为网站“项目”不是项目。