全面解析DTD属性取值范围从CDATA到NOTATION的十种类型及其在XML文档验证中的实际应用技巧与最佳实践

威震华夏关云长

引言

DTD（Document Type Definition，文档类型定义）是XML文档的一种验证机制，用于定义XML文档的结构和内容。在DTD中，元素可以有属性，而这些属性有不同的取值类型，每种类型都有其特定的用途和约束。本文将全面解析DTD中的十种属性取值类型，从CDATA到NOTATION，并探讨它们在XML文档验证中的实际应用技巧与最佳实践。

DTD属性取值类型详解

1. CDATA (Character Data)

CDATA是最简单的属性类型，表示属性值可以包含任何字符文本。CDATA类型的属性值可以包含字母、数字、符号和空格等，几乎没有任何限制。

特点：

• 可以包含任何字符，除了标记字符（如<、>、&等，这些需要转义）
• 不进行空白字符规范化
• 不进行词法检查

语法示例：

2. <!ATTLIST element_name attribute_name CDATA "default_value">

复制代码

实际应用：

2. <!ATTLIST book description CDATA "No description available">

复制代码

在XML文档中：

2. <book description="This is a book about XML & DTD validation techniques."/>

复制代码

CDATA类型特别适合用于存储描述性文本、标题或其他可能包含特殊字符的内容。但需要注意的是，即使在CDATA属性中，某些特殊字符（如<、>、&）仍然需要转义，以避免与XML标记混淆。

2. ID

ID类型的属性用于为元素提供唯一标识符。每个ID值在文档中必须是唯一的，并且必须遵循XML名称的规则（以字母或下划线开头，后跟字母、数字、连字符、下划线或句点）。

特点：

• 值在文档中必须唯一
• 必须是有效的XML名称
• 每个元素最多只能有一个ID类型的属性
• 不能有默认值（只能是#REQUIRED或#IMPLIED）

语法示例：

2. <!ATTLIST element_name attribute_name ID #REQUIRED>

复制代码

实际应用：

2. <!ATTLIST employee emp_id ID #REQUIRED>

复制代码

在XML文档中：

2. <employee emp_id="E1001">John Doe</employee>
3. <employee emp_id="E1002">Jane Smith</employee>

复制代码

ID类型在建立文档内关系时非常重要，它为元素提供了唯一的标识，可以被其他元素通过IDREF或IDREFS引用。在实际应用中，建议为ID属性使用有意义的前缀，便于识别和管理。

3. IDREF

IDREF类型的属性用于引用文档中其他元素的ID。它的值必须与文档中某个元素的ID值匹配。

特点：

• 值必须引用文档中存在的ID
• 必须是有效的XML名称
• 可以有默认值

语法示例：

2. <!ATTLIST element_name attribute_name IDREF #IMPLIED>

复制代码

实际应用：

2. <!ATTLIST project manager_id IDREF #REQUIRED>

复制代码

在XML文档中：

2. <employee emp_id="E1001">John Doe</employee>
3. <employee emp_id="E1002">Jane Smith</employee>
4. <project manager_id="E1001">Website Redesign</project>

复制代码

IDREF类型在建立元素间关系时非常有用，例如表示父子关系、从属关系等。通过IDREF，可以确保引用的目标确实存在于文档中，从而维护文档的完整性。

4. IDREFS

IDREFS类型类似于IDREF，但可以包含多个ID引用，用空格分隔。

特点：

• 值是多个ID引用，用空格分隔
• 每个引用的ID必须在文档中存在
• 必须是有效的XML名称
• 可以有默认值

语法示例：

2. <!ATTLIST element_name attribute_name IDREFS #IMPLIED>

复制代码

实际应用：

2. <!ATTLIST project team_members IDREFS #IMPLIED>

复制代码

在XML文档中：

2. <employee emp_id="E1001">John Doe</employee>
3. <employee emp_id="E1002">Jane Smith</employee>
4. <employee emp_id="E1003">Bob Johnson</employee>
5. <project team_members="E1001 E1002 E1003">Mobile App Development</project>

复制代码

IDREFS类型特别适合表示一对多的关系，例如一个项目有多个团队成员，一个订单包含多个产品等。使用IDREFS可以避免创建多个IDREF属性，使文档结构更加简洁。

5. NMTOKEN

NMTOKEN（Name Token）类型的属性值必须是有效的XML名称标记。这意味着它必须遵循XML名称的规则，但不必是唯一的。

