在 C# 中序列化 SOAP 参数

Question

我正在尝试为供应商的 SOAP 服务编写 .Net 客户端，但无法将 SOAP 消息的参数序列化为服务可识别的形式。

使用 wsdl.exe 我生成了一个服务代理类，它本身工作得很好。然而，其中一条消息接受一个参数，它是一个键/值对数组 - 这是我遇到的问题。

该消息的 WSDL 是：

  <message name='Execute'>
    <part name='ContextHandle' type='xsd:string'/>
    <part name='ScriptLanguage' type='xsd:string'/>
    <part name='Script' type='xsd:string'/>
    <part name='Params' type='xsd:anyType'/>
  </message>

服务代理类具有以下代码：

[System.Web.Services.WebServiceBindingAttribute(Name="EngineSoapBinding", Namespace="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts/wsdl/")]
internal partial class Service : System.Web.Services.Protocols.SoapHttpClientProtocol {

    ....

    [System.Web.Services.Protocols.SoapRpcMethodAttribute("http://www.smarteam.com/dev/ns/iplatform/embeddedscripts/action/Execute", RequestNamespace="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts", ResponseNamespace="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts", Use=SoapBindingUse.Literal)]
    [return: System.Xml.Serialization.SoapElementAttribute("Result")]
    public object Execute(string ContextHandle, string ScriptLanguage, string Script, object Params) {
        object[] results = this.Invoke("Execute", new object[] {
                    ContextHandle,
                    ScriptLanguage,
                    Script,
                    Params});
        return ((object)(results[0]));
    }

    ....

}

在供应商的文档中，Params 参数应该是键/值对的数组。

我已经能够捕获从另一个工作客户端到此服务的网络流量，并获得了该服务识别的以下消息示例（为了清晰起见，删除了 SOAP 信封并对其进行了格式化）：

<STES:Execute xmlns:STES="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts" xmlns:sof="http://www.smarteam.com/dev/ns/SOF/2.0">
    <ContextHandle>0019469#00228</ContextHandle>
    <ScriptLanguage>javascript</ScriptLanguage>
    <Script><![CDATA[Context.Result = Context.Params("Number");]]></Script>
    <Params SOAP-ENC:arrayType="sof:DictionaryItem[2]">
        <sof:DictionaryItem>
            <key xsi:type="xsd:string">Number</key>
            <value xsi:type="xsd:int">10</value>
        </sof:DictionaryItem>
        <sof:DictionaryItem>
            <key xsi:type="xsd:string">Hello</key>
            <value xsi:type="xsd:string">World</value>
        </sof:DictionaryItem>
    </Params>
</STES:Execute>

我已经尝试了 Params 参数的各种数据结构，但我尝试过的任何方法都无法提供与此 XML 序列化类似的效果。

我能得到的最接近的是编写一个 DictionaryItem 类，它使用以下 WriteXml 方法实现 IXmlSerialized ：

    public void WriteXml(XmlWriter writer)
    {
        writer.WriteStartElement("key");
        writer.WriteValue(Key);
        writer.WriteEndElement();
        writer.WriteStartElement("value");
        writer.WriteValue(Value);
        writer.WriteEndElement();
    }

然后我给出 < code>Params 参数是一个 List ，它会导致以下在线序列化。

<Execute xmlns="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts">
    <ContextHandle xmlns="">0022541#00228</ContextHandle>
    <ScriptLanguage xmlns="">javascript</ScriptLanguage>
    <Script xmlns="">Context.Result = Context.Params("Number");</Script>
    <Params xmlns="">
        <DictionaryItem xmlns="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts">
            <key>Number</key>
            <value>10</value>
        </DictionaryItem>
        <DictionaryItem xmlns="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts">
            <key>Hello</key>
            <value>World</value>
        </DictionaryItem>
    </Params>
</Execute>

谁能指出我正确的方向来使其正常工作？

** 更新 **

对于该供应商使用已弃用的消息格式，我一点也不感到惊讶。他们的整个产品一团糟，如果可以的话我很乐意放弃它。它是用 .Net 编写的，但有一个 COM API，并且此 Web 服务采用已弃用的格式。他们确实为 Web 服务提供了一个客户端库，但它是用 Java 编写的。啊？

我将回到最初的想法，使用 ikvmc 围绕 Java 客户端编写一个包装器。至少我知道我可以让它工作，即使所有类型转换都会很混乱。

至于选择答案，@Cheeso 和 @Aaronaught 都非常有帮助，所以我掷了一枚硬币并将其交给了 @Cheeso。

Answer 1

