HttpHandler の登録

[アーティクル]
03/28/2008

カスタム HttpHandler の作成後、ASP.NET を設定して、特定の URL に対する受信 HTTP 要求をハンドラに割り当てる必要があります。この作業に必要な手順を次に示します。

HttpHandler を登録するには

アプリケーションの仮想ルートの \bin ディレクトリにある HttpHandler の .NET のクラスをコンパイルして配置します。

アプリケーションの Web.config 構成ファイルに同期または非同期の HttpHandler を登録します。すべての HTTP 要求を Myhandler.dll ファイルのアセンブリ MyHandler 内の MyHandler.New クラスと MyHandler.Fin クラスに割り当てる例を次に示します。

<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>

<httpHandlers> 構成セクション内のエントリは、次の表に示す 3 つの属性を持っています。

属性	説明
path	path 属性には、1 つの URL パスまたは単純なワイルドカード文字列 (たとえば、*.aspx) を格納できます。
type	コンマ区切りのクラスとアセンブリの組み合わせを指定します。ASP.NET は初めにアプリケーションのプライベートな \bin ディレクトリを検索し、次にアセンブリのキャッシュ内を検索します。
verb	動詞リストは、HTTP メソッドのコンマ区切りのリスト (たとえば "GET, PUT, POST")、または開始スクリプトの割り当て (たとえばワイルドカード文字の * (アスタリスク)) にすることができます。

HttpHandler のファイル名拡張子がインターネットインフォメーションサービス (IIS: Internet Information Services) に登録されていることを確認します。

HttpHandler の例

ここでは、次のコード例を示します。

同期 HttpHandler
非同期 HttpHandler
HttpHandler ファクトリ

同期 HttpHandler

ASP.NET アプリケーション内の特定の MyApp.MyHello URL への要求を処理する方法を次のコードで示します。さらに、HttpHandler を登録するために必要な構成ファイルの変更も示します。

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

Web.config 内に次のようにエントリを作成して、カスタム HttpHandler を登録します。

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

非同期 HttpHandler

ASP.NET アプリケーション内の特定の *.MyAsynch URL への要求を登録し処理する方法を次のコードで示します。このコードでは、ハンドラは時間のかかるプロセスを起動し、いくつかの時点でユーザーに対して進行状況を示す応答を送信します。さらに、HttpHandler を登録するために必要な構成ファイルの変更も示します。

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

Web.config 内に次のようにエントリを作成して、カスタム非同期 HttpHandler を登録します。

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

参照

HTTP ランタイムサポート | ASP.NET の要求処理 | HttpHandler の作成 | HttpModule | イベントの処理と発生

次の方法で共有

HttpHandler の登録

HttpHandler の例

同期 HttpHandler

非同期 HttpHandler

参照

その他のリソース