特点：

• 必须是有效的XML名称标记（可以包含字母、数字、连字符、下划线、句点和冒号）
• 不必是唯一的
• 可以有默认值

语法示例：

2. <!ATTLIST element_name attribute_name NMTOKEN "default_value">

复制代码

实际应用：

2. <!ATTLIST product product_code NMTOKEN #REQUIRED>

复制代码

在XML文档中：

2. <product product_code="PRD-001">Laptop</product>
3. <product product_code="PRD-002">Mouse</product>

复制代码

NMTOKEN类型适合用于验证代码、标识符等需要特定格式的值，但不需要唯一性约束的属性。例如产品代码、SKU、订单号等。NMTOKEN确保属性值符合XML名称的规则，但不要求值在文档中唯一。

6. NMTOKENS

NMTOKENS类型类似于NMTOKEN，但可以包含多个名称标记，用空格分隔。

特点：

• 值是多个名称标记，用空格分隔
• 每个标记必须是有效的XML名称标记
• 不必是唯一的
• 可以有默认值

语法示例：

2. <!ATTLIST element_name attribute_name NMTOKENS "default_value">

复制代码

实际应用：

2. <!ATTLIST product keywords NMTOKENS #IMPLIED>

复制代码

在XML文档中：

2. <product keywords="electronics computer laptop">High-end Laptop</product>

复制代码

NMTOKENS类型适合用于处理标签、关键词等多值属性。例如，一个产品可以有多个关键词，一篇文章可以有多个标签等。使用NMTOKENS可以确保每个标记都符合XML名称的规则，同时允许多个值的存在。

7. ENTITY

ENTITY类型的属性值引用一个在DTD中声明的外部实体。这通常用于引用外部文件，如图像或其他二进制数据。

特点：

• 值必须引用在DTD中声明的实体
• 实体可以是内部的或外部的
• 可以有默认值

语法示例：

2. <!ATTLIST element_name attribute_name ENTITY "default_value">

复制代码

实际应用：

2. <!ENTITY logo SYSTEM "logo.png" NDATA PNG>
3. <!ATTLIST company_logo image ENTITY #REQUIRED>

复制代码

在XML文档中：

2. <company_logo image="logo"/>

复制代码

ENTITY类型允许XML文档引用外部资源，如图片、音频、视频或其他二进制数据。通过ENTITY，可以将这些外部资源与XML文档关联起来，同时保持文档的结构化和可验证性。

8. ENTITIES

ENTITIES类型类似于ENTITY，但可以引用多个实体，用空格分隔。

特点：

• 值是多个实体引用，用空格分隔
• 每个引用的实体必须在DTD中声明
• 可以有默认值

语法示例：

2. <!ATTLIST element_name attribute_name ENTITIES "default_value">

复制代码

实际应用：

2. <!ENTITY logo SYSTEM "logo.png" NDATA PNG>
3. <!ENTITY icon SYSTEM "icon.png" NDATA PNG>
4. <!ATTLIST product_images images ENTITIES #IMPLIED>

复制代码

在XML文档中：

2. <product_images images="logo icon"/>

复制代码

ENTITIES类型适合用于引用多个外部资源，例如一个产品可以有多个图片，一篇文章可以有多媒体内容等。使用ENTITIES可以简化文档结构，避免创建多个ENTITY属性。

9. NOTATION

NOTATION类型的属性值引用一个在DTD中声明的符号（notation）。符号用于标识非XML数据的格式，如图像格式或应用程序特定的数据格式。

特点：

• 值必须引用在DTD中声明的符号
• 符号用于标识外部数据的格式
• 可以有默认值

语法示例：

2. <!ATTLIST element_name attribute_name NOTATION "default_value">

复制代码

实际应用：

2. <!NOTATION PNG SYSTEM "image/png">
3. <!ATTLIST image format NOTATION (PNG) #REQUIRED>

复制代码

在XML文档中：

2. <image format="PNG">image.png</image>

复制代码

NOTATION类型用于标识外部数据的格式，确保应用程序可以正确处理这些数据。例如，可以标识图像格式（PNG、JPEG等）、音频格式（MP3、WAV等）或其他特定格式的数据。

10. 枚举类型（Enumerated）

枚举类型不是DTD中的关键字，而是一种属性类型，它限制属性值只能是预定义的几个值之一。

特点：

• 值必须是预定义列表中的一个
• 预定义值用竖线（|）分隔
• 可以有默认值

语法示例：

