XML 是一项支持良好的 Internet 标准,专门用于以一种特殊方式编码结构化数据:XML 编码的数据几乎可以用任何编程语言轻松解码,甚至能用普通文本编辑器由人阅读和编写。许多应用程序——尤其是遵循现代标准的 Web 浏览器——可以直接处理 XML 数据。
在 XML 中,实体有四种典型用途:表示特殊字符(那些通常很难甚至无法在标准键盘上敲出来的字符)、复用成段的 XML 代码、把一份文档拆成多个文件来组织,以及简化 DTD 的编写。本文要介绍的就是四类实体——字符实体、命名实体、外部实体和参数实体——它们各自的工作方式,以及如何在你的 XML 文档里用好它们。
实体本质上是对数据的一次引用。根据实体种类的不同,XML 解析器会用该实体的替代文本,或者外部文件的内容,来替换掉这处实体引用。
所有实体(参数实体除外)都以一个 & 开头、以一个分号(;)结尾。XML 标准规定了五种所有解析器都必须实现的预定义实体:
在 XHTML 和 XML 文档里,尤其是那些需要展示标记本身的文档中,&、< 和 > 几乎天天见。
字符实体让你可以指定任意 Unicode 字符,写法有两种:十进制(&#nnn;,nnn 是字符的十进制码位)或十六进制(&#xhhh;,hhh 是十六进制码位)。
举个例子,大写字母 A 是 Unicode 字符 U+0041,写成字符实体就是 A(十进制)或 A(十六进制)。再举个更实用的例子:版权符号 © 是 U+00A9,对应的字符实体是 © 或 ©。
解析顺序上,字符实体会在其他实体之前被优先替换。对 XML 解析器而言,字符实体与直接在文档里敲入那个字符的效果完全一样。它有点像 C 语言里的三字母符(trigraphs):只是某个字符的另一种写法而已。
还要提醒一点:解析器可以毫不费力地处理「任何」字符实体,但下游的应用程序和显示系统未必跟得上。如果当前字体里找不到对应字形,多数系统会显示一个占位符。所以在你往文档里塞各种冷僻字符之前,先确认字体与编码支持到位。
命名实体(在 XML 规范里也叫内部实体)就是我们日常说「实体」时所指的那种。它在 DTD 或内部子集(即文档中 <!DOCTYPE> 语句的一部分)里声明,在正文中通过引用使用;解析过程中,实体引用会被它的表示替换掉。
一句话:实体就是宏,在文档处理时被展开。
XHTML 规范就用命名实体来表示 ISO 8859-1(Latin 1)字符集中包含、但多数键盘上没有的那些字符,另外还有一些用于特殊字符和符号。这些标准实体受到浏览器的良好支持,甚至让我们能在只支持 7 位 ASCII 的系统(是的,至今仍有人在用老式大型机)上,用纯文本编辑器编写 XHTML 文档。清单 1 是 XHTML 1.0 部分特殊字符的声明片段。
清单 1. XHTML 1.0 的若干特殊字符
<!ENTITY ndash "–"> <!-- en dash, U+2013 ISOpub -->
<!ENTITY mdash "—"> <!-- em dash, U+2014 ISOpub -->
<!ENTITY lsquo "‘"> <!-- left single quotation mark,
U+2018 ISOnum -->
<!ENTITY rsquo "’"> <!-- right single quotation mark,
U+2019 ISOnum -->
<!ENTITY sbquo "‚"> <!-- single low-9 quotation mark,
U+201A NEW -->
<!ENTITY ldquo "“"> <!-- left double quotation mark,
U+201C ISOnum -->
<!ENTITY rdquo "”"> <!-- right double quotation mark,
U+201D ISOnum -->
如清单 1 所示,命名实体的替代文本往往就是一个字符实体;而字符实体又等同于直接敲入被引用的字符。所以当你在文档里写 –,它最终被展开为 Unicode 字符 U+2013(短横线)。
命名实体是在整份文档被读取之后才解析的。因此实体完全可以引用另一个实体,因为所有实体都会在展开之前先被声明。清单 2 就是这样一个例子:
清单 2. 引用实体的实体
<!ENTITY c "Chris">
<!ENTITY ch "&c; Herborth">
在文档中使用 &c; 会展开为 Chris,而 &ch; 会展开为完整的 Chris Herborth。
循环引用是实体里的错误。一旦构成循环引用导致文档无效,解析器会报错。
在 Firefox、Safari 和 Chrome 中,这些实体引用的效果与存储在 XML 文件里的 XHTML 文档一致,但 Internet Explorer 8 的行为不同。至于如何声明命名实体,下一节会讲。
外部实体代表另一个文件的内容。它在某些场景下非常好用——比如你在写一本书,希望每章单独存一个文件。这时可以定义这样一组实体:
清单 3. 外部实体引用其他文件
<!ENTITY chap1 SYSTEM "chapter-1.XML">
<!ENTITY chap2 SYSTEM "chapter-2.XML">
<!ENTITY chap3 SYSTEM "chapter-3.XML">
然后在主文档里把这些实体拼起来(见清单 4),各章内容就会被插入到引用点。
清单 4. 把各章拼到一起
<?XML version="1.0" encoding="utf-8"?>
<!-- Pull in the chapter content: -->
&chap1;
&chap2;
&chap3;
由于这些文件的内容会被直接插入 XML 文档,它们本身也必须是有效且「平衡」的 XML:在一个外部实体引用的文件里开始的元素,必须在该文件内结束。当清单 4 被解析时,处理器眼中的它就是一个大文档,只不过内容分散在四个文件里——XML 处理程序对此毫不在意。
参数实体只用于 DTD 和文档的内部子集中。它们用百分号(%)而不是 & 引导,同样可以是命名实体或外部实体。
在 XHTML DTD 里,参数实体一方面用来引用那些声明在外部文件中的实体集(Latin 1、Special Characters、Symbols),另一方面充当快捷方式,用来复用 DTD 的某些片段——比如每个 XHTML 元素都支持的标准属性集(见清单 5)。
清单 5. XHTML 1 DTD 中的一个参数实体
<!ENTITY % attrs "%coreattrs; %i18n; %events;">
<!ENTITY % coreattrs
"id ID #IMPLIED
class CDATA #IMPLIED
style %StyleSheet; #IMPLIED
title %Text; #IMPLIED"
>
<!ENTITY % i18n
"lang %LanguageCode; #IMPLIED
XML:lang %LanguageCode; #IMPLIED
dir (ltr|rtl) #IMPLIED"
>
如清单 5 所示,参数实体可以引用其他参数实体;与命名实体一样,它们也是在整份文档读完之后才展开。
实体通过 ENTITY 声明来定义,位置可以是外部 DTD 的一部分(清单 6),也可以是文档内部子集的一部分(清单 7)。
清单 6. DTD 中的实体声明
<!-- 6.1 Named entity for site name: -->
<!ENTITY dw "developerWorks">
<!-- 6.2 External entity for re-use: -->
<!ENTITY bio SYSTEM "dw-author-bio.XML">
<!-- 6.3 Parameter entity for use in DTD -->
<!ENTITY % English "en-US|en-CA|en-UK">
声明命名实体时,要给出实体名和它的替代文本。替代文本里可以包含字符实体、命名实体和元素,但不能包含参数实体。
清单 7. 内部子集中的实体声明
<?XML version="1.0" encoding="UTF-8"?>
<!DOCTYPE Html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"https://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
[
<!ENTITY test-entity "This <em>is</em> an entity.">
]>
<html XMLns="https://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+XML;charset=utf-8"/>
<title>Entities in XML</title>
</head>
<body>
<h1>Entities in XML</h1>
<p>&test-entity;</p>
<p>You can use it anywhere you'd use a standard XHTML entity:</p>
<pre>&test-entity;</pre>
</body>
</Html>
清单 7 中的 XHTML 文档(在我的系统上存为 entities.XML)在内部子集里声明了一个名为 test-entity 的新实体。所谓内部子集,就是 <!DOCTYPE> 声明中位于 PUBLIC 和/或 SYSTEM 标识符之后的那对方括号里的内容。
目前浏览器似乎并不支持内部子集中的外部实体或参数实体,这可能是一项安全措施:这两类实体若与浏览器的渲染引擎一起使用,有可能被用来构造拒绝服务攻击或其他恶意文档。
现在你已经了解使用实体的机制了(DTD 中的参数实体同理)。前面各清单分别演示了各类实体的用法:
当你需要反复输入同一段文字时,就该考虑实体了。典型候选包括:公司的正式名称、正在记录的产品的名称、版权声明、商标与注册商标提示,以及邮箱地址(清单 8)。
清单 8. 用实体减少重复输入
<!ENTITY co "Father Karass' Olde Tyme Steambots, LLC">
<!ENTITY prod "Semi-Autonomous Security Servant (SASSbot)">
<!ENTITY c "Copyright © 2010 &co; All Rights Reserved.">
<!ENTITY author "Chris Herborth (chrish@pobox.com)">
那些「可能会变」的东西——产品名称是最典型的例子——特别适合用实体来管,这跟在程序源码里声明常量是一个道理。产品改名时,你只需要改一处实体声明,而不必在全站文件里搜索替换(清单 9)。
清单 9. 用实体轻松应对不断变化的文档
<!-- Current name: -->
<!ENTITY prod "Semi-Autonomous Security Servant (SASSbot)">
<!-- Old names preserved for posterity: -->
<!-- Original R&D name: -->
<!--ENTITY prod "Security Bot"-->
<!-- Marketing name v1 -->
<!--ENTITY prod "Security Servant Bot"-->
<!-- Marketing name v2 -->
<!--ENTITY prod "Autonomous Security Servant Bot"-->
基于 XML 的标准(比如 XHTML)自带一套实用的实体库,让「敲不出来的字符」也能写进文档。命名实体的作用类似宏,用一个简短引用替代重复或难输入的文本。虽然 Web 浏览器并不支持外部实体,但在其他 XML 应用中,它们能帮你把文档拆件组装,让标准化与复用变得容易得多。参数实体则用于把外部声明引入 DTD,或在 DTD 内部创建宏以改善可读性。
在 XML 文档的 DOCTYPE 声明里定义命名实体非常简单,而在正文中使用它们,你大概早就会了。