PHP多维数组到SOAP XML的序列化实践与优化

本文旨在解决将复杂的php多维数组序列化为符合soap规范的xml格式的挑战。通过分析传统dom方法在处理嵌套结构和xml属性时的局限性，文章重点介绍并演示了如何利用`spatie/array-to-xml`库，通过精心构造php数组来精确映射xml元素、属性及命名空间，从而高效生成符合soap协议要求的xml数据，确保与web服务的顺畅通信。

在现代Web服务交互中，尤其是在使用SOAP协议时，将PHP中的复杂多维数组转换为特定结构的XML是一个常见且关键的任务。然而，直接使用PHP内置的DOM扩展或简单的递归函数来处理带有命名空间、属性以及复杂嵌套结构的XML时，往往会遇到挑战，导致序列化失败或生成不符合预期的XML。

传统DOM方法面临的挑战

开发者常常尝试通过自定义递归函数，利用DOMDocument和DOMElement来构建XML。例如，以下是一个常见的尝试：

function convertToXml($data, $name='root', &$doc=null, &$node=null){
    if ($doc==null){
        $doc = new DOMDocument('1.0','UTF-8');
        $doc->formatOutput = TRUE;
        $node = $doc;
    }

    if (is_array($data)){
        foreach($data as $var=>$val){
            if (is_numeric($var)){
                // 当数组键是数字时，通常需要特殊处理，这里简单地递归调用，可能导致元素名重复或结构不符
                convertToXml($val, $name, $doc, $node);
            }else{
                // 创建子元素，并递归处理其值
                if (!isset($child)){
                    $child = $doc->createElement($name);
                    $node->appendChild($child);
                }
                convertToXml($val, $var, $doc, $child);
            }
        }
    }else{
        // 处理非数组值，创建文本节点
        $child = $doc->createElement($name);
        $node->appendChild($child);
        $textNode = $doc->createTextNode($data);
        $child->appendChild($textNode);
    }

    if ($doc==$node) return $doc->saveXML();
}

这种方法在处理简单数组时可能有效，但在面对以下复杂场景时会遇到困难：

1. XML属性处理： SOAP消息通常需要为元素添加xsi:type等属性来指定数据类型，上述函数难以直接支持。
2. 命名空间管理： SOAP XML中包含多个命名空间（如SOAP-ENV、xsd、xsi、自定义命名空间），手动管理这些命名空间及其前缀会使代码变得复杂且容易出错。
3. 重复元素处理： 当数组中包含多个同名但不同内容的子项（如items下的多个item）时，简单的递归逻辑难以生成正确的重复元素结构。
4. 根节点与复杂类型映射： SOAP消息的根节点通常是SOAP-ENV:Envelope，其内部结构与PHP数组的直接映射存在差异，特别是对于complexType的定义，需要更精细的控制。

解决方案：利用 spatie/array-to-xml 库

为了更优雅地解决这些问题，我们可以借助成熟的第三方库。spatie/array-to-xml 是一个功能强大且灵活的PHP库，它允许开发者通过定义一个特定的PHP数组结构，来精确地控制生成的XML元素、属性、命名空间和文本内容。

立即学习“PHP免费学习笔记（深入）”；

1. 库的安装

首先，通过Composer安装 spatie/array-to-xml 库：

composer require spatie/array-to-xml

2. 核心概念：数组到XML的映射规则

spatie/array-to-xml 库通过以下特殊键来处理XML的复杂性：

• _attributes: 用于为当前元素定义XML属性。它应该是一个关联数组，键是属性名，值是属性值。
• _value: 用于为当前元素定义文本内容。
• __custom:tag_name:index: 用于创建重复的元素。tag_name是元素的名称，index是一个唯一标识符（通常是数字），以区分同名元素。

3. 构建符合SOAP规范的PHP数组

根据目标SOAP XML结构，我们需要精心构造PHP数组。以下是一个示例，展示了如何将原始PHP数组转换为符合SOAP XML要求的结构：

Flowith

一款GPT4驱动的节点式 AI 创作工具

下载

原始PHP数组示例：

$originalData = [
  "name" => "John Doe",
  "date" => "2021-11-30 00:00:00.000",
  "job" => "developer",
  "where_from" => "france",
  "address" => [
    "country" => "france",
    "city" => "paris",
    "vat_number" => "123456"
  ],
  "items" => [
    [
      "cook" => "spoon",
      "clean" => "vacuum"
    ]
  ]
];

目标SOAP XML结构片段：

   
      John
      Doe
      ...
      

         france
         paris
         12345
      
      
         
            spoon
            vacuum
         
         
      
   

