自訂 HttpModule 的範例

下列自訂模組只會在任何 HTTP 要求之前傳回一則 Web 網頁訊息，並在要求處理完畢後傳回另一則訊息。下列的 Init 函式會註冊兩個 HttpApplication 事件 (BeginRequest 和 EndRequest) 的事件處理常式。所有處理常式都被撰寫成模組的私用方法。引發註冊的事件時，ASP.NET 呼叫適當的處理常式方法，該方法將撰寫和傳回 Web 網頁。

using System;
using System.Web; 
using System.Collections;

public class HelloWorldModule : IHttpModule {
    public String ModuleName { 
        get { return "HelloWorldModule"; } 
    }    
    
    // In the Init function, register for HttpApplication 
    // events by adding your handlers.
    public void Init(HttpApplication application) {
        application.BeginRequest += (new EventHandler(this.Application_BeginRequest));
        application.EndRequest += (new EventHandler(this.Application_EndRequest));
    }
    
    // Your BeginRequest event handler.
    private void Application_BeginRequest(Object source, EventArgs e) {
        HttpApplication application = (HttpApplication)source;
        HttpContext context = application.Context;
        context.Response.Write("<h1><font color=red>HelloWorldModule: Beginning of Request</font></h1><hr>");
    }
    
    // Your EndRequest event handler.
    private void Application_EndRequest(Object source, EventArgs e) {
        HttpApplication application = (HttpApplication)source;
        HttpContext context = application.Context;
        context.Response.Write("<hr><h1><font color=red>HelloWorldModule: End of Request</font></h1>");
    }        
    
    public void Dispose() 
    {
    }
}

[Visual Basic]
Imports System
Imports System.Web
Imports System.Collections

Public Class HelloWorldModule
    Implements IHttpModule

    Public ReadOnly Property ModuleName() As [String]
        Get
            Return "HelloWorldModule"
        End Get
    End Property

    ' In the Init function, register for HttpApplication 
    ' events by adding your handlers.
    Public Sub Init(ByVal application As HttpApplication) Implements IHttpModule.Init
        AddHandler application.BeginRequest, AddressOf Me.Application_BeginRequest
        AddHandler application.EndRequest, AddressOf Me.Application_EndRequest
    End Sub

    ' Your BeginRequest event handler.
    Private Sub Application_BeginRequest(ByVal [source] As [Object], ByVal e As EventArgs)
        Dim application As HttpApplication = CType([source], HttpApplication)
        Dim context As HttpContext = application.Context
        context.Response.Write("<h1><font color=red>HelloWorldModule: Beginning of Request</font></h1><hr>")
    End Sub

    ' Your EndRequest event handler.
    Private Sub Application_EndRequest(ByVal [source] As [Object], ByVal e As EventArgs)
        Dim application As HttpApplication = CType([source], HttpApplication)
        Dim context As HttpContext = application.Context
        context.Response.Write("<hr><h1><font color=red>HelloWorldModule: End of Request</font></h1>")
    End Sub

    Public Sub Dispose() Implements IHttpModule.Dispose
    End Sub
End Class

註冊模組，如下所示：

<configuration>
    <system.web>
        <httpModules>
            <!-- <add name="HelloWorldModule" 
                      type="HelloWorldModule, HelloWorldModule" /> -->
        </httpModules>
    </system.web>
</configuration>

請參閱

HTTP Runtime 支援 | HttpModules | 處理公用事件 | 處理和引發事件