.NET WCF 错误生成不正确的 SOAP 1.1 错误代码值
-
09-06-2019 - |
题
我正在尝试使用FaultException 和FaultException<T> 来确定应用程序中的最佳使用模式。我们需要支持 WCF 以及非 WCF 服务使用者/客户端,包括 SOAP 1.1 和 SOAP 1.2 客户端。
供参考:将FaultExceptions 与wsHttpBinding 结合使用会产生SOAP 1.2 语义,而将FaultExceptions 与basicHttpBinding 结合使用会产生SOAP 1.1 语义。
我使用以下代码抛出FaultException<FaultDetails>:
throw new FaultException<FaultDetails>(
new FaultDetails("Throwing FaultException<FaultDetails>."),
new FaultReason("Testing fault exceptions."),
FaultCode.CreateSenderFaultCode(new FaultCode("MySubFaultCode"))
);
FaultDetails 类只是一个简单的测试类,其中包含一个字符串“Message”属性,如下所示。
使用 wsHttpBinding 时,响应为:
<?xml version="1.0" encoding="utf-16"?>
<Fault xmlns="http://www.w3.org/2003/05/soap-envelope">
<Code>
<Value>Sender</Value>
<Subcode>
<Value>MySubFaultCode</Value>
</Subcode>
</Code>
<Reason>
<Text xml:lang="en-US">Testing fault exceptions.</Text>
</Reason>
<Detail>
<FaultDetails xmlns="http://schemas.datacontract.org/2004/07/ClassLibrary" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Message>Throwing FaultException<FaultDetails>.</Message>
</FaultDetails>
</Detail>
根据 SOAP 1.2 规范,这看起来是正确的。主/根“代码”是“Sender”,其“子代码”为“MySubFaultCode”。如果服务使用者/客户端使用 WCF,则客户端的FaultException 也会模仿相同的结构,其中faultException.Code.Name 为“Sender”,faultException.Code.SubCode.Name 为“MySubFaultCode”。
使用 basicHttpBinding 时,响应为:
<?xml version="1.0" encoding="utf-16"?>
<s:Fault xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<faultcode>s:MySubFaultCode</faultcode>
<faultstring xml:lang="en-US">Testing fault exceptions.</faultstring>
<detail>
<FaultDetails xmlns="http://schemas.datacontract.org/2004/07/ClassLibrary" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Message>Throwing FaultException<FaultDetails>.</Message>
</FaultDetails>
</detail>
</s:Fault>
这看起来不对。查看 SOAP 1.1 规范,当我使用FaultCode.CreateSenderFaultCode(new FaultCode("MySubFaultCode")) 时,我期望看到“faultcode”的值为“s:Client.MySubFaultCode”。WCF 客户端也会得到不正确的结构。failureException.Code.Name 是“MySubFaultCode”而不是“Sender”,faultException.Code.SubCode 是 null,而不是 failureException.Code.SubCode.Name 是“MySubFaultCode”。此外,faultException.Code.IsSenderFault 为 false。
使用FaultCode.CreateReceiverFaultCode(new FaultCode("MySubFaultCode"))时出现类似问题:
- 按 SOAP 1.2 的预期工作
- 生成“s:MySubFaultCode”而不是“s:Server.MySubFaultCode”,并且对于 SOAP 1.1,faultException.Code.IsReceiverFault 为 false
这篇文章也被其他人发布在 http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=669420&SiteID=1 2006年就没有人回答过这个问题。我很难相信还没有人遇到过这种情况。
这是其他人也有类似的问题: http://forums.microsoft.com/msdn/ShowPost.aspx?PostID=3883110&SiteID=1&mode=1
微软连接错误: https://connect.microsoft.com/wcf/feedback/ViewFeedback.aspx?FeedbackID=367963
故障如何工作的描述: http://blogs.msdn.com/drnick/archive/2006/12/19/creating-faults-part-3.aspx
我做错了什么还是这确实是 WCF 中的错误?
解决方案
这是我当前的解决方法:
/// <summary>
/// Replacement for the static methods on FaultCode to generate Sender and Receiver fault codes due
/// to what seems like bugs in the implementation for basicHttpBinding (SOAP 1.1). wsHttpBinding
/// (SOAP 1.2) seems to work just fine.
///
/// The subCode parameter for FaultCode.CreateReceiverFaultCode and FaultCode.CreateSenderFaultCode
/// seem to take over the main 'faultcode' value in the SOAP 1.1 response, whereas in SOAP 1.2 the
/// subCode is correctly put under the 'Code->SubCode->Value' value in the XML response.
///
/// This workaround is to create the FaultCode with Sender/Receiver (SOAP 1.2 terms, but gets
/// translated by WCF depending on the binding) and an agnostic namespace found by using reflector
/// on the FaultCode class. When that NS is passed in WCF seems to be able to generate the proper
/// response with SOAP 1.1 (Client/Server) and SOAP 1.2 (Sender/Receiver) fault codes automatically.
///
/// This means that it is not possible to create a FaultCode that works in both bindings with
/// subcodes.
/// </summary>
/// <remarks>
/// See http://stackoverflow.com/questions/65008/net-wcf-faults-generating-incorrect-soap-11-faultcode-values
/// for more details.
/// </remarks>
public static class FaultCodeFactory
{
private const string _ns = "http://schemas.microsoft.com/ws/2005/05/envelope/none";
/// <summary>
/// Creates a sender fault code.
/// </summary>
/// <returns>A FaultCode object.</returns>
/// <remarks>Does not support subcodes due to a WCF bug.</remarks>
public static FaultCode CreateSenderFaultCode()
{
return new FaultCode("Sender", _ns);
}
/// <summary>
/// Creates a receiver fault code.
/// </summary>
/// <returns>A FaultCode object.</returns>
/// <remarks>Does not support subcodes due to a WCF bug.</remarks>
public static FaultCode CreateReceiverFaultCode()
{
return new FaultCode("Receiver", _ns);
}
}
遗憾的是,我没有找到一种在不破坏 SOAP 1.1 或 1.2 客户端的情况下使用子代码的方法。
如果使用 Code.SubCode 语法,则可以创建 SOAP 1.1 兼容的错误代码值,但它会破坏 SOAP 1.2。
如果您在.NET 中使用正确的子代码支持(通过静态FaultCode 方法或重载之一),它会破坏 SOAP 1.1,但可以在 SOAP 1.2 中工作。
其他提示
微软的回应:
正如中所讨论的 http://msdn.microsoft.com/en-us/library/ms789039.aspx, ,Soap 1.1规范中概述了两种自定义故障代码的方法:
(1)按照您的描述使用“点”符号
(2)定义全新的故障码
不幸的是,应该避免使用“点”表示法,因为 WS-I Basic Profile 规范不鼓励使用它。本质上,这意味着使用 Soap 1.1 时不存在与 Soap 1.2 故障子代码真正等效的代码。
因此,在生成错误时,您必须了解绑定中定义的 MessageVersion,并相应地生成错误代码。
由于“sender”和“receiver”不是 Soap 1.1 的有效故障代码,并且没有真正等效的故障子代码,因此在为 Soap 1.1 生成自定义故障代码时不应使用 CreateSenderFaultCode 和 CreateReceiverFaultCode 方法。
相反,您需要使用自己的命名空间和名称来定义自己的故障代码:
故障代码 customFaultCode = new 故障代码(本地名称, 故障名称空间);