您在那里显示的示例消息显示了一条使用所谓的“SOAP 第 5 节编码”的消息。由于兼容性和互操作性问题，SOAP 编码（更不用说 SOAP）很久以前就被所有主要工具和服务供应商弃用了。就像2004年左右那样。

严重地。没有人应该再使用那些东西了。没有任何借口。

但即便如此，您应该能够让它工作。

面临的挑战是在每个请求和响应元素上获得正确的 XML 命名空间。只需查看示例请求消息（即“有效”的请求消息），您就会发现它有点疯狂。顶级请求元素上有带有 STES 前缀的命名空间 - Execute。然后，所有子元素根本没有命名空间。这很奇怪。

同样奇怪的开/关名称空间问题也发生在 Params 数组中。包装器元素位于带有 sof 前缀的命名空间中。但键和值子元素不在该命名空间中——它们根本不在命名空间中。

在你的尝试中，你会遇到一些不匹配的情况；

• 就您而言，DictionaryItem 元素位于 http://www.smarteam.com/dev/ns/iplatform/embeddedscripts 命名空间中。它应该位于 http://www.smartteam.com/dev/ns/SOF/2.0 命名空间中。

• 在您的情况下，key 和 value 元素位于
  http://www.smartteam.com/dev/ns/iplatform/embeddedscripts 命名空间。它们根本不应该位于任何命名空间中。

通常，正确的 WSDL 意味着您不必担心这些事情。我很困惑为什么您的 WSDL 没有生成执行正确操作的代理。在这种情况下，我建议人们做的是获得真正有效的 wSDL。通常，这意味着在 ASMX 中编写服务的模拟版本。

如果您可以在 ASMX 中生成一个接受真实服务所接受形式的消息的服务，并且如果您可以生成一个与该 ASMX 服务交互的客户端，那么该客户端也应该与真实服务一起工作。我推荐 ASMX 的原因是它很容易调整和重试。

为此，这就是我的想法。

<%@ WebService Language="c#"
      Class="Cheeso.CooperService"
      %>

using System.Web.Services;
using System.Web.Services.Description;
using System.Web.Services.Protocols;
using System.Xml.Serialization;
using System.Collections;

namespace Cheeso
{
    [SoapType(Namespace="http://www.smarteam.com/dev/ns/SOF/2.0")]
    public class DictionaryItem
    {
        public string key { get; set; }
        public string value { get; set; }
    }


    [System.Web.Services.WebService
     (Name="EngineSoapBinding",
      Namespace="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts/wsdl/")]
    public class CooperService : System.Web.Services.WebService
    {

        [WebMethod]
        [SoapRpcMethod
         ("http://www.smarteam.com/dev/ns/iplatform/embeddedscripts/action/Execute",
          RequestNamespace="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts",
          ResponseNamespace="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts",
          Use=SoapBindingUse.Encoded)]
        [return: System.Xml.Serialization.SoapElementAttribute("Result")]
        public object Execute(string ContextHandle,
                              string ScriptLanguage,
                              string Script,
                              DictionaryItem[] Params)
        {
            return "The answer is 42. What is the question?";
        }

    }
}

该 ASMX 文件应该生成一个 WSDL 和一个与您的实际服务等效的接口。从它生成 WSDL（使用 ?wsdl 查询），然后编写测试客户端。检查线路上的消息并根据需要进行调整。

您可以看到我将 REAL 类型应用于 Params 数组。我还使用 SoapType 属性修饰该类型并指定所需的 xml 命名空间。

在您的问题陈述中，您没有描述响应消息。您需要进行类似的练习 - 调整和调整 - 以便塑造客户“预期”的响应消息，以匹配真实服务实际生成的响应。

另外，请记住 xmlns 前缀并不重要。它是您需要匹配的前缀，它是 XML 名称空间本身。您不需要STES:Execute。您可以使用任何命名空间前缀，只要它映射到正确的 xml 命名空间即可。

祝你好运。

如果有机会，请说服他们转向符合 WS-I 的服务接口。当服务符合 WS-I 建议时，互操作就会容易得多。

---

编辑

这是来自客户端的实际消息的跟踪，使用该 WSDL 生成：