2. <!ATTLIST element_name attribute_name (value1|value2|value3) "default_value">

复制代码

实际应用：

2. <!ATTLIST employee status (active|inactive|terminated) "active">

复制代码

在XML文档中：

2. <employee status="active">John Doe</employee>
3. <employee status="inactive">Jane Smith</employee>

复制代码

枚举类型是限制属性值的有效方法，确保属性值只能是预定义的几个值之一。这对于表示状态、类型、分类等有限集合的属性特别有用。枚举类型可以确保数据的一致性，避免无效或错误的数据输入。

XML文档验证中的实际应用技巧与最佳实践

1. 合理使用ID和IDREF建立文档内关系

ID和IDREF类型是建立XML文档内元素关系的重要工具。例如，在表示公司组织结构时，可以使用ID标识每个员工，然后使用IDREF引用员工的上级。

最佳实践：

• 为ID属性使用有意义的前缀，便于识别（如”emp_“表示员工ID）
• 确保ID值在文档中真正唯一，避免重复
• 使用IDREFS而不是多个IDREF属性，当一个元素需要引用多个其他元素时

示例：

2. <!ATTLIST employee
3.     emp_id ID #REQUIRED
4.     name CDATA #REQUIRED
5.     manager_id IDREF #IMPLIED
6.     subordinates IDREFS #IMPLIED
7. >
9. <employee emp_id="E001" name="CEO">
10.     <employee emp_id="E002" name="CTO" manager_id="E001">
11.         <employee emp_id="E003" name="Developer" manager_id="E002"/>
12.     </employee>
13.     <employee emp_id="E004" name="CFO" manager_id="E001"/>
14. </employee>

复制代码

2. 使用NMTOKEN和NMTOKENS进行词法验证

NMTOKEN和NMTOKENS类型可用于确保属性值符合特定的词法规则，而不需要 enforcing 唯一性约束。

最佳实践：

• 使用NMTOKEN验证代码、标识符等需要特定格式的值
• 使用NMTOKENS处理标签、关键词等多值属性
• 避免在NMTOKEN中使用空格，因为空格是NMTOKENS中的分隔符

示例：

2. <!ATTLIST product
3.     product_code NMTOKEN #REQUIRED
4.     category NMTOKEN #REQUIRED
5.     keywords NMTOKENS #IMPLIED
6. >
8. <product product_code="PRD-001" category="electronics" keywords="computer laptop portable">Laptop</product>

复制代码

3. 使用枚举类型限制属性值范围

枚举类型是限制属性值的有效方法，确保属性值只能是预定义的几个值之一。

最佳实践：

• 为枚举值使用有意义的名称
• 考虑将常用的枚举列表定义为参数实体，以便重用
• 为枚举属性提供合理的默认值

示例：

2. <!ENTITY % status_values "(active|inactive|pending|closed)">
3. <!ATTLIST order
4.     order_id ID #REQUIRED
5.     status %status_values; "pending"
6.     customer_id IDREF #REQUIRED
7. >
9. <order order_id="O001" status="active" customer_id="C001"/>

复制代码

4. 使用ENTITY和ENTITIES引用外部资源

ENTITY和ENTITIES类型允许XML文档引用外部资源，如图像、视频或其他二进制数据。

最佳实践：

• 为外部实体提供清晰的SYSTEM或PUBLIC标识符
• 使用NOTATION指定外部数据的格式
• 考虑使用XML Base或相对路径，以便于文档移动

示例：

2. <!NOTATION PNG SYSTEM "image/png">
3. <!NOTATION JPEG SYSTEM "image/jpeg">
4. <!ENTITY company_logo SYSTEM "logo.png" NDATA PNG>
5. <!ENTITY product_image1 SYSTEM "product1.jpg" NDATA JPEG>
6. <!ENTITY product_image2 SYSTEM "product2.jpg" NDATA JPEG>
8. <!ATTLIST product
9.     product_id ID #REQUIRED
10.     name CDATA #REQUIRED
11.     images ENTITIES #IMPLIED
12. >
14. <product product_id="P001" name="Laptop" images="product_image1 product_image2"/>

复制代码

5. 使用CDATA处理自由文本

CDATA类型适用于包含自由文本的属性，特别是当文本可能包含特殊字符时。

最佳实践：

• 对可能包含特殊字符（如<、>、&等）的属性使用CDATA
• 考虑使用元素而不是属性来存储大量文本
• 记住CDATA属性中的特殊字符仍然需要转义