请注意，原始数组中的name和date在SOAP XML中可能被拆分为name和surname，vat_number变为post_code，items的结构也发生了变化。这强调了在序列化前，需要根据XML Schema对PHP数组进行适当的结构转换。

构造后的PHP数组（用于 spatie/array-to-xml）：

use Spatie\ArrayToXml\ArrayToXml;

$dataForXml = [
    'SOAP-ENV:Body' => [
        'ns1:Person' => [
            // 'info' 这里的键名是根据SOAP XML结构映射的，它会成为一个子元素
            'data' => [ // 对应 
                "name" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "John Doe"],
                // 假设原始数据中的name被拆分或映射为name和surname
                "surname" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "Doe"],
                "job" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "developer"],
                "from" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "france"],
                "address" => [ // 对应 

                    "country" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "france"],
                    "city" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "paris"],
                    "post_code" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "123456"], // 注意这里从vat_number变为post_code
                    '_attributes' => ['xsi:type' => 'tns:getAddress'] // address元素的属性
                ],
                "items" => [ // 对应 
                    // 使用 '__custom:item:1' 来表示一个名为 'item' 的重复元素
                    // 这里的 '1' 是一个索引，确保每个 item 元素都是独立的
                    '__custom:item:1' => [
                        "name" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "spoon"],
                        "material" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "vacuum"],
                        '_attributes' => ['xsi:type' => 'xsd:string'] // item元素的属性，根据XML Schema可能需要
                    ],
                    // 如果有多个 item，可以继续添加 '__custom:item:2' 等
                    '_attributes' => ['xsi:type' => 'tns:getItems'] // items元素的属性
                ],
                '_attributes' => ['xsi:type' => 'tns:getPersonInfo'] // data元素的属性
            ],
            '_attributes' => ['xmlns:ns1' => 'https://ex.pt/webservices'] // ns1:Person元素的属性，定义命名空间
        ],
    ]
];

4. 执行序列化

使用 ArrayToXml::convert 方法将构造好的数组转换为XML字符串。

use Spatie\ArrayToXml\ArrayToXml;

// ... (前面的 $dataForXml 定义)

$response = ArrayToXml::convert($dataForXml, [
    'rootElementName' => 'SOAP-ENV:Envelope', // 定义根元素
    '_attributes' => [ // 为根元素定义属性，包括SOAP和自定义命名空间
        'SOAP-ENV:encodingStyle' => 'http://schemas.xmlsoap.org/soap/encoding/',
        '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/',
        'xmlns:tns' => 'http://ex.pt/soap/WebServices'
    ],
], true, 'UTF-8'); // 第三个参数为true表示自动格式化输出，第四个参数是编码

echo $response;

这段代码将生成一个符合SOAP规范的XML字符串，其中包含了所有必要的元素、属性和命名空间。

注意事项

1. XML Schema理解： 在进行序列化之前，务必彻底理解目标SOAP服务的WSDL和XML Schema定义。这包括元素名称、数据类型（xsi:type）、命名空间前缀、以及复杂类型（complexType）的结构，特别是数组类型（SOAP-ENC:Array）的定义方式。
2. 数据映射： 原始PHP数组与目标XML结构之间可能存在差异。例如，原始数组中的一个字段可能在XML中被拆分，或者需要重命名。在构建$dataForXml数组时，需要手动完成这种映射和转换。
3. 重复元素： 对于SOAP XML中需要重复出现的元素（如items下的多个item），spatie/array-to-xml库的__custom:tag_name:index语法非常有用。确保每个重复元素的index是唯一的。
4. 命名空间管理： 正确定义根元素以及子元素的命名空间至关重要。xmlns:前缀的定义应在适当的层级进行，通常在根元素或包含特定命名空间的父元素上。
5. 错误处理与调试： 如果生成的XML不符合预期，可以逐步检查$dataForXml数组的结构，确保它与目标XML的映射关系正确无误。同时，利用SOAPUI等工具验证生成的XML，查看具体的错误信息，有助于快速定位问题。

总结

将PHP多维数组序列化为复杂的SOAP XML格式是一项需要精确控制的任务。虽然自定义DOM方法在某些简单场景下可行，但在处理属性、命名空间和重复元素等复杂性时，往往力不从心。通过采用 spatie/array-to-xml 这样的专业库，开发者可以以更声明式的方式，通过构建一个结构化的PHP数组，高效且准确地生成符合SOAP协议要求的XML数据，从而简化与Web服务的集成工作，提高开发效率和代码的可维护性。关键在于深入理解目标XML Schema，并精确地将PHP数据结构映射到库所要求的特殊数组格式。