扩展对错误处理和错误报告的控制

项目
05/09/2023

ErrorHandling 示例演示如何在 Windows Communication Foundation (WCF) 服务中使用 IErrorHandler 接口对错误处理和错误报告进行扩展控制。该示例基于入门指南，并且向服务添加了一些附加代码以处理错误。客户端强制实施若干个错误条件。服务将截获这些错误并将其记录到某个文件中。

注意

本主题的最后介绍了此示例的设置过程和生成说明。

服务可以截获错误、执行处理，并使用 IErrorHandler 接口影响错误报告的方式。该接口有两个可以实现的方法：ProvideFault(Exception, MessageVersion, Message) 和 HandleError。通过 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);
        }
    }
}

该示例实现计算器服务。客户端通过提供具有非法值的参数，使该服务故意出现两个错误。 CalculatorErrorHandler 使用 IErrorHandler 接口将这些错误记录到某个本地文件，然后允许将这些错误报告回客户端。客户端强制执行除以零的除法运算和自变量超出范围的情况。

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.

设置、生成和运行示例

请确保已执行 Windows Communication Foundation 示例的一次性安装过程。
要生成解决方案，请按照生成 Windows Communication Foundation 示例中的说明进行操作。
确保您已经为 error.txt 文件创建了 c:\logs 目录，或者修改 CalculatorErrorHandler.HandleError 中使用的文件名。
要使用单机配置或跨计算机配置来运行示例，请按照运行 Windows Communication Foundation 示例中的说明进行操作。

扩展对错误处理和错误报告的控制

设置、生成和运行示例

其他资源