Freigeben über

Registrieren von HttpHandler

Nachdem Sie einen benutzerdefinierten HttpHandler erstellt haben, müssen Sie ASP.NET so konfigurieren, dass eingehende HTTP-Anforderungen für bestimmte URLs dem Handler zugeordnet werden. Die folgende Prozedur besteht aus den erforderlichen Schritten.

So registrieren Sie einen "HttpHandler"

  1. Kompilieren Sie die .NET-Klasse für den HttpHandler im Verzeichnis \bin unter dem virtuellen Stammverzeichnis der Anwendung, und geben Sie sie weiter.

  2. Registrieren Sie den synchronen oder asynchronen HttpHandler in der Konfigurationsdatei Web.config der Anwendung. Im folgenden Beispiel werden alle HTTP-Anforderungen der MyHandler.New-Klasse und der MyHandler.Fin-Klasse in der MyHandler-Assembly zugeordnet, welche sich in der Datei Myhandler.dll befindet.

    <configuration>
    <system.web>
        <httpHandlers>
            <add verb="*" path="MyHandler.New" 
               type="MyHandler.New, MyHandlerAssembly" />
            <add verb="*" path="*.myNewFileNameExtension" 
               type="MyHandler.Fin, MyHandlerAssembly" />
        </httpHandlers>
    <system.web>
</configuration>

    Einträge innerhalb des <httpHandlers>-Konfigurationsabschnitts umfassen drei Attribute (siehe folgende Tabelle).

    Attribut Beschreibung
    Path Das path-Attribut kann entweder einen einzelnen URL-Pfad oder eine einfache Platzhalterzeichenfolge (z. B. *.aspx) enthalten.
    Type Gibt eine durch Kommas getrennte Klassen-/Assemblykombination an. ASP.NET sucht nach der Assembly-DLL zunächst im privaten \bin-Verzeichnis der Anwendung und anschließend im Assemblycache des Systems.
    Verb Die verb-Liste kann entweder eine durch Kommas getrennte Liste von HTTP-Methoden sein (z. B. "GET, PUT, POST") oder eine Startskriptzuordnung (z. B. das Platzhalterzeichen * [Sternchen]).

  3. Vergewissern Sie sich, dass die HttpHandler-Dateinamenerweiterung in Internet-Informationsdienste (IIS, Internet Information Services) registriert ist.

Beispiele für HttpHandler

Dieser Abschnitt enthält folgende Codebeispiele:

Synchroner HttpHandler

Anhand des folgenden Codes wird demonstriert, wie Anforderungen für den MyApp.MyHello-URL in einer ASP.NET-Anwendung verarbeitet werden. Anschließend werden die Konfigurationsdateiänderungen erläutert, die für die Registrierung des HttpHandler erforderlich sind.

using System.Web;
public class HelloWorldHandler : IHttpHandler {
    public void ProcessRequest(HttpContext context) {
        HttpRequest Request = context.Request;
        HttpResponse Response = context.Response;
        // A file ending in .MyHello need not exist. This handler executes
        // whenever a file ending in .MyHello is requested.
        Response.Write("<html>");
        Response.Write("<body>");
        Response.Write("<h1> Hello from Synchronous custom handler. </h1>");
        Response.Write("</body>");
        Response.Write("</html>");
    }
    public bool IsReusable {
        // To enable pooling, return true here.
        // This keeps the handler in memory.
        get { return false; }  
    }
}

[Visual Basic]
Imports System.Web

Public Class HelloWorldHandler
    Implements IHttpHandler

    Public Sub ProcessRequest(ByVal context As System.Web.HttpContext) Implements System.Web.IHttpHandler.ProcessRequest
        Dim request As HttpRequest = context.Request
        Dim response As HttpResponse = context.Response
        ' A file named ending in .MyHello need not exist. This handler 
        ' executes whenever a file ending in .MyHello is requested.
        response.Write("<html>")
        response.Write("<body>")
        response.Write("<h1> Hello from Synchronous custom handler. </h1>")
        response.Write("</body>")
        response.Write("</html>")
    End Sub

    Public ReadOnly Property IsReusable() As Boolean Implements System.Web.IHttpHandler.IsReusable
        Get
            Return False
        End Get
    End Property
End Class

Registrieren Sie den benutzerdefinierten HttpHandler, indem Sie in der Datei Web.config wie folgt einen Eintrag erstellen:

<configuration>
    <system.web>
        <httpHandlers>
           <add verb="*" path="*.MyHello" 
                type="HelloWorldHandler,httpruntime" /> 
        </httpHandlers>
    </system.web>
</configuration>

Asynchroner HttpHandler

Anhand des folgenden Codes wird demonstriert, wie Anforderungen für den *.MyAsynch-URL in einer ASP.NET-Anwendung registriert und verarbeitet werden. In diesem Fall startet der Handler einen zeitaufwendigen Prozess und sendet an mehreren Stellen eine Antwort an den Benutzer, um den Status anzugeben. Anschließend werden die Konfigurationsdateiänderungen erläutert, die für die Registrierung des HttpHandler erforderlich sind.

using System;
using System.Web;
using System.Threading;

namespace Handlers
{
    class AsynchHandler : IHttpAsyncHandler
    {
        private HttpContext _context;
        public bool IsReusable
        {
            get
            {
                 // To enable pooling, return true here.
                 // This keeps the handler in memory.
                 return false;
            }
        }

