PHP多维数组到SOAP XML的序列化实践：处理复杂结构与属性

本文探讨了将复杂php多维数组转换为符合soap协议要求的xml结构，特别是涉及深层嵌套、自定义属性（如`xsi:type`）和重复元素时的挑战。文章指出传统domdocument递归方法在此类场景下的局限性，并详细介绍了如何利用`spatie/array-to-xml`库，通过构建特定结构的php数组，高效、准确地生成符合soap规范的xml输出，从而解决序列化难题。

在现代Web服务交互中，将后端数据结构（如PHP数组）序列化为XML格式是常见的需求，尤其是在与基于SOAP协议的Web服务进行通信时。SOAP XML通常要求精确的元素名称、命名空间、数据类型属性（如xsi:type）以及复杂的嵌套结构，这使得简单的递归转换方法往往力不从心。

理解SOAP XML的复杂性

SOAP协议通过XML来封装消息，其结构通常由SOAP-ENV:Envelope、SOAP-ENV:Header（可选）和SOAP-ENV:Body组成。在SOAP-ENV:Body内部，会包含具体的业务数据。一个典型的SOAP XML响应可能如下所示，其中包含多层嵌套、自定义命名空间以及关键的xsi:type属性来指明数据类型：

   
      
         
            John
            Doe
            developer
            france
            

               france
               paris
               12345
            
            
               
                  spoon
                  vacuum
               
            
         
      
   

上述XML结构展示了几个关键点：

• 命名空间前缀: SOAP-ENV、xsd、xsi、SOAP-ENC、tns、ns1等前缀的使用。
• 元素属性: 如SOAP-ENV:encodingStyle和xmlns:*等根元素属性。
• 类型定义: xsi:type="xsd:string"用于基本类型，xsi:type="tns:getAddress"用于自定义复杂类型。
• 重复元素: 下包含多个元素，每个又包含其子元素。

传统DOMDocument方法的挑战

当尝试使用PHP内置的DOMDocument类进行递归转换时，自定义一个函数来处理上述复杂性会变得非常繁琐。例如，原始问题中提供的convertToXml函数在处理多维数组时，可能无法灵活地：

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

1. 动态添加属性: 特别是为每个元素添加xsi:type这样的属性。
2. 区分元素类型: 对于像items这样的数组，既要作为父元素，又要能够包含多个同名的子元素item，并且每个item内部还有其自己的子元素，这需要复杂的逻辑来判断和构建。
3. 管理命名空间: 在递归过程中正确地处理和引用不同的XML命名空间。
4. 根元素及全局属性: 在递归深层时，难以统一管理整个XML文档的根元素属性。

这些挑战导致在处理复杂SOAP XML结构时，自定义的DOMDocument方法容易出错，且难以维护。

推荐解决方案：使用spatie/array-to-xml库

为了更高效、准确地将复杂PHP数组转换为SOAP XML，推荐使用像spatie/array-to-xml这样的专业库。该库提供了一种声明式的方式，通过构建一个特定结构的PHP数组来映射到所需的XML输出，极大地简化了开发过程。

BibiGPT-哔哔终结者

B站视频总结器-一键总结 音视频内容

下载

1. 库安装

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

composer require spatie/array-to-xml

2. 核心思想：构建特定结构的PHP数组

spatie/array-to-xml库通过识别数组中的特殊键来处理XML元素的属性、文本内容以及重复元素。

• _attributes: 用于定义当前元素的XML属性。
• _value: 用于定义当前元素的文本内容（当元素同时有属性和文本内容时）。
• __custom:elementName:index: 用于在数组中表示多个同名子元素，elementName是子元素的名称，index是唯一标识符（通常是数字）。

基于SOAP XML的预期结构，我们需要将原始PHP数组转换为spatie/array-to-xml能够理解的格式。以下是根据预期SOAP XML和库特性构建的PHP数组示例：

 "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"
        ]
    ]
];

