本教程旨在解决php多维数组在soap请求中序列化为复杂xml时遇到的常见问题，特别是涉及嵌套结构、xml属性（如`xsi:type`）和重复元素。我们将深入探讨如何构建符合soap规范的php数组结构，并利用`spatie/array-to-xml`库高效、准确地将此数组转换为目标xml，从而避免“无法序列化结果”的错误。
引言：PHP数组到SOAP XML序列化的挑战
在PHP开发中，将复杂的多维数组转换为SOAP协议所需的XML格式是一个常见的任务。然而，当数组包含嵌套结构、需要特定的XML属性（如xsi:type、命名空间声明）以及处理同名重复元素时，原生的DOMDocument或简单的递归函数往往难以直接满足SOAP的严格要求，容易导致诸如“unable to serialize result”的错误。
传统的递归转换函数在处理以下情况时尤其容易出错：
- XML属性的映射：如何将PHP数组中的数据映射为XML元素的属性，而非子元素或文本内容。
- 复杂类型声明：SOAP XML通常需要通过xsi:type属性指定数据类型，这在PHP数组中很难直观表达。
- 同名重复元素：例如，一个items节点下有多个item节点，且每个item都有自己的子元素，传统方法可能无法正确生成。
- 命名空间管理：SOAP XML广泛使用命名空间，需要在各个元素上正确声明和引用。
解决方案：使用 spatie/array-to-xml 库
为了克服上述挑战，我们可以采用 spatie/array-to-xml 这样的专业库。该库提供了一种灵活的方式，通过约定特定的数组键来表示XML元素、属性、文本内容以及命名空间，从而简化了复杂XML的生成过程。
步骤一：安装 spatie/array-to-xml
首先，通过Composer将库安装到您的项目中：
立即学习“PHP免费学习笔记（深入）”；
composer require spatie/array-to-xml
步骤二：构建符合XML结构的PHP数组
这是最关键的一步。我们需要将原始的PHP数组转换为一个特殊结构，该结构能够清晰地指示 spatie/array-to-xml 如何构建XML。该库通过以下约定来处理：
- _attributes 键：用于定义当前元素的XML属性。其值应为关联数组，键是属性名，值是属性值。
- _value 键：用于定义当前元素的文本内容。
- 命名空间前缀：直接在元素名中使用冒号（:）分隔前缀和本地名，库会自动处理命名空间声明。
- __custom:KEY:INDEX 约定：当一个父元素下有多个同名子元素时（例如，一个items下有多个item），可以使用此约定。KEY是子元素的名称，INDEX是唯一标识符。
让我们根据目标SOAP XML结构来构建PHP数组：
<?php
use Spatie\ArrayToXml\ArrayToXml;
$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" // 对应post_code
],
"items" => [
[
"cook" => "spoon", // 对应name
"clean" => "vacuum" // 对应material
]
]
];
$dataForXml = [
'SOAP-ENV:Body' => [
'ns1:Person' => [
'data' => [ // 注意：这里将原始数据包装在 'data' 节点下，符合预期XML
"name" => [
'_attributes' => ['xsi:type' => 'xsd:string'],
'_value' => "John" // 假设原始数据需要拆分或调整
],
"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" => [ // 对应原始数组的vat_number
'_attributes' => ['xsi:type' => 'xsd:string'],
'_value' => "123456"
],
'_attributes' => ['xsi:type' => 'tns:getAddress'] // address节点的属性
],
"items" => [
// 处理多个item元素，使用 __custom:KEY:INDEX 约定
'__custom:item:0' => [ // 第一个item
"name" => [
'_attributes' => ['xsi:type' => 'xsd:string'],
'_value' => "spoon" // 对应原始数组的cook
],
"material" => [
'_attributes' => ['xsi:type' => 'xsd:string'],
'_value' => "vacuum" // 对应原始数组的clean
],
],
// 如果有更多item，可以继续添加 '__custom:item:1', '__custom:item:2' 等
'_attributes' => ['xsi:type' => 'tns:getItems'] // items节点的属性
],
'_attributes' => ['xsi:type' => 'tns:getPersonInfo'] // data节点的属性
],
'_attributes' => ['xmlns:ns1' => 'https://ex.pt/webservices'] // ns1:Person节点的属性
],
]
];
// 原始数据与目标数组的映射逻辑可能需要根据实际情况进行调整，
// 例如将 $originalData['name'] 拆分为 name 和 surname，
// 或者将 $originalData['address']['vat_number'] 映射到 post_code 等。
// 上述 $dataForXml 数组直接反映了期望的XML结构。在上述数组中：
- SOAP-ENV:Body、ns1:Person 等带有命名空间前缀的键名直接映射为带有命名空间的XML元素。
- _attributes 键用于为父元素添加XML属性，例如 ns1:Person 上的 xmlns:ns1，以及 name、address、items 等元素上的 xsi:type。
- _value 键用于指定元素的文本内容。
- items 数组下的 __custom:item:0 是一种特殊的约定，用于生成多个名为 item 的子元素，而不会将它们合并或生成不正确的结构。这里的 0 只是一个唯一标识符，可以是任何字符串或数字。
步骤三：执行转换并获取XML字符串
使用 ArrayToXml::convert 方法将构建好的PHP数组转换为XML。在转换时，需要指定根元素的名称以及整个SOAP信封所需的全局属性。
// ... (接续上面的 $dataForXml 数组定义)
$responseXml = ArrayToXml::convert($dataForXml, [
'rootElementName' => 'SOAP-ENV:Envelope', // 指定XML的根元素
'_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'); // 第三个参数为是否格式化输出，第四个为编码
echo $responseXml;执行上述代码，将生成符合SOAP规范的XML字符串，其中包含了所有预期的元素、属性和嵌套结构。
注意事项与最佳实践
- 精确映射：将原始PHP数组转换为 spatie/array-to-xml 所需的结构时，务必仔细对照目标XML Schema (XSD) 和预期的XML输出。任何元素名称、属性或嵌套层级的偏差都可能导致序列化失败或生成不合规的XML。
- 命名空间管理：SOAP XML对命名空间有严格要求。确保在数组中正确使用前缀（如SOAP-ENV:、ns1:、tns:），并在根元素或相关父元素的 _attributes 中声明这些命名空间（如xmlns:SOAP-ENV）。
- 复杂类型处理：xsi:type 属性对于SOAP消息中的复杂数据类型至关重要。确保在对应元素的 _attributes 中正确设置此属性。
- 重复元素：当需要生成多个同名子元素时（如 items 下的多个 item），__custom:KEY:INDEX 约定是关键。INDEX 仅用于确保数组键的唯一性，它不会出现在最终的XML中。
- 错误处理：在实际应用中，应将XML生成过程封装在try-catch块中，以捕获可能的转换错误。
- 调试：如果生成的XML不符合预期，可以逐步检查 dataForXml 数组的结构，确保它准确反映了目标XML的层次和属性。
总结
通过 spatie/array-to-xml 库，我们可以有效地将复杂的PHP多维数组序列化为符合SOAP规范的XML。关键在于理解该库的数组结构约定，特别是如何表示XML元素、属性、文本内容以及处理命名空间和重复元素。采用这种方法，可以显著提高处理SOAP XML序列化任务的效率和准确性，避免手动DOM操作的复杂性和潜在错误。