        public IAsyncResult BeginProcessRequest(HttpContext context,            AsyncCallback cb, Object extraData)
        {
            // Now do something that might take a while.
            MyAsynchOperation asynch = new MyAsynchOperation(cb, context);
            asynch.KickOffThread();

            context.Response.Write("BeginProcessRequest. Just kicked off a Thread.<br>");
            context.Response.Flush();

            // Signal the application that asynchronous 
            // processing is being performed. 
            SomeResult asynchForBegin = new SomeResult();

            // Processing is not synchronous.
            asynchForBegin.SetSynch(false);

            // Processing is not complete.
            asynchForBegin.SetCompleted(false);

            _context = context;
            return new SomeResult();
        }

        public void EndProcessRequest(IAsyncResult result)
        {
            _context.Response.Write("EndProcessRequest called.<br>");
        }

        // This method is required but is not called.
        public void ProcessRequest(HttpContext context)
        {
        }

    }//end class

    public class SomeResult : IAsyncResult
    {

    /*
    An instance of this class is returned to the application.
    This class lets the application know how the BeginEventHandler method     
    has been handled. The application checks the CompletedSynchronously     
    method.
    */

        private bool _blnIsCompleted = false;
        private Mutex myMutex = null;
        private Object myAsynchStateObject = null;
        private bool _blnCompletedSynchronously = false;

        public void SetCompleted(bool blnTrueOrFalse)
        {
            _blnIsCompleted = blnTrueOrFalse;
        }

        public void SetSynch(bool blnTrueOrFalse)
        {
            _blnCompletedSynchronously = blnTrueOrFalse;
        }

        public bool IsCompleted
        {
            // This is not called by the application. 
            // However, set it to true. 
            get { return _blnIsCompleted; }
        }

        public WaitHandle AsyncWaitHandle
        {
            // The application does not call this method.         
            get { return myMutex; }
        }

        public Object AsyncState
        {  
            // The application does not call this method because
            // null is passed in as the last parameter to 
            // BeginEventHandler.
            get { return myAsynchStateObject; }
       }

        public bool CompletedSynchronously
        {
            // The application wants to know if this is synchronous.
            // Return true if the Begin method was called synchronously.
            get { return _blnCompletedSynchronously; }
        }
    }
}

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

Namespace handler

    Public Class AsynchHandler
        Implements IHttpAsyncHandler

        Private _context As HttpContext
        Public ReadOnly Property IsReusable() As Boolean Implements System.Web.IHttpAsyncHandler.IsReusable
            Get
                Return False
            End Get
        End Property

        Public Function BeginProcessRequest(ByVal context As System.Web.HttpContext, ByVal cb As System.AsyncCallback, ByVal extraData As Object) As System.IAsyncResult Implements System.Web.IHttpAsyncHandler.BeginProcessRequest
            Dim asynch As New MyAsynchOperation(cb, context)
            asynch.KickOffThread()

            context.Response.Write("BeginProcessRequest. Just kicked off a Thread.<br>")
            context.Response.Flush()
            ' Signal the application that asynchronous 
            ' processing is being performed. 
            Dim asynchForBegin As New SomeResult()

           ' Processing is not synchronous.
            asynchForBegin.SetSynch(False)

           ' Processing is not complete.
            asynchForBegin.SetCompleted(False)

            _context = context

            Return New SomeResult()
        End Function


        Public Sub EndProcessRequest(ByVal result As System.IAsyncResult) Implements System.Web.IHttpAsyncHandler.EndProcessRequest
            _context.Response.Write("EndProcessRequest called.<br>")
        End Sub

        Public Sub ProcessRequest(ByVal context As System.Web.HttpContext) Implements System.Web.IHttpAsyncHandler.ProcessRequest
            ' Ths is required but is not called.
        End Sub
    End Class

    Class SomeResult
        Implements IAsyncResult

        Private _blnIsCompleted As Boolean = False
        Private myMutex As Mutex = Nothing
        Private myAsynchStateObject As Object = Nothing
        Private _blnCompletedSynchronously As Boolean = False

        Public Sub SetCompleted(ByVal blnTrueOrFalse As Boolean)
            _blnIsCompleted = blnTrueOrFalse
        End Sub

        Public Sub SetSynch(ByVal blnTrueOrFalse As Boolean)
            _blnCompletedSynchronously = blnTrueOrFalse
        End Sub

        Public ReadOnly Property AsyncState() As Object Implements System.IAsyncResult.AsyncState
            Get
                Return myAsynchStateObject
            End Get
        End Property

        Public ReadOnly Property AsyncWaitHandle() As System.Threading.WaitHandle Implements System.IAsyncResult.AsyncWaitHandle
            Get
                Return myMutex
            End Get
        End Property

        Public ReadOnly Property CompletedSynchronously() As Boolean Implements System.IAsyncResult.CompletedSynchronously
            Get
                Return _blnCompletedSynchronously
            End Get
        End Property

        Public ReadOnly Property IsCompleted() As Boolean Implements System.IAsyncResult.IsCompleted
            Get
                Return _blnIsCompleted
            End Get
        End Property
    End Class
End Namespace

Registrieren Sie den benutzerdefinierten asynchronen HttpHandler, indem Sie in der Datei Web.config wie folgt einen Eintrag erstellen:

<configuration>
    <system.web>
        <httpHandlers>
            <add verb="GET,POST" path="*.MyAsynch"
                 type="Handlers.AsynchHandler, Handlers" />
        </httpHandlers>
    </system.web>
</configuration>

Siehe auch

HTTP-Laufzeitunterstützung | Anforderungsverarbeitung in ASP.NET | Erstellen von HttpHandler | HttpModules | Behandeln und Auslösen von Ereignissen

  • Last updated on