<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:tns="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts/wsdl/"
    xmlns:types="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts/wsdl/encodedTypes"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <q1:Execute xmlns:q1="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts">
      <ContextHandle xsi:type="xsd:string">00913983</ContextHandle>
      <ScriptLanguage xsi:type="xsd:string">Canadian, eh?</ScriptLanguage>
      <Script xsi:type="xsd:string">To be or not to be....</Script>
      <Params href="#id1" />
    </q1:Execute>
    <soapenc:Array id="id1"
                   xmlns:q2="http://www.smarteam.com/dev/ns/SOF/2.0"
                   soapenc:arrayType="q2:DictionaryItem[2]">
      <Item href="#id2" />
      <Item href="#id3" />
    </soapenc:Array>
    <q3:DictionaryItem id="id2"
                       xsi:type="q3:DictionaryItem"
                       xmlns:q3="http://www.smarteam.com/dev/ns/SOF/2.0">
      <key xsi:type="xsd:string">17</key>
      <value xsi:type="xsd:string">s9dkjdls</value>
    </q3:DictionaryItem>
    <q4:DictionaryItem id="id3"
                       xsi:type="q4:DictionaryItem"
                       xmlns:q4="http://www.smarteam.com/dev/ns/SOF/2.0">
      <key xsi:type="xsd:string">fish</key>
      <value xsi:type="xsd:string">barrel</value>
    </q4:DictionaryItem>
  </soap:Body>
</soap:Envelope>

即使这与您的目标消息不同，它应该可以由您的服务器解析 -侧面，如果它符合 SOAP v1.1 第 5 节编码规范。此请求消息使用“多重引用”序列化，而您的示例目标消息使用“单一引用”。但它们应该相当于服务器端。应该是。

但正如我最初所说，要使 SOAP 第 5 节编码能够互操作，存在很多问题。

Answer 2

WCF 解决方案确实相当简单，只需在导入中使用这些类：

[DataContract(Namespace = "http://www.smarteam.com/dev/ns/iplatform/embeddedscripts")]
[KnownType(typeof(SofDictionaryItem[]))]
[XmlSerializerFormat(Style = OperationFormatStyle.Rpc, Use = OperationFormatUse.Encoded)]
public class Execute
{
    [DataMember(Order = 0)]
    public string ContextHandle { get; set; }

    [DataMember(Order = 1)]
    public string ScriptLanguage { get; set; }

    public string Script { get; set; }

    [DataMember(Name = "Script", Order = 2, EmitDefaultValue = false)]
    private CDataWrapper ScriptCData
    {
        get { return Script; }
        set { Script = value; }
    }

    [DataMember(Order = 3)]
    public object Params { get; set; }
}


[DataContract(Namespace = "http://www.smarteam.com/dev/ns/SOF/2.0", Name = "DictionaryItem")]
public class SofDictionaryItem
{
    [DataMember]
    public object Key { get; set; }

    [DataMember]
    public object Value { get; set; }
}

我正在使用 Marc Gravell 的 CDataWrapper 此处强制 CDATA 标签围绕 Script。

DataContractSerializer 将生成与您已经通过网络看到的内容几乎相同的输出：

<Execute xmlns="http://www.smarteam.com/dev/ns/iplatform/embeddedscripts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <ContextHandle>0019469#00228</ContextHandle>
    <ScriptLanguage>javascript</ScriptLanguage>
    <Script><![CDATA[Context.Result = Context.Params("Number")]]></Script>
    <Params i:type="a:ArrayOfDictionaryItem" xmlns:a="http://www.smarteam.com/dev/ns/SOF/2.0">
        <a:DictionaryItem>
            <a:Key i:type="b:string" xmlns:b="http://www.w3.org/2001/XMLSchema">Number</a:Key>
            <a:Value i:type="b:int" xmlns:b="http://www.w3.org/2001/XMLSchema">10</a:Value>
        </a:DictionaryItem>
        <a:DictionaryItem>
            <a:Key i:type="b:string" xmlns:b="http://www.w3.org/2001/XMLSchema">Hello</a:Key>
            <a:Value i:type="b:string" xmlns:b="http://www.w3.org/2001/XMLSchema">World</a:Value>
        </a:DictionaryItem>
    </Params>
</Execute>

唯一潜在的问题是 ArrayOfDictionaryItem，它是.NET 似乎总是对数组类型使用这种约定。如果您实际查看为这些类型生成的 WSDL，您会发现它实际上引用soapenc:arrayType，但如果端点是不知道这个约定。如果是这种情况，那么不幸的是，我认为您必须求助于 IXmlSerialized，因为我一直无法找到一种方法来禁用 ArrayOf 生成。网。

正如 Cheeso 提到的，RPC/编码的 SOAP 格式已被 WS-I 正式弃用，并且永远不应再在生产服务中使用。它被弃用的原因之一是它的互操作性很差并且实施起来很痛苦。如果可能的话，您确实应该与供应商讨论获取更新，更新应该使用标准文档/文字传输格式。