エラー処理およびレポートに対する制御の拡張

[アーティクル]
05/09/2023

ErrorHandling サンプルでは、IErrorHandler インターフェイスを使用して Windows Communication Foundation (WCF) サービスのエラー処理およびエラー報告に対する制御を拡張する方法を示します。このサンプルは、「入門サンプル」に基づいており、エラー処理を行ういくつかのコードをサービスに追加しています。クライアントは、強制的にエラーが発生する状態にされます。サービスはエラーを途中受信して、ファイルに記録します。

Note

このサンプルのセットアップ手順とビルド手順については、このトピックの最後を参照してください。

サービスは 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);
}

このサンプルを実行すると、操作要求および応答がクライアントのコンソールウィンドウに表示されます。 0 による除算が行われたことと引数が範囲外の状態であることが、エラーとして報告されます。クライアントをシャットダウンするには、クライアントウィンドウで 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 または Network Service) が、このディレクトリに対する書き込み権限を持っていることを確認する必要があります。

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

サンプルをセットアップ、ビルド、および実行するには

Windows Communication Foundation サンプルの 1 回限りのセットアップの手順を実行したことを確認します。
ソリューションをビルドするには、「Windows Communication Foundation サンプルのビルド」の手順に従います。
error.txt ファイル用に c:\logs ディレクトリを作成したことを確認します。または、CalculatorErrorHandler.HandleError で使用されるファイル名を変更します。
単一または複数コンピューター構成でサンプルを実行するには、「Windows Communication Foundation サンプルの実行」の手順に従います。

エラー処理およびレポートに対する制御の拡張

サンプルをセットアップ、ビルド、および実行するには

その他のリソース