エラー処理とレポートの制御の拡張

ErrorHandling サンプルでは、IErrorHandler インターフェイスを使用して、Windows Communication Foundation (WCF) サービスでのエラー処理とエラー報告の制御を拡張する方法を示します。 このサンプルは、エラーを処理するためにサービスに追加されたコードの 概要 に基づいています。 クライアントは、いくつかのエラー状態を強制します。 サービスはエラーをインターセプトし、ファイルに記録します。

サービスは、エラーをインターセプトし、処理を実行し、 IErrorHandler インターフェイスを使用してエラーを報告する方法に影響を与える可能性があります。 インターフェイスには、 ProvideFault(Exception, MessageVersion, Message) と HandleErrorの 2 つのメソッドを実装できます。 ProvideFault(Exception, MessageVersion, Message) メソッドを使用すると、例外に応答して生成されるエラー メッセージを追加、変更、または抑制できます。 HandleError メソッドを使用すると、エラーが発生した場合にエラー処理を実行し、追加のエラー処理を実行できるかどうかを制御できます。

このサンプルでは、 CalculatorErrorHandler 型は IErrorHandler インターフェイスを実装します。 の

HandleError メソッドを使用すると、 CalculatorErrorHandler はエラーのログを c:\logs の Error.txt テキスト ファイルに書き込みます。 サンプルではエラーがログに記録され、抑制されず、クライアントに報告されます。

public class CalculatorErrorHandler : IErrorHandler
{
    // Provide a fault. The Message fault parameter can be replaced, or set to
    // null to suppress reporting a fault.

    public void ProvideFault(Exception error, MessageVersion version, ref Message fault)
    {
    }

    // HandleError. Log an error, then allow the error to be handled as usual.
    // Return true if the error is considered as already handled

    public bool HandleError(Exception error)
    {
        using (TextWriter tw = File.AppendText(@"c:\logs\error.txt"))
        {
            if (error != null)
            {
                tw.WriteLine("Exception: " + error.GetType().Name + " - " + error.Message);
            }
            tw.Close();
        }
        return true;
    }
}

ErrorBehaviorAttributeは、エラー ハンドラーをサービスに登録するメカニズムとして存在します。 この属性は、単一の型パラメーターを受け取ります。 この型は、 IErrorHandler インターフェイスを実装し、パブリックな空のコンストラクターを持つ必要があります。 その後、この属性は、そのエラー ハンドラー型のインスタンスをインスタンス化し、サービスにインストールします。 これを行うには、 IServiceBehavior インターフェイスを実装し、 ApplyDispatchBehavior メソッドを使用してエラー ハンドラーのインスタンスをサービスに追加します。

// This attribute can be used to install a custom error handler for a service.
public class ErrorBehaviorAttribute : Attribute, IServiceBehavior
{
    Type errorHandlerType;

    public ErrorBehaviorAttribute(Type errorHandlerType)
    {
        this.errorHandlerType = errorHandlerType;
    }

    void IServiceBehavior.Validate(ServiceDescription description, ServiceHostBase serviceHostBase)
    {
    }

    void IServiceBehavior.AddBindingParameters(ServiceDescription description, ServiceHostBase serviceHostBase, System.Collections.ObjectModel.Collection<ServiceEndpoint> endpoints, BindingParameterCollection parameters)
    {
    }

    void IServiceBehavior.ApplyDispatchBehavior(ServiceDescription description, ServiceHostBase serviceHostBase)
    {
        IErrorHandler errorHandler;

        try
        {
            errorHandler = (IErrorHandler)Activator.CreateInstance(errorHandlerType);
        }
        catch (MissingMethodException e)
        {
            throw new ArgumentException("The errorHandlerType specified in the ErrorBehaviorAttribute constructor must have a public empty constructor.", e);
        }
        catch (InvalidCastException e)
        {
            throw new ArgumentException("The errorHandlerType specified in the ErrorBehaviorAttribute constructor must implement System.ServiceModel.Dispatcher.IErrorHandler.", e);
        }

        foreach (ChannelDispatcherBase channelDispatcherBase in serviceHostBase.ChannelDispatchers)
        {
            ChannelDispatcher channelDispatcher = channelDispatcherBase as ChannelDispatcher;
            channelDispatcher.ErrorHandlers.Add(errorHandler);
        }
    }
}

このサンプルでは、電卓サービスを実装しています。 クライアントは、パラメーターに無効な値を指定することで、サービスで意図的に 2 つのエラーが発生します。 CalculatorErrorHandlerは、IErrorHandler インターフェイスを使用してエラーをローカル ファイルに記録し、クライアントに報告できるようにします。 クライアントは、強制的に 0 で除算し、引数が範囲外の条件を指定します。

try
{
    Console.WriteLine("Forcing an error in Divide");
    // Call the Divide service operation - trigger a divide by 0 error.
    value1 = 22;
    value2 = 0;
    result = proxy.Divide(value1, value2);
    Console.WriteLine("Divide({0},{1}) = {2}", value1, value2, result);
}
catch (FaultException e)
{
    Console.WriteLine("FaultException: " + e.GetType().Name + " - " + e.Message);
}
catch (Exception e)
{
    Console.WriteLine("Exception: " + e.GetType().Name + " - " + e.Message);
}

サンプルを実行すると、操作要求と応答がクライアント コンソール ウィンドウに表示されます。 ゼロによる除算と、引数の範囲外の条件がエラーとして報告されていることがわかります。 クライアント ウィンドウで Enter キーを押して、クライアントをシャットダウンします。

Add(15,3) = 18
Subtract(145,76) = 69
Multiply(9,81) = 729
Forcing an error in Divide
FaultException: FaultException - Invalid Argument: The second argument must not be zero.
Forcing an error in Factorial
FaultException: FaultException - Invalid Argument: The argument must be greater than zero.

Press <ENTER> to terminate client.

ファイル c:\logs\errors.txt には、サービスによってログに記録されたエラーに関する情報が含まれています。 サービスがディレクトリに書き込むには、サービスが実行されているプロセス (通常は ASP.NET またはネットワーク サービス) にディレクトリへの書き込みアクセス許可があることを確認する必要があります。

Fault: Reason = Invalid Argument: The second argument must not be zero.
Fault: Reason = Invalid Argument: The argument must be greater than zero.

サンプルを設定、ビルド、実行するには

1. Windows Communication Foundation サンプル のOne-Time セットアップ手順を実行していることを確認します。

2. ソリューションをビルドするには、「 Windows Communication Foundation サンプルのビルド」の手順に従います。

3. c:\logs directory for the error.txt ファイルが作成されていることを確認します。 または、 CalculatorErrorHandler.HandleErrorで使用されるファイル名を変更します。

4. 単一または複数のコンピューター間の構成でサンプルを実行するには、「Windows Communication Foundation Samplesの実行」の手順に従います。