示例：

2. <!ATTLIST book
3.     isbn ID #REQUIRED
4.     title CDATA #REQUIRED
5.     description CDATA #IMPLIED
6. >
8. <book isbn="978-1234567890" title="XML & DTD Guide" description="A comprehensive guide to XML & DTD validation techniques."/>

复制代码

6. 结合使用多种属性类型

在实际应用中，常常需要结合使用多种属性类型来创建复杂的文档结构。

最佳实践：

• 为每个元素选择最合适的属性类型
• 确保属性类型之间的约束关系（如IDREF引用的ID必须存在）
• 使用注释说明复杂属性结构的用途

示例：

2. <!ATTLIST course
3.     course_id ID #REQUIRED
4.     title CDATA #REQUIRED
5.     credits NMTOKEN #REQUIRED
6.     prerequisites IDREFS #IMPLIED
7.     status (active|inactive|archived) "active"
8. >
10. <course course_id="CS101" title="Introduction to Computer Science" credits="3">
11. <course course_id="CS201" title="Data Structures" credits="4" prerequisites="CS101">
12. <course course_id="CS301" title="Algorithms" credits="4" prerequisites="CS201" status="inactive">

复制代码

7. 处理属性默认值

DTD允许为属性指定默认值，这可以简化XML文档的创建。

最佳实践：

• 为大多数情况下使用的属性值提供合理的默认值
• 使用#REQUIRED确保关键属性始终提供
• 使用#IMPLIED表示可选属性
• 使用#FIXED表示属性值必须为特定值

示例：

2. <!ATTLIST person
3.     person_id ID #REQUIRED
4.     name CDATA #REQUIRED
5.     age NMTOKEN #IMPLIED
6.     gender (male|female|other) #IMPLIED
7.     country CDATA "USA"
8.     species CDATA #FIXED "Homo sapiens"
9. >
11. <person person_id="P001" name="John Doe"/>
12. <person person_id="P002" name="Jane Smith" age="30" gender="female"/>

复制代码

8. 验证XML文档

创建DTD后，需要验证XML文档是否符合DTD定义的约束。

最佳实践：

• 使用XML解析器或验证工具验证XML文档
• 在开发过程中尽早进行验证，避免后期发现问题
• 考虑使用自动化构建工具集成验证过程

示例（使用Python验证XML文档）：

2. from xml.dom import minidom
3. from xml.parsers.expat import ExpatError
5. def validate_xml_with_dtd(xml_file, dtd_file):
6.     try:
7.         # 创建DTD对象
8.         dtd = minidom.parse(dtd_file)
9.         
10.         # 解析XML文档并验证
11.         doc = minidom.parse(xml_file)
12.         
13.         print("XML文档验证通过！")
14.         return True
15.     except ExpatError as e:
16.         print(f"XML文档验证失败: {e}")
17.         return False
18.     except Exception as e:
19.         print(f"验证过程中发生错误: {e}")
20.         return False
22. # 使用示例
23. validate_xml_with_dtd("example.xml", "example.dtd")

复制代码

9. DTD的局限性及替代方案

虽然DTD是XML验证的重要工具，但它也有一些局限性，了解这些局限性并考虑替代方案是重要的。

DTD的局限性：

• 数据类型支持有限（只有十种属性类型）
• 不支持命名空间
• 语法不同于XML，需要学习额外的语法
• 难以表达复杂的约束关系

替代方案：

• XML Schema (XSD): 提供更丰富的数据类型和更强大的验证能力
• RELAX NG: 另一种XML验证语言，语法更简洁
• Schematron: 基于规则的验证语言，可以表达复杂的业务规则

示例（使用XML Schema定义类似的结构）：

2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
3.     <xs:element name="employee">
4.         <xs:complexType>
5.             <xs:attribute name="emp_id" type="xs:ID" use="required"/>
6.             <xs:attribute name="name" type="xs:string" use="required"/>
7.             <xs:attribute name="status" use="optional" default="active">
8.                 <xs:simpleType>
9.                     <xs:restriction base="xs:string">
10.                         <xs:enumeration value="active"/>
11.                         <xs:enumeration value="inactive"/>
12.                         <xs:enumeration value="terminated"/>
13.                     </xs:restriction>
14.                 </xs:simpleType>
15.             </xs:attribute>
16.         </xs:complexType>
17.     </xs:element>
18. </xs:schema>

复制代码

10. 最佳实践总结

