ASP.Net Web 服务 - 将详细信息元素添加到适用于 SOAP 1.1 和 SOAP 1.2 的 SOAP 错误响应的正确方法是什么？

Question

ASP.Net 2.0 Web 服务自动创建 SOAP 1.1 和 SOAP 1.2 绑定。然而，我们的 Web 服务具有 SOAP 扩展和自定义异常处理，这些扩展和自定义异常处理假设仅使用 SOAP 1.1 绑定（例如，SOAP 扩展使用 HTTP SOAPAction 标头来控制行为）。

我希望纠正做出这些假设的代码，并使其能够正确地与 SOAP 1.1 或 SOAP 1.2 一起工作。我在为 SOAP 错误生成元素时遇到了一些问题。

考虑以下 Web 方法实现：

[WebMethod]
public void
ThrowsSoapException()
{
    throw new SoapException("This is a SOAP exception.", SoapException.ServerFaultCode);
}

通过 SOAP 1.1 调用此方法会产生以下结果：

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <soap:Fault>
         <faultcode>soap:Server</faultcode>
         <faultstring>This is a SOAP exception.</faultstring>
         <detail/>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

通过 SOAP 1.2 调用会产生以下结果：

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <soap:Fault>
         <soap:Code>
            <soap:Value>soap:Receiver</soap:Value>
         </soap:Code>
         <soap:Reason>
            <soap:Text xml:lang="en">This is a SOAP exception.</soap:Text>
         </soap:Reason>
         <soap:Detail/>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

在这两种情况下，都有一个空的详细信息元素作为 的子元素。 元素，但它具有不同的限定名称， 或 。

现在考虑以下代码，该代码尝试创建带有详细信息元素的 SOAPException。

[WebMethod]
public void
ThrowsSoapExceptionWithDetail()
{
    XmlDocument doc = new XmlDocument();
    XmlNode detail =
        doc.CreateNode(XmlNodeType.Element, SoapException.DetailElementName.Name, SoapException.DetailElementName.Namespace);
    XmlNode custom =
        doc.CreateNode(XmlNodeType.Element, "custom", "http://example.com/xml/namespace/blah");
    custom.InnerXml = "Detail value";
    detail.AppendChild(custom);
    throw new SoapException("This is a SOAP exception with a detail element.", SoapException.ServerFaultCode, Context.Request.Url.AbsoluteUri, detail);
}

SOAP 1.1 响应是：

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <soap:Fault>
         <faultcode>soap:Server</faultcode>
         <faultstring>This is a SOAP exception with a detail element.</faultstring>
         <faultactor>http://localhost/simplewebservice/service1.asmx</faultactor>
         <detail>
            <custom xmlns="http://example.com/xml/namespace/blah">Detail value</custom>
         </detail>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

SOAP 1.2 响应是：

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <soap:Fault>
         <soap:Code>
            <soap:Value>soap:Receiver</soap:Value>
         </soap:Code>
         <soap:Reason>
            <soap:Text xml:lang="en">This is a SOAP exception with a detail element.</soap:Text>
         </soap:Reason>
         <soap:Node>http://localhost/simplewebservice/service1.asmx</soap:Node>
         <detail>
            <custom xmlns="http://example.com/xml/namespace/blah">Detail value</custom>
         </detail>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

SOAP 1.2 响应现在的详细信息元素的限定名称是错误的。它应该是 ，但实际上只是 ，与 SOAP 1.1 响应相同。

ASP.Net 2.0 框架似乎已经做了相当多的工作来将 SOAPException 转换为 SOAP 版本的适当形式，但忽略了正确处理详细信息元素。此外，它们似乎没有像 SoapException.DetailElementName 属性那样公开详细信息元素的正确 SOAP 1.2 限定名称。

那么，向适用于 SOAP 1.1 和 SOAP 1.2 的 SOAP 错误响应添加详细信息元素的正确方法是什么？我是否需要自己检测 SOAP 版本并硬编码细节元素的 SOAP 1.2 限定名称？

Answer 1

不知道你的问题的编码部分，抱歉，但解决方法是在你的 web.config 中禁用soap1.2，如果你还没有这样看的话。

....
  <webServices>
    <protocols>
      <remove name="HttpSoap12"/>
    </protocols>
  </webServices>

Answer 2

以下内容绝无讽刺之意：

解决此问题的方法是使用 WCF。

这看起来像是 ASMX Web 服务处理 SOAP 1.2 错误中的详细信息元素时出现的错误。根据元素是否具有值来更改元素的限定名称显然是没有意义的。

您可以在 Connect 上报告此错误，但由于仅修复了关键的 ASMX 错误，因此这不太可能有帮助你。

我怀疑 WCF 有这个问题，因为它完全支持 SOAP 错误。

Answer 3

这是一个迟到的答案，但由于我自己也遇到了这个问题，所以我想我不妨将我的解决方案放在这里，这本质上是将 SOAP 协议的版本传递给构建错误的详细信息部分的方法信息。

WebService 派生 ASMX Web 服务类的类公开 SoapVersion 属性，其中包含用于发出当前 SOAP 请求的 SOAP 协议的版本。

然后可以轻松构建适合当前 SOAP 版本的详细信息部分。

using System.Xml.Linq;

XNamespace detailElementNamespace;
string detailElementName;
if (soapVersion == SoapProtocolVersion.Soap12)
{
    detailElementNamespace = "http://www.w3.org/2003/05/soap-envelope";
    detailElementName = "Detail";
}
else
{
    detailElementNamespace = "";
    detailElementName = "detail";
}

var document = new XmlDocument();
document.LoadXml(
    new XElement(detailElementNamespace + detailElementName,
        new XElement("MySection",
            new XElement("MyCode", "..."),
            new XElement("MyDescription", "...")
            )).ToString());

throw new SoapException(
    "MESSAGE",
    SoapException.ClientFaultCode,
    "ACTOR",
    document.DocumentElement);