21. 处理 XML 文档
到目前为止我们编写的 Web 服务交换的都是 JSON 数据。XML(可扩展标记语言)长期以来一直是使用最广泛的交换格式,至今仍很常见:SOAP Web 服务、RSS 订阅源、配置文件、办公文档([.odt] 或 [.docx] 文件是 XML 文件的压缩包)。PHP 提供了两种 API 来处理它:
- [SimpleXML]:一种非常简单的 API,文档元素变成对象的属性;
- [DOM] (文档对象模型):W3C 的标准 API,功能更全面,也允许修改文档。PHP 8.4 在 [Dom] 命名空间中引入了符合当前 Web 标准的新版本。
本章的脚本位于 [scripts-console/xml] 文件夹中:
| scripts-console/xml
├── data.xml
├── dom-01.php
└── simplexml-01.php
|
21.1. 所考察的文档
我们考察如下 XML 文件 [data.xml]:
| <?xml version="1.0" encoding="UTF-8"?>
<tribe>
<teacher>
<person gender="M">
<lastName>dupont</lastName>
<firstName>jean</firstName>
<age>28</age>
this is a comment
</person>
<section>27</section>
</teacher>
<student>
<person gender="F">
<lastName>martin</lastName>
<firstName>charline</firstName>
<age>22</age>
</person>
<course>dess IAIE</course>
</student>
</tribe>
|
XML 文档是一棵元素树:
- 第 1 行:序言,指明 XML 的版本和文档的字符编码;
- 第 3–21 行:根元素 [tribe]。XML 文档有且仅有一个根;
- 第 4–12 行:[teacher] 元素,是 [tribe] 的子元素。它有两个子元素,[person] 和 [section];
- 第 5 行:元素 [person] 有一个属性 [gender] ,其值为 [M];
- 第 9 行:一个元素既可以包含其他元素,也可以包含文本;
- 第 13–20 行:元素 [student],其结构与 [teacher] 相同。
21.2. 使用 SimpleXML 处理
我们使用下面的 [simplexml-01.php] 脚本来分析这个文档:
| <?php
declare(strict_types=1);
// 要使用的 XML 文件
const FILE_NAME = "data.xml";
// 加载 XML 文档
$xml = simplexml_load_file(FILE_NAME);
if ($xml === false) {
print "The file [" . FILE_NAME . "] could not be used\n";
exit(1);
}
// 显示文档
print_r($xml);
// 教学人员的 [gender] 属性
print_r($xml->teacher->person['gender']);
// 元素和属性的值,转换为字符串
$lastName = (string) $xml->teacher->person->lastName;
print "lastName=$lastName\n";
$gender = (string) $xml->teacher->person['gender'];
print "gender=$gender\n";
$course = (string) $xml->student->course;
print "course=$course\n";
// 元素是否存在
print "isset(lastName)=" . var_export(isset($xml->teacher->person->lastName), true) . "\n";
print "isset(xx)=" . var_export(isset($xml->teacher->person->xx), true) . "\n";
// 转换为整数
$age = (int) $xml->student->person->age;
print "age of the student=$age\n";
// 用 XPath 遍历文档中所有的 <person> 元素
foreach ($xml->xpath('//person') as $person) {
print "person: {$person->firstName} {$person->lastName} ({$person['gender']})\n";
}
|
说明
- 第 6 行:XML 文件名是一个常量。脚本在它自己的文件夹中执行,即 [data.xml] 所在的文件夹;
- 第 9 行:[simplexml_load_file] 函数加载文档并返回一个 [SimpleXMLElement] 类型的对象,它代表根元素 [tribe]。出错时(文件缺失、XML 格式错误),它返回 [false],我们在第 10 行对此进行测试;
- 第 15 行:显示文档。[print_r] 展示了 [SimpleXML] 如何看待这棵 XML 树;
- 第 17 行:子元素作为属性来访问([$xml->teacher->person]),属性则作为数组键来访问([['gender']])。请注意,根元素 [tribe] 并未出现在代码中:[$xml] 本身就是该元素;
- 第 19 行:[$xml->teacher->person->lastName] 不是字符串,而是一个 [SimpleXMLElement] 对象。通过 [(string)] 转换可得到其文本。使用 [declare(strict_types=1)] 时,最好在把该值传给期望字符串的函数之前显式执行此转换;
- 第 21 行:[gender] 属性的值;
- 第 26–27 行:[isset] 判断元素是否存在。PHP 7 脚本使用 [print] 显示布尔结果,它对 [1] 返回 [true] ,对 [false] 返回空字符串。我们改用 [var_export],它显示 [true] 或 [false];
- 第 29 行:转换 [(int)] 返回元素文本的整数值;
- 第 32 行:方法 [xpath] 计算一个 XPath 表达式。表达式 [//person] 指代文档中所有 [person] 元素,不论其层级如何。它返回一个 [SimpleXMLElement] 数组。
控制台输出
| > php simplexml-01.php
SimpleXMLElement Object
(
[teacher] => SimpleXMLElement Object
(
[person] => SimpleXMLElement Object
(
[@attributes] => Array
(
[gender] => M
)
[lastName] => dupont
[firstName] => jean
[age] => 28
)
[section] => 27
)
[student] => SimpleXMLElement Object
(
[person] => SimpleXMLElement Object
(
[@attributes] => Array
(
[gender] => F
)
[lastName] => martin
[firstName] => charline
[age] => 22
)
[course] => dess IAIE
)
)
SimpleXMLElement Object
(
[0] => M
)
lastName=dupont
gender=M
course=dess IAIE
isset(lastName)=true
isset(xx)=false
age of the student=22
person: jean dupont (M)
person: charline martin (F)
|
- 第 2–38 行:以 [SimpleXMLElement] 对象形式呈现的 XML 文档。请注意,文本 [this is a comment] 没有出现:[print_r] 只显示元素和属性;
- 第 39–42 行:属性也是一个 [SimpleXMLElement] 对象;
- 第 43–48 行:从文档中读取的值;
- 第 49–50 行:通过 XPath 遍历得到的两个人。
21.3. 使用 PHP 8.4 的新 DOM API 处理
从 PHP 8.4 开始,[Dom] 命名空间提供了新的 DOM API:用于 XML 文档的 [Dom\XMLDocument] 类和用于 HTML5 文档的 [Dom\HTMLDocument] 类。它是 旧的 [DOMDocument] 类(仍然可用)的更好替代:它符合当前的 DOM 标准,并提供 JavaScript 开发者所熟悉的 [querySelector] 和 [querySelectorAll] 方法。这些方法允许使用 CSS 选择器搜索元素。
[dom-01.php] 脚本使用同一个文档:
| <?php
declare(strict_types=1);
// 使用 PHP 8.4 的新 DOM API 处理同一个文档
use Dom\XMLDocument;
// 要使用的 XML 文件
const FILE_NAME = "data.xml";
try {
// 加载 XML 文档
$document = XMLDocument::createFromFile(FILE_NAME);
} catch (Throwable $ex) {
print "The file [" . FILE_NAME . "] could not be used: {$ex->getMessage()}\n";
exit(1);
}
// 根元素
print "root=" . $document->documentElement->tagName . "\n";
// 第 1 位教学人员,通过 CSS 选择器找到
$person = $document->querySelector('teacher > person');
print "lastName=" . $person->querySelector('lastName')->textContent . "\n";
print "gender=" . $person->getAttribute('gender') . "\n";
print "course=" . $document->querySelector('student > course')->textContent . "\n";
// 缺失的元素:querySelector 返回 null
print "xx exists=" . var_export($person->querySelector('xx') !== null, true) . "\n";
// 文档中的所有人员
foreach ($document->querySelectorAll('person') as $person) {
// nullsafe 运算符 ?-> 可以防止元素缺失
$firstName = $person->querySelector('firstName')?->textContent ?? '?';
$lastName = $person->querySelector('lastName')?->textContent ?? '?';
print "person: $firstName $lastName ({$person->getAttribute('gender')})\n";
}
// 修改文档:我们更改教师的 <section> 元素的内容
$section = $document->querySelector('teacher > section');
$section->textContent = "26";
// 修改后的文档,以 XML 文本表示
print $document->saveXml($document->querySelector('teacher')) . "\n";
|
说明
- 第 7 行:[Dom] 命名空间中的 [XMLDocument] 类;
- 第 14 行:静态方法 [createFromFile] 加载文档。与 [simplexml_load_file] 不同,出错时它会抛出异常;
- 第 20 行:属性 [documentElement] 是根元素;[tagName] 是它的名称;
- 第 22 行:CSS 选择器 [teacher > person] 指代作为 [teacher] 元素直接子元素的 [person] 元素。[querySelector] 返回第一个匹配的元素,如果没有匹配的元素则返回 [null] ;
- 第 23 行:[textContent] 属性是元素中包含的文本;
- 第 24 行:属性的值;
- 第 27 行:缺失的元素返回 [null];
- 第 29 行:文档中所有的 [person] 元素;
- 第 31 行:如果元素 [firstName] 缺失,[querySelector('firstName')] 将得到 [null]。此时空安全运算符 [?->] (PHP 8.0)返回 [null] 而不是引发错误,运算符 [??] 再把这个 [null] 替换为 ['?'];
- 第 37 行:DOM API 还允许修改文档:这里修改的是 [section] 元素的文本;
- 第 39 行:[saveXml] 返回文档的 XML 文本;如果把某个元素作为参数传入,则返回该元素的 XML 文本。
控制台输出
| > php dom-01.php
root=tribe
lastName=dupont
gender=M
course=dess IAIE
xx exists=false
person: jean dupont (M)
person: charline martin (F)
<teacher>
<person gender="M">
<lastName>dupont</lastName>
<firstName>jean</firstName>
<age>28</age>
this is a comment
</person>
<section>26</section>
</teacher>
|
这两个示例并未展示 [SimpleXML] 和 [DOM] 的全部功能,但足以让我们编写应用练习的新版本。PHP 文档对它们有详细说明:SimpleXML 和 DOM。