Learn X in Y minutes 系列:XML 数据存储与传输指南——从语法基础到 DTD 校验实战
Learn X in Y minutes 系列:XML 数据存储与传输指南——从语法基础到 DTD 校验实战
XML(Extensible Markup Language,可扩展标记语言)是一种专门为存储和传输数据而设计的标记语言,本指南源自 learnxinyminutes-docs 仓库中的 pt-br/xml.md(葡萄牙语版),并对照仓库根目录的 xml.md(英文原版)进行扩充。与 HTML 不同,XML 不规定数据如何显示或格式化,只负责承载数据,因此它常被用作跨系统、跨语言的数据交换格式。读完本文,你将掌握 XML 的完整语法规则、元素与属性的区别、树形文档结构,以及如何通过 DTD(文档类型定义)在应用逻辑之外校验 XML 数据的合法性。
XML 的本质:存储与传输数据的载体
XML 是一种标记语言(markup language),其设计目标非常聚焦:存储数据、传输数据。这一点在 pt-br/xml.md 开头被明确强调——XML 不关心数据的"长相",它既可以被人类阅读,也可以被机器解析(英文原版 xml.md 补充了这一点:XML 应当是 both human readable and machine readable)。
与 HTML 的关键区别在于职责边界:
- HTML:负责规定数据在浏览器中如何显示、如何排版;
- XML:不携带任何显示或格式化信息,只负责把数据原样携带走。
基于这个特性,XML 通常用于配置文件、Web Service 报文、异构系统间数据交换等场景,这也是本仓库将其作为独立技术文档收录的原因——它是学习后续众多语言与数据格式的基础铺垫。
XML 语法基础
注释
XML 注释与 HTML 一致,用 <!-- ... --> 包裹:
<!-- Comentários em XML são feitos desta forma --> <!-- 这是 XML 注释 -->
<!-- 注释可以
跨多行 -->
声明(Prolog)
一个典型的 XML 文件以声明开头,声明是可选的元数据信息:
<?xml version="1.0" encoding="UTF-8"?>
version 指明 XML 版本,encoding 指明字符编码(通常为 UTF-8)。英文原版 xml.md 将其称为 "XML prolog"(序言),并强调它"可选但推荐"——声明能明确告知解析器版本与编码,避免中文等多字节字符被错误解析。
树形结构与节点
XML 采用**树形结构(tree structure)**组织数据。以葡萄牙语版给出的"书店"(livraria)示例为骨架:
<?xml version="1.0" encoding="UTF-8"?>
<livraria>
<livro category="COZINHA">
<titulo lang="en">Everyday Italian</titulo>
<autor>Giada De Laurentiis</autor>
<year>2005</year>
<preco>30.00</preco>
</livro>
<livro category="CRIANÇAS">
<titulo lang="en">Harry Potter</titulo>
<autor>J K. Rowling</autor>
<year>2005</year>
<preco>29.99</preco>
</livro>
<livro category="WEB">
<titulo lang="en">Learning XML</titulo>
<autor>Erik T. Ray</autor>
<year>2003</year>
<preco>39.95</preco>
</livro>
</livraria>
在这个例子中:
- 根节点(root node)是
livraria,它是整棵树的祖先; - 根节点下有三个子节点,都是
livro(书); - 每个
livro节点下还有更小的子节点(titulo、autor、year、preco),以此层层嵌套; - 节点通过开标签(
<livro>)与闭标签(</livro>)创建,位于开闭标签之间的节点就是其子节点。
英文原版 xml.md 进一步给出了标准的树术语:每个元素称为一个节点(node),向上一层是父节点(parent),向下一层是子节点(children),拥有同一父节点的元素互为兄弟节点(siblings)。
XML 携带的两种数据类型
这是本指南的核心概念之一。XML 文档内包含两类数据(pt-br/xml.md 明确区分了二者):
- 属性(Atributos / Attributes):节点的元数据。解析器通常借助属性信息来正确组织数据。其特征是出现在开标签内部的括号中(即
name="value"形式); - 元素(Elementos / Elements):纯数据本身。这是解析器从 XML 文件中真正取回的内容,位于开闭标签之间,不带括号。
下面是一个带两个属性的元素示例:
<!-- Abaixo, um elemento com dois atributos -->
<arquivo type="gif" id="4293">computer.gif</arquivo>
type="gif" 和 id="4293" 是属性(描述性元数据),computer.gif 是元素内容(纯数据)。
英文原版 xml.md 还补充了元素与属性的更多细节,在此一并继承:
- 空元素与非空元素:空元素写作
<element1 attribute="value" />(不携带任何内容,纯粹是标记);非空元素写作<element2 attribute="value">Content</element2>,由开标签、内容、闭标签三部分组成; - 元素命名规则:元素名只能包含字母和数字;
- 大小写敏感:
<element />与<eLEMENT />是两个不同的元素; - 属性约束:属性是键值对,同一元素中一个属性只能出现一次,且只能持有单一值;常见的变通做法是使用空格分隔的列表(如
many="space-separated list"); - 空白保留:XML 保留空白字符,
<child> Text </child>与<child>Text</child>并不等价——这与后续解析时的文本内容提取直接相关。
格式良好的文档 vs 有效文档
这是本指南的技术枢纽,也是 pt-br/xml.md 后半部分的核心。需要区分两个层次:
- 格式良好(bem formatado / well-formed):文档在语法上正确。由于 XML 解析器被设计得非常严格,遇到格式错误的文档会直接停止解析,因此所有 XML 文档都必须遵守语法规则;
- 有效(válido / valid):在格式良好的基础上,还可以通过文档定义(如 DTD、XML Schema)向文档注入更多约束。遵循某份文档定义的 XML 文档,称为相对于该定义有效。
这套机制的价值在于:可以在应用程序逻辑之外校验 XML 数据。也就是说,数据的合法性检查可以在进入业务代码之前完成,由 DTD 这类声明式规则承担。
外部 DTD 声明
下面是一个简化版的书店文档,通过 <!DOCTYPE> 引用外部的 DTD 文件:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE note SYSTEM "livraria.dtd">
<livraria>
<livro category="COOKING">
<titulo >Everyday Italian</titulo>
<preco>30.00</preco>
</livro>
</livraria>
<!DOCTYPE note SYSTEM "livraria.dtd"> 声明了根元素并指定 DTD 文件的路径(livraria.dtd)。对应的 DTD 文件内容大致如下:
<!DOCTYPE note
[
<!ELEMENT livraria (livro+)>
<!ELEMENT livro (titulo,preco)>
<!ATTLIST livro category CDATA "Literature">
<!ELEMENT titulo (#PCDATA)>
<!ELEMENT preco (#PCDATA)>
]>
逐条解读这份 DTD 的语义(这也是原文档注释中的要点):
<!ELEMENT livraria (livro+)>:声明根节点livraria,要求包含一个或多个livro子节点(+表示至少一个);<!ELEMENT livro (titulo,preco)>:每个livro必须恰好包含一个titulo和一个preco子元素;<!ATTLIST livro category CDATA "Literature">:livro应带有一个名为category的属性;若缺失,则默认值为"Literature";<!ELEMENT titulo (#PCDATA)>、<!ELEMENT preco (#PCDATA)>:titulo与preco节点只能包含已解析字符数据(parsed character data),即只能容纳解析器可读取的文本,不能再嵌套子元素(可与 CDATA 概念对比理解)。
内部 DTD 声明
DTD 也可以直接内嵌在 XML 文件内部声明,效果与外部声明等价:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE note
[
<!ELEMENT livraria (livro+)>
<!ELEMENT livro (titulo,preco)>
<!ATTLIST livro category CDATA "Literature">
<!ELEMENT titulo (#PCDATA)>
<!ELEMENT preco (#PCDATA)>
]>
<livraria>
<livro category="COOKING">
<titulo >Everyday Italian</titulo>
<preco>30.00</preco>
</livro>
</livraria>
区别仅在于 DTD 定义的位置:内部声明将规则直接写入当前 XML 文件,适合单文件自包含的场景;外部声明(SYSTEM "livraria.dtd")便于多文档共享同一套校验规则。二者声明与应用的语法结构完全一致,都是从 <!DOCTYPE 开始。
英文原版 xml.md 中给出的 Bookstore.dtd 文件还特别注释了 #PCDATA 与 CDATA 的区别:#PCDATA 表示"由解析器读取的文本且不得包含子元素",CDATA(character data)则是另一类字符数据,二者在约束语义上不同。
DTD 的兼容性局限与 XML Schema(XSD)
pt-br/xml.md 在结尾部分明确指出 DTD 的历史地位与局限(与英文原版 xml.md 的 "DTD Compatibility and XML Schema Definitions" 章节一致):
- DTD 支持非常普及:因为它是相当古老的技术,几乎所有解析器都兼容;
- 但 DTD 不支持现代 XML 特性,例如命名空间(namespaces);
- XML Schema Definition(XSD) 正是为取代 DTD、定义 XML 文档文法而设计的后继方案。当文档需要命名空间、更强的数据类型约束时,应优先考虑 XSD。
因此在技术选型上可以遵循这样的思路:简单的数据约束、追求最大兼容性时用 DTD;涉及命名空间、复杂类型建模时转向 XSD。
如何在本仓库中阅读与验证
作为 learnxinyminutes-docs 项目的一部分,XML 指南以"代码即文档"的形式存在,共有多个语言版本,核心内容相互印证:
- 英文原版:xml.md(内容最完整,含元素/属性/嵌套/空白保留等更多语法细节);
- 葡萄牙语版:pt-br/xml.md(本文主体);
- 其他语言版本:es/xml.md、ru/xml.md、ko/xml.md、id/xml.md、vi/xml.md 等。
每个版本都遵循仓库统一的 frontmatter 规范(contributors、translators 字段),该规范由 lint/frontmatter.py 校验,其允许的键包括 name、category、filename、contributors、translators 等(见 CONTRIBUTING.md 中的 "Header configuration" 一节)。这从侧面印证了:文档结构本身也经过了严格的机器校验——正如 XML 文档要接受解析器与 DTD 的双重检查一样。
关于实践验证,你可以将本文中的 XML 示例保存为 .xml 文件,使用操作系统自带的 XML 解析工具检查其格式良好性(well-formed),再配合外部 DTD 文件验证其有效性——这正是"在应用逻辑之外校验数据"理念的直接落地。
小结
围绕 pt-br/xml.md 的脉络,本文完整覆盖了:XML 作为数据载体与 HTML 的职责差异、注释与声明语法、树形节点结构、属性(元数据)与元素(纯数据) 的二分法、完整书店文档示例、格式良好(语法正确)与有效(满足 DTD/XSD 约束) 的两级校验体系、外部与内部 DTD 的声明方式,以及 DTD 的命名空间局限与 XSD 的演进方向。掌握这些内容后,你既能读懂任何规范的 XML 数据文件,也能为自有数据设计可校验的 DTD 规则,将数据合法性检查前移到应用逻辑之外——这正是 XML 历经多年仍是数据交换领域基石的原因。