PHP中的XML拉模式详细解析
2008-10-04
来源:中国IT实验室
研究与 PHP 5 捆绑在一起的 XMLReader 库，它使 PHP 页面能够以高效的流模式来处理 XML 文档。
PHP 5 引入了新的类 XMLReader，用于读取可扩展标记语言（Extensible Markup Language，XML）。与 SimpleXML 或文档对象模型（Document Object Model，DOM）不同，XMLReader 以流模式进行操作。即它从头到尾读取文档。在文档后面的内容编译完成之前，可以先处理已编译好的文档前面的内容，从而实现非常快速、非常高效、非常节省地使用内存。需要处理的文档越大，这个特点就越发重要。
libxml
这里所说的 XMLReader API 位于 Gnome Project 中用于 C 和 C++ 的 libxml 库之上。实际上 XMLReader 只是在 libxml 的 XmlTextReader API 之上的很薄的 PHP 层。XmlTextReader 本身是模仿 .NET 的 XmlTextReader 类和 XmlReader 类，尽管并不具有与这些类相似的代码。
与 Simple API for XML （SAX） 不同，XMLReader 是推解析器，而不是拉解析器。这意味着程序是可以控制的。您将告诉解析器何时获取下一个文档片段，而不是在解析器看到文档后告诉您所看到的内容。您将请求内容，而不是对内容进行反应。从另一个角度来考虑这个问题：XMLReader 是 Iterator 设计模式的实现，而不是 Observer 设计模式的实现。
示例问题
先从简单例子开始讨论。假定正在编写 PHP 脚本，用来接收 XML-RPC 请求并生成响应。更具体一些，假定请求如清单 1 所示。文档的根元素是 methodCall，它包含 methodName 元素和 params 元素。方法的名称是 sqrt.params 元素包含一个 param 元素，param 元素包含 double，double 的平方根是希望得到的值。没有使用名称空间。
清单 1. XML-RPC 请求
以下是引用片段：<?xml version="1.0"?> <methodCall> <methodName>sqrt</methodName> <params> <param> <value><double>36.0</double></value> </param> </params> </methodCall>
下面是 PHP 脚本需要完成的工作：
1、检查方法名，如果不是 sqrt（它是该脚本懂得如何处理的惟一方法），则生成错误响应。
2、找到参数，如果参数不存在或参数类型错误，则生成错误响应。
3、另外，计算平方根。
4、在表单中返回结果，如清单 2 所示。
清单 2. XML-RPC 响应
以下是引用片段：<?xml version="1.0"?> <methodResponse> <params> <param> <value><double>6.0</double></value> </param> </params> </methodResponse>
下面我们逐步展开说明。
初始化解析器并载入文档
第一步是创建新的解析器对象。创建操作很简单：
以下是引用片段：$reader = new XMLReader();
接着，需要为它提供一些用于解析的数据。对于 XML-RPC，这是超文本传输协议（Hypertext Transfer Protocol，HTTP）请求的原始主体。然后可以将该字符串传递到读取器的 XML（） 函数：
填充原始发送数据
以下是引用片段： $request = $HTTP_RAW_POST_DATA; $reader->XML($request);
如果发现 $HTTP_RAW_POST_DATA 是空的，则将以下代码行添加到 php.ini 文件：
以下是引用片段： always_populate_raw_post_data = On
可以解析任何字符串，无论它是从何处获取的。例如，可以是程序中的一串文字或从本地文件读取。还可以使用 open（） 函数从外部 URL 载入数据。例如，下面的语句准备解析其中一个 Atom 提要：
以下是引用片段： $reader->XML('http://www.cafeaulait.org/today.atom');
无论是从何处获取原始数据，现在已建立了阅读器并为解析做好准备。
读取文档
read（） 函数使解析器前进到下一个标记。最简单的方法是在 while 循环中遍历整个文档：
以下是引用片段： while ($reader->read()) { // processing code goes here... }
完成遍历后，关闭解析器以释放它所持有的任何资源，并且重置解析器以便用于下一个文档：
以下是引用片段： $reader->close();
在循环内部，将解析器放置在特殊节点上：元素的起点、元素的终点、文本节点、注释等等。通过检查以下属性，可以发现解析器正在查看的内容：
localName 是本地的、未带前缀的节点名。
name 是可能的节点前缀名。对于像注释这种没有名称的节点，包括 #comment、#text、#document 等等，与 DOM 中的一样。
namespaceURI 是节点名称空间的统一资源标识符（Uniform Resource Identifier，URI）。
nodeType 是代表节点类型的整数 —— 例如，2 代表属性节点，7 代表处理指令。
prefix 是节点的名称空间前缀。
value 是节点的下一个文本内容。
如果节点有文本值，hasValue 值为 true；否则，值为 false.
当然，并非所有节点类型都具有所有这些属性。例如，文本节点、CDATA 部件、注释、处理指令、属性、空格、文档类型和 XML 声明具有值。而其它节点类型（最重要的是元素和文档）则没有值。通常，程序将使用 nodeType 属性来断定它所查找的内容，然后做出适当的响应。清单 3 展示了简单的 while 循环，该循环使用这些函数来打印它所查看的内容。清单 4 展示了将清单 1 输入程序后的输出。
清单 3. 解析器所查看的内容
以下是引用片段： while ($reader->read()) { echo $reader->name; if ($reader->hasValue) { echo ": " . $reader->value; } echo "n"; }
清单 4. 清单 3 的输出
以下是引用片段： methodCall #text: methodName #text: sqrt methodName #text: params #text: param #text: value double #text: 10 double value #text: param #text: params #text: methodCall
大多数程序并非这么简单。它们接受特定格式的输入，并以某种方式来处理输入。在 XML-RPC 例子中，仅需要读取输入中的一个元素：double 元素，该元素应该只有一个。为此，查找名称为 double 的元素的起点：
以下是引用片段： if ($reader->name == "double" && $reader->nodeType == XMLReader::ELEMENT) { // ... }
该元素可能有单个文本子节点，可以通过将解析器前进到下一个节点来进行读取，如下所示：
以下是引用片段： if ($reader->name == "double" && $reader->nodeType == XMLReader::ELEMENT) { $reader->read(); respond($reader->value); }
在这里 respond（） 函数构建了 XML-RPC 响应并将它发送到客户机。但是，在展示上述操作前，还有一些事情需要处理。不能绝对保证请求文档中的 double 元素仅包含一个文本节点。可能包含多个文本节点，以及注释和处理指令。例如，可能看起来像以下代码：
以下是引用片段：<value><double> <!--value follows-->6.<!--fractional part next-->0 </double></value>
嵌套元素
该模式存在一个潜在的缺陷。嵌套的 double 元素（例如 61.2）将违背该算法。然而它将成为无效的 XML-RPC；并且不久您将看到如何使用 RELAX NG 验证来拒绝所有此类文档。在诸如可扩展超文本标记语言（Extensible Hypertext Markup Language，XHTML）之类的文档类型中，允许相同元素互相包含（例如 table 元素包含在另一个 table 元素中），因此您还需要知道元素的深度，从而确保结束标记与开始标记之间进行正确匹配。
一个健壮的解决方案需要获得 double 元素的所有文本子节点，将它们连接起来，并且仅将结果转换为 double.必须小心避免任何注释或可能出现的其它非文本节点。这有一点复杂，但并不是十分复杂，如清单 5 所示。
清单 5. 累积来自一个元素的所有文本内容
以下是引用片段： while ($reader->read()) { if ($reader->nodeType == XMLReader:
EXT || $reader->nodeType == XMLReader::CDATA || $reader->nodeType == XMLReader::WHITESPACE || $reader->nodeType == XMLReader::SIGNIFICANT_WHITESPACE) { $input .= $reader->value; } else if ($reader->nodeType == XMLReader::END_ELEMENT && $reader->name == "double") { break; } }
您可以暂时忽略文档中的其它任何内容。（稍后将添加更多的错误处理。）