// 构建符合 spatie/array-to-xml 要求的数组结构
$dataForXml = [
    'SOAP-ENV:Body' => [
        'ns1:Person' => [
            'data' => [ // 注意这里将info改名为data以匹配期望XML
                "name" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "John Doe"],
                "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']
                ],
                "items" => [
                    // 处理多个 item 元素，使用 __custom:elementName:index 模式
                    '__custom:item:0' => [ // 对应原始数组 items[0]
                        "name" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "spoon"], // 对应原始数组 cook
                        "material" => ['_attributes' => ['xsi:type' => 'xsd:string'], '_value' => "vacuum"], // 对应原始数组 clean
                    ],
                    // 如果有更多 item，可以继续添加 '__custom:item:1' => [...]
                    '_attributes' => ['xsi:type' => 'tns:getItems']
                ],
                '_attributes' => ['xsi:type' => 'tns:getPersonInfo']
            ],
            '_attributes' => ['xmlns:ns1' => 'https://ex.pt/webservices']
        ]
    ]
];

// 使用 ArrayToXml::convert 方法进行转换
$response = ArrayToXml::convert($dataForXml, [
    'rootElementName' => 'SOAP-ENV:Envelope',
    '_attributes' => [
        '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');

echo $response;

在上述代码中：

• 我们首先定义了一个$dataForXml数组，其结构严格遵循目标SOAP XML的层次。
• SOAP-ENV:Body作为根元素下的第一个子元素。
• ns1:Person包含其命名空间属性xmlns:ns1。
• data元素包含xsi:type="tns:getPersonInfo"属性。
• 对于name、surname、job等简单元素，它们的值被封装在_value键中，同时通过_attributes键添加xsi:type="xsd:string"。
• address和items是复杂类型，它们作为父元素，其子元素和属性也以嵌套数组的形式定义。
• 特别地，对于items下的重复item元素，我们使用了__custom:item:0这样的特殊键来指示库生成多个名为item的XML元素。

3. 执行转换

最后，调用ArrayToXml::convert()方法，传入构建好的数组、根元素配置以及全局属性，即可生成完整的SOAP XML字符串。rootElementName参数定义了最外层的XML元素，_attributes则为该根元素添加了所有必要的命名空间和编码样式属性。

注意事项与最佳实践

1. SOAP WSDL和XML Schema的理解: 在处理SOAP Web服务时，深入理解其WSDL（Web Services Description Language）文件和相关的XML Schema定义至关重要。WSDL定义了服务接口、操作以及消息格式，而XML Schema则详细描述了消息中XML元素的结构、数据类型和约束。这些是构建正确PHP数组以匹配XML结构的基础。
2. 精确映射: 确保PHP数组的结构与目标XML Schema定义完全匹配，包括元素名称、属性、命名空间以及数据类型。任何不匹配都可能导致Web服务解析失败。
3. 错误处理: 在实际应用中，应加入健壮的错误处理机制。例如，当Web服务返回SOAP Fault时，能够捕获并解析错误信息，以便进行调试和问题定位。
4. 性能考量: 对于非常大的数据集，XML序列化可能会消耗较多的内存和CPU资源。在处理大规模数据时，应评估序列化过程的性能，并考虑是否有更优化的数据传输方式。
5. 命名空间管理: spatie/array-to-xml在处理带有前缀的元素名时，会自动识别并处理命名空间。确保在PHP数组中正确使用带前缀的键名（如SOAP-ENV:Body, ns1:Person）。

总结

将复杂的PHP多维数组转换为符合SOAP协议要求的XML结构是一项常见的任务，但由于SOAP XML的严格性和复杂性，传统的手动DOMDocument递归方法往往难以胜任。通过利用spatie/array-to-xml这样的专业库，并遵循其特定的数组结构映射规则，开发者可以高效、准确地生成所需的XML输出。这种方法不仅简化了代码，提高了可维护性，也更好地适应了SOAP Web服务对XML格式的严格要求。