XML 语法速查笔记

相比起 Json，XML 是一种相对古老和复杂、但功能更加强大的数据存储/传输格式。也因为其复杂，有一些语法需要记录一下，在使用多种语言进行 XML 操作的时候备查。

---

范例

下面是一个相对比较完整的 XML 范例：

<?xml version="1.0" encoding="UTF-8"?>
<!-- 上面这一行不属于 XML 组成部分，但是是 XML 文档的一部分 -->
<readme>
   <author>Andrew</author>
   <date>
      2018-10-11
      <year>2018</year>
      <mon>10</mon>
      <mday>11</mday>
   </date>
   <note>这是一个示例性质的 XML 范例。可以看到，一些关键字符比如双引号 &quot; 是需要转义的。</note>
   <main_page id="1307425">
      <href><![CDATA[https://cloud.tencent.com/developer/column/4101]]></href>
      <name>amc</name>
   </main_page>
</readme>

以下内容主要根据上述范例进行说明。

---

概念和关键词

• XML：可扩展标记语言（EXtensible Markup Language）
• XML 文档：上述范例就是一个 XML 文档
• 元素：一个 <xxx>...</xxx> 对及其中间的部分加起来，就是一个元素
• XML 标签（Tags）：范例中的 <xxx> 和 </xxx> 文字就是一对标签
• 根元素：每个 XML 文档需要有且只有一个根元素，这个元素是所有元素的祖先元素
• 子元素（Children）、同胞元素（Siblings）：范例中 <date> 元素下的 <year>、<mon>、<mday> 元素就是子元素，这几个子元素之间互为同胞元素
• 文本内容（Text）：范例中，<author> 元素中的 Andrew 就是文本内容；同理 <date> 元素下的 2018-10-11 也是文本内容
• 属性（Attributes）：范例中 main_page 元素中有一段文字 id="1307425"，这就是元素 main_page 的属性，其属性名为 "id"，属性值 为 “1307425”。

---

语法规则速查

• 所有 XML 元素均需要有关闭标签，比如 <name> 均必须跟着一个 </name> 结尾
• XML 标签大小写敏感
• XML 必须正确地嵌套
• XML 必须有且只有一个根元素
• 属性值必须加上引号，至于属性名则无需引号。

XML 元素命名规则

强制性的命名规则如下：

• 元素命名只包含文字（包括非英文的文字）、数字、字符
• 不能以 “XML” 或其他大写转换后为 “XML” 的字符串开头
• 不能包含空格

约定俗成（建议）的命名规则，除了上述几条之外，还有：

• 不要使用减号/连字符 “-”，建议使用下划线 “_”
• 避免使用点 “.” 和冒号 “:”
• 不要使用非 ascii 字符

属性

建议避免使用属性，而是以子元素 + 文本内容的方式来替代。比如：

<date>2018-10-11</date>

建议替换成范例中的：

<date>
   2018-10-11<!--可加可不加，加上可以作为对老代码的兼容-->
   <year>2018</year>
   <mon>10</mon>
   <mday>11</mday>
</date>

---

“转义”

这里借用了 C/C++ 里格式化字符串的 “转义” 一词，但是实际上 XML 没有这个名词，而是 “实体引用”。XML 中有五个预定义的实体引用，在使用的时候需要 “转义”：

字符名	字符	“转义” 后的字符串
小于号	<	&lt;
大于号	>	&gt;
”and“ 符号	&	&amp;
单引号	'	&apos;
双引号	"	&quot;

其中只有 < 和 & 是确实需要特殊处理的，但是作为规范，上述所有符号实际操作中均应处理。

---

XML CDATA

XML CDATA 是一个关键字，其包含的内容不会被 XML 解析器解析。CDATA 采用 <![CDATA 开头，用 ]]> 结尾。比如范例中的：

<href><![CDATA[https://cloud.tencent.com/developer/column/4101]]></href>

注意不同语言或库对 CDATA 的解析方式可能会有所不同，比如 Python 解析 CDATA 后会得到一个普通的 text 值，但是 RapidXML 则会得到一个子元素。

CDATA 也有限制，就是正文中不能包含 ]]>，否则会导致解析错误。

---

XML 命名空间

这个功能目前笔者觉得比较少用，不过还是记录一下。命名空间约定使用冒号进行分分隔。命名空间可以手动指定，如：

<f:table>
   <f:name>African Coffee Table</f:name>
   <f:width>80</f:width>
   <f:length>120</f:length>
</f:table>

实操中，推荐加上命名空间属性 xmlns，如：

<f:table xmlns:f="http://www.w3school.com.cn/furniture">
   <f:name>African Coffee Table</f:name>
   <f:width>80</f:width>
   <f:length>120</f:length>
</f:table>

---

参考资料

• XML 编码 - W3school 在线教程
• RapidXML解析CDATA类型节点的问题
• XML 宣告 XML 標準
• XML 在线格式化 - 1
• XML 在线格式化 - 2

---

本文章采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。

本文地址：https://segmentfault.com/a/1190000016649785
原文发布于：https://cloud.tencent.com/developer/article/1351914，也是本人的专栏。