在实际应用中，以下是一些DTD属性类型的最佳实践总结：

1. 为每个元素选择最合适的属性类型：根据属性的性质和用途，选择最合适的属性类型。例如，需要唯一标识的属性使用ID，需要引用其他元素的属性使用IDREF，有固定选项的属性使用枚举类型。
2. 使用ID和IDREF建立文档内关系：通过ID和IDREF可以建立元素间的关系，如父子关系、从属关系等。确保ID值在文档中真正唯一，IDREF引用的ID确实存在。
3. 使用枚举类型限制属性值范围：对于有固定选项的属性，使用枚举类型可以限制属性值的范围，确保数据的一致性。
4. 为属性提供合理的默认值：为大多数情况下使用的属性值提供合理的默认值，可以简化XML文档的创建，减少不必要的属性声明。
5. 确保ID值在文档中真正唯一：ID值在文档中必须唯一，这是DTD验证的重要约束。在创建XML文档时，确保ID值不会重复。
6. 使用NMTOKEN验证代码、标识符等需要特定格式的值：NMTOKEN类型可以确保属性值符合XML名称的规则，适合用于验证代码、标识符等需要特定格式的值。
7. 使用CDATA处理可能包含特殊字符的文本：对于可能包含特殊字符的文本，使用CDATA类型可以避免解析错误，但需要注意特殊字符的转义。
8. 定期验证XML文档是否符合DTD定义：在开发过程中，定期验证XML文档是否符合DTD定义的约束，可以及早发现问题，提高文档质量。
9. 考虑DTD的局限性，在需要时使用更强大的替代方案：DTD有一些局限性，如数据类型支持有限、不支持命名空间等。在需要更强大的验证能力时，考虑使用XML Schema、RELAX NG或Schematron等替代方案。
10. 为复杂的DTD结构添加注释，提高可维护性：对于复杂的DTD结构，添加注释可以提高可读性和可维护性，便于其他开发者理解和修改。

为每个元素选择最合适的属性类型：根据属性的性质和用途，选择最合适的属性类型。例如，需要唯一标识的属性使用ID，需要引用其他元素的属性使用IDREF，有固定选项的属性使用枚举类型。

使用ID和IDREF建立文档内关系：通过ID和IDREF可以建立元素间的关系，如父子关系、从属关系等。确保ID值在文档中真正唯一，IDREF引用的ID确实存在。

使用枚举类型限制属性值范围：对于有固定选项的属性，使用枚举类型可以限制属性值的范围，确保数据的一致性。

为属性提供合理的默认值：为大多数情况下使用的属性值提供合理的默认值，可以简化XML文档的创建，减少不必要的属性声明。

确保ID值在文档中真正唯一：ID值在文档中必须唯一，这是DTD验证的重要约束。在创建XML文档时，确保ID值不会重复。

使用NMTOKEN验证代码、标识符等需要特定格式的值：NMTOKEN类型可以确保属性值符合XML名称的规则，适合用于验证代码、标识符等需要特定格式的值。

使用CDATA处理可能包含特殊字符的文本：对于可能包含特殊字符的文本，使用CDATA类型可以避免解析错误，但需要注意特殊字符的转义。

定期验证XML文档是否符合DTD定义：在开发过程中，定期验证XML文档是否符合DTD定义的约束，可以及早发现问题，提高文档质量。

考虑DTD的局限性，在需要时使用更强大的替代方案：DTD有一些局限性，如数据类型支持有限、不支持命名空间等。在需要更强大的验证能力时，考虑使用XML Schema、RELAX NG或Schematron等替代方案。

为复杂的DTD结构添加注释，提高可维护性：对于复杂的DTD结构，添加注释可以提高可读性和可维护性，便于其他开发者理解和修改。

结论

DTD属性类型是XML文档验证的重要组成部分，通过合理使用CDATA、ID、IDREF、IDREFS、NMTOKEN、NMTOKENS、ENTITY、ENTITIES、NOTATION和枚举类型这十种属性类型，可以创建结构良好、内容准确的XML文档。

在实际应用中，应根据属性的性质和用途选择最合适的属性类型，并遵循最佳实践，如确保ID值唯一、使用枚举类型限制属性值范围、为属性提供合理的默认值等。同时，应了解DTD的局限性，在需要时考虑使用更强大的替代方案。

通过深入理解DTD属性类型及其应用技巧，可以更好地设计和验证XML文档，提高文档的质量和可维护性。