为啥 SoapClient 在文档/文字样式中使用 WSDL 返回带有额外关键元素的数组？

Posted 2023-02-16

【中文标题】为啥 SoapClient 在文档/文字样式中使用 WSDL 返回带有额外关键元素的数组？

【英文标题】：Why does SoapClient using WSDL in document/literal style return array with extra key element?为什么 SoapClient 在文档/文字样式中使用 WSDL 返回带有额外关键元素的数组？

【发布时间】：2013-07-25 08:38:34

【问题描述】：

我们正在将 RPC/编码的 web 服务转换为 document/literal/wrapped。 WSDL（使用 nusoap）已经重写为使用新格式。

我像这样使用 php SoapClient：

new SoapClient($wsdlUrl, array(
    'cache_wsdl' => WSDL_CACHE_NONE,
    'trace' => true,
    'features' => SOAP_SINGLE_ELEMENT_ARRAYS,
));

相关的 WSDL 部分如下所示，（应该遵循 WS-I Basic Profile）：

<xsd:complexType name="messages">
    <xsd:sequence>
        <xsd:element name="item" type="xsd:string" maxOccurs="unbounded"/>
    </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="some_functionResponseType">
    <xsd:all>
        <xsd:element name="return" type="tns:messages" form="unqualified"/>
    </xsd:all>
</xsd:complexType>

<message name="some_functionResponse">
    <part name="parameters" element="tns:some_functionResponseType"/>
</message>

<operation name="some_function">
    <input message="tns:some_functionRequest"/>
    <output message="tns:some_functionResponse"/>
</operation>

当我提交请求时，XML 响应是这样的：

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
  <SOAP-ENV:Body>
    <some_functionResponse xmlns="urn:toets_nl_wsdl">
      <messages xmlns="">
        <item>foo</item>
        <item>bar</item>
      </messages>
    </some_functionResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

当我在 PHP 中转储结果对象时，它看起来像这样：

stdClass Object
(
    [messages] => stdClass Object
        (
            [item] => Array             // <-- here
                (
                    [0] => foo
                    [1] => bar
                )

        )

)

为什么结果树中有一个额外的元素“item”？当我们还在使用 RPC/encoded 时，这并不存在。

有没有办法在处理响应时删除该元素？

【问题讨论】：

您能发布 WSDL 和架构吗？当你还在使用 RPC/encoded 的时候是什么样子的？

【参考方案1】：

您的 WSDL 明确指出有一个项目的出现次数不受限制，其中包含字符串（也称为数组）。所以 PHP 只是向您呈现 WSDL 中描述的结构，并由服务器返回。

我看不出有什么问题。不要仅仅因为 Soap 的作用相同，就期望 Soap 与 RPC 相同。如果您不想要该 item 元素，请更改 WSDL 和服务 - 但这可能比将 PHP 客户端代码适合新数据结构更困难。

您甚至使用了 SOAP_SINGLE_ELEMENT_ARRAYS，这是避免检查元素是否真的是数组的好方法。

【讨论】：

WSDL 数组是根据 WS-I 规范构建的，我认为这是这里的权威来源？ (ws-i.org/profiles/…)。我看到 PHP 只是从字面上简单地解析它，并且我认为在检测到这个数组结构时它可能会“更智能”。其他（可能更成熟的）SOAP 客户端（其他语言）是否以同样的方式处理这个问题？

其他语言提供了不同的变量结构，可能能够更好地覆盖这种情况，但是 PHP 只能提供数组或对象——而且 SoapClient 本身也必须将这些数据结构映射回来和转为 XML。而做“智能”优化将是错误的——这就是为什么你有 SOAP_SINGLE_ELEMENT_ARRAYS，它在不同的级别上完全禁用了这种“智能”行为。

Sven，你找到解决问题的方法了吗？

【参考方案2】：

您是否完全确定它没有在 WSDL 定义中的某处指定？我确定服务器不会为了好玩而添加额外的元素:)

或者可能是文档编码风格的结果。

当返回数组类型的内容时，item 元素在 SAP Webservices（我经常使用）中非常常见，但就像我上面写的，它在 WSDL 中明确指定。

您可能还会发现，当数组只有一个元素时，item 将不是数组，因此请在您的代码中使用

if(!is_array($messages->item)) 
    $messages->item = array($messages->item);

【讨论】：

当只有一项时，PHP Soap 有一个选项 SOAP_SINGLE_ELEMENT_ARRAYS 来阻止您描述的行为。

是的，“项目”名称在 WSDL 中（也在消息中）。也许这正是您想在文档/文字中使用数组时得到的结果，但我希望我只是遗漏了一些东西。

我从未注意到 SOAP_SINGLE_ELEMENT_ARRAYS！感谢那。我一直认为是服务器决定了它:)