HTTP 与 Web 标准 / 系统课时
检查整份 XML 是否良构
检查整份 XML 是否良构
一份订单 XML 即使字段设计正确,也可能因为标签未闭合、属性引号缺失、实体未转义或命名空间前缀未声明而无法解析。本节建立一套从文档结构到编码声明的检查顺序,并用解析器验证修复后的完整 XML。
学习目标
- 按固定顺序检查根元素、标签、属性、实体和命名空间
- 识别几类会直接导致 XML 解析失败的基础语法错误
- 使用解析器验证修复后的 XML 是否良构
先检查会阻断解析的结构错误
良构 XML 必须只有一个根元素,开始标签与结束标签必须正确嵌套,属性值必须使用引号包围。下面的片段示例故意包含多个问题,不能作为有效 XML 解析。
<order id="O-1001">
<customer>Alice</customer>
<total currency=CNY>199.00</total>
<payment>
<status>paid</payment>
</order>
<log>created</log>其中 currency=CNY 缺少属性引号,status 与 payment 的标签发生交叉闭合,而且 order 后又出现第二个顶层元素 log。任意一项都足以让文档失去良构性。
检查时可以按“一个根元素 → 标签正确闭合并嵌套 → 属性语法正确”的顺序处理。这样能够先消除最基础的结构错误,避免后面的检查被大量级联错误干扰。
检查实体与命名空间
文本和属性值中的 < 与 & 具有特殊语法含义,作为普通字符出现时必须转义。例如公司名称 A&B 应写成 A&B。字符 > 通常可以直接出现在文本中,但在特定组合中也应谨慎处理。
命名空间前缀也必须先声明再使用。下面的 pay:payment 如果文档中没有对应的 xmlns:pay 声明,解析器会报告未绑定前缀。
<order>
<pay:payment>paid</pay:payment>
</order>正确做法是在当前元素或其祖先元素上声明该前缀,例如 xmlns:pay="urn:example:payment:v1"。命名空间 URI 用于标识名称所属的词汇表,前缀本身只是文档内的简写。
修复并形成完整文档
下面是一份修复后的订单 XML。它只有一个根元素,标签正确闭合,属性使用引号,文本中的 & 已转义,同时声明了订单和支付命名空间。
<?xml version="1.0" encoding="UTF-8"?>
<order xmlns="urn:example:order:v1"
xmlns:pay="urn:example:payment:v1"
id="O-1001">
<customer>Alice & Bob</customer>
<total currency="CNY">199.00</total>
<pay:payment transactionId="P-9001">
<pay:status>paid</pay:status>
</pay:payment>
</order>XML 声明中的 encoding="UTF-8" 描述字节编码。实际保存文件时也应使用 UTF-8;如果声明一种编码、文件字节却采用另一种编码,解析器在读取非 ASCII 字符时可能失败。因此,编码检查既包括声明内容,也包括文件真实的保存编码。
用解析器完成最终验证
人工检查适合定位问题,但最终应让 XML 解析器实际读取文档。下面的 Python 示例直接以 UTF-8 字节解析完整文档,并在成功后输出根元素名称和订单编号。
import xml.etree.ElementTree as ET
xml_bytes = """<?xml version="1.0" encoding="UTF-8"?>
<order xmlns="urn:example:order:v1"
xmlns:pay="urn:example:payment:v1"
id="O-1001">
<customer>Alice & Bob</customer>
<total currency="CNY">199.00</total>
<pay:payment transactionId="P-9001">
<pay:status>paid</pay:status>
</pay:payment>
</order>
""".encode("utf-8")
root = ET.fromstring(xml_bytes)
local_name = root.tag.split("}", 1)[-1]
print(f"well-formed: {local_name} id={root.attrib['id']}")预期输出
well-formed: order id=O-1001如果 ET.fromstring 没有抛出 ParseError,说明文档满足解析器能够检查的良构要求。良构只表示 XML 基础语法成立,并不等于业务数据正确:例如金额是否允许为负数、订单是否必须包含支付信息,需要通过应用逻辑或 XML Schema 等额外规则继续验证。
建立固定检查顺序
实际排查整份 XML 时,建议先确认文档只有一个根元素,再检查标签闭合与嵌套关系,随后检查属性引号和特殊字符转义,然后确认所有命名空间前缀都有声明,最后核对编码并交给解析器验证。固定顺序可以减少被后续级联报错干扰,也能让修复结果具有可重复的验证标准。