定义和指定错误

项目
09/12/2008

SOAP 错误可将错误情况信息从服务传达到客户端，在双工情况下，还可以以互操作方式从客户端传达到服务。本主题讨论何时以及如何定义自定义错误内容并指定哪些操作可返回它们。有关服务或双工客户端如何发送这些错误以及客户端或服务应用程序如何处理这些错误的更多信息，请参见发送和接收错误。有关 Windows Communication Foundation (WCF) 应用程序中的错误处理的概述，请参见在协定和服务中指定和处理错误。

概述

声明的 SOAP 错误是指其中的某个操作具有 System.ServiceModel.FaultContractAttribute 的错误，该属性指定自定义 SOAP 错误类型。未声明的 SOAP 错误是指那些未在相应操作的协定中指定的错误。本主题帮助您识别这些错误情况并为您的服务创建一个错误协定，当收到自定义 SOAP 错误时，客户端可以用它正确地处理这些错误情况。基本任务依次为：

定义服务的客户端应该知道的错误情况。
为这些错误情况定义 SOAP 错误的自定义内容。
标记您的操作，以便以 WSDL 向客户端公开这些操作引发的特定 SOAP 错误。

定义客户端应该知道的错误情况

SOAP 错误是公开描述的、传达特定操作的错误信息的消息。由于它们是同其他操作消息一起以 WSDL 描述的，因此客户端应该知道它们且希望在调用某个操作时处理这样的错误。但由于 WCF 服务是用托管代码编写的，因此当决定将托管代码中的哪些错误情况转换到错误中去并返回到客户端时，可以从您与某个客户端的正式错误会话中区分服务中的错误情况和 Bug。

例如，下面的代码示例演示一个采用两个整数并返回另一个整数的操作。这里可引发若干个异常，因此设计错误协定时，必须确定哪些是客户端最重要的错误情况。在这种情况下，服务应该删除 System.DivideByZeroException 异常。

[ServiceContract]
public class CalculatorService
{
    [OperationContract] 
    int Divide(int a, int b)
    {
      if (b==0) throw new Exception(“Division by zero!”);
      return a/b;
    }
}

<ServiceContract> _
Public Class CalculatorService
    <OperationContract]> _
    Public Function Divide(ByVal a As Integer, ByVal b As Integer) _
       As Integer
      If (b==0) Then 
            Throw New Exception("Division by zero!")
      Return a/b
    End Function
End Class

在上面的示例中，该操作可返回一个特定的除以零的自定义 SOAP 错误、可返回一个特定于数学运算但包含特定的除以零信息的自定义错误、可为若干个不同错误情况返回多个错误，或根本不返回 SOAP 错误。

定义错误情况的内容

将某个错误情况标识为可有效地返回一个自定义 SOAP 错误后，下一步是定义该错误的内容并确保内容结构可以被序列化。上面的代码示例演示的是特定于 Divide 运算的一个错误，如果 Calculator 服务上还存在其他运算，则单个自定义 SOAP 错误可通知客户端所有计算器错误情况，包括 Divide。下面的代码示例演示如何创建一个自定义 SOAP 错误 MathFault，它可以报告使用所有数学运算（包括 Divide）时产生的错误。当该类可以指定一个操作（Operation 属性）和一个描述问题的值（ProblemType 属性）时，该类和这些属性必须被序列化以便以自定义 SOAP 错误的形式传输到客户端。因此，使用 System.Runtime.Serialization.DataContractAttribute 和 System.Runtime.Serialization.DataMemberAttribute 属性 (Attribute)，以使该类型及其属性 (Property) 可序列化和尽可能可互操作。

有关如何确保数据可序列化的更多信息，请参见在服务协定中指定数据传输。有关 System.Runtime.Serialization.DataContractSerializer 所提供的序列化支持的列表，请参见数据协定序列化程序支持的类型。

标记操作以建立错误协定

定义了一个将作为自定义 SOAP 错误的一部分返回的可序列化数据结构后，最后一步是将操作协定标记为引发该类型的一个 SOAP 错误。为此，可以使用 System.ServiceModel.FaultContractAttribute 属性并传递构造的自定义数据类型的类型。下面的代码示例演示如何使用 FaultContractAttribute 属性将 Divide 运算指定为可以返回一个 MathFault 类型的 SOAP 错误。现在也可以将其他基于数学的运算指定为可以返回 MathFault。

可以将某个操作指定为返回一个以上的自定义错误，方法为使用一个以上的 FaultContractAttribute 属性标记该操作。

下一步是在操作实现中实现错误协定，详见主题发送和接收错误。

SOAP、WSDL 和互操作性的注意事项

在某些情况下，特别是与其他平台进行互操作时，控制错误在 SOAP 消息中的显示方式或在 WSDL 元数据中对它的描述方式可能会十分重要。

FaultContractAttribute 属性 (Attribute) 有一个 Name 属性 (Property)，可以控制在元数据中为该错误生成的 WSDL 错误元素名称。

根据 SOAP 标准，一个错误可有一个 Action、一个 Code，以及一个 Reason。Action 受 Action 属性控制。Code 属性和 Reason 属性是 System.ServiceModel.FaultException 类的两个属性，该类是泛型 System.ServiceModel.FaultException 的父类。Code 属性包含一个 SubCode 成员。

访问产生错误的非服务时，存在一定的限制。WCF 仅支持具有详细信息类型的错误，这些详细信息类型由架构描述且与数据协定兼容。例如，如上所述，WCF 不支持在其详细信息类型中使用 XML 属性的错误，或在详细信息部分有一个以上顶级元素的错误。

另请参见

通过