HTTP 与 Web 标准 / 系统课时
元素名称有哪些限制
元素名称有哪些限制
XML 元素名称不是任意字符串。名称既要满足 XML 的语法规则,也应让人能够稳定理解和维护文档结构。本节会先掌握哪些名称能够合法使用,再区分“语法允许”和“实际值得采用”这两件事,避免因为空格、数字开头或命名风格混乱导致解析失败和维护困难。
学习目标
- 判断常见 XML 元素名称是否合法
- 避免数字开头、空格等典型命名错误
- 建立一致且易读的元素命名习惯
元素名称的基本规则
XML 名称区分大小写,因此 <book> 与 <Book> 是两个不同的名称。名称中可以使用字母、数字以及部分符号,但不能以数字或连字符等不允许作为名称起始字符的字符开头,也不能包含普通空格。
下面是一组可以正常组成 XML 文档的元素名称:
<catalog>
<book1>XML Basics</book1>
<book-title>XML Basics</book-title>
<book_title>XML Basics</book_title>
</catalog>预期结果:三个子元素名称都能够被 XML 解析器识别,整个文档保持结构良好。
XML document is well-formed数字可以出现在名称中,但不能放在开头。例如 book1 可以使用,而 1book 不应作为元素名称。
常见非法名称
最容易遇到的问题是名称以数字开头、包含空格,或者直接把业务描述中的自然语言空格复制进标签。
<catalog>
<1book>XML Basics</1book>
</catalog>预期结果:解析器会在读取 <1book> 时报告名称或标签语法错误。不同 XML 解析器的具体提示文字可能不同。
XML parse error: invalid element name如果需要表达“第一本书”,应把数字放到名称后部,或者把编号作为数据保存。例如可以写成 <book1>;在更适合结构化数据的设计中,也可以使用统一的 <book> 元素,再通过属性或子元素记录编号。
名称中同样不能直接出现普通空格:
<book title>XML Basics</book title>预期结果:这不会被解释为名为 book title 的元素。开始标签中的空格会参与标签语法解析,因此该写法不能形成预期的元素名称,并会导致文档结构错误。
XML parse error: malformed start or end tag需要多个单词时,应选择统一的连接方式,例如 book-title、book_title 或 bookTitle,而不是在名称中插入空格。
注意大小写必须完全匹配
XML 不会自动忽略名称大小写。开始标签和结束标签只有大小写完全一致,才会被认为是一对。
<book>
<title>XML Basics</title>
</book>预期结果:开始标签与结束标签名称完全一致,文档可以正常解析。
XML document is well-formed如果写成 <Book> 开始却使用 </book> 结束,解析器会把它们视为不同名称并报告标签不匹配。因此选定 book、Book 或其他风格后,应在整个文档中保持一致。
语法合法不等于命名清晰
元素名称还承担表达结构含义的职责。即使某个名称语法合法,如果过短、含义模糊或风格反复变化,也会降低可读性。下面几种命名方式都可以写出合法 XML,但维护体验差异很大。
| 命名 | 评价 | 原因 |
|---|---|---|
b |
不推荐 | 无法直接看出业务含义 |
bookTitle |
推荐 | 含义明确,适合统一使用驼峰风格的文档 |
book-title |
可用 | 单词边界清楚,但应保证全篇风格一致 |
book_title |
可用 | 易读,同样需要统一风格 |
BookTitle |
可用 | 语法上没有问题,但不要与 bookTitle 混用 |
还应谨慎使用以 xml 不区分大小写开头的名称,因为这类名称在 XML 规范中保留给标准及相关规范使用。业务元素应选择更具体的名称,例如 document、book、customerName,而不是自行创建 xmlData 一类名称。
建立一致的命名习惯
实际项目中可以采用一套简单规则:名称直接表达数据含义,多单词元素只选择一种连接风格,并在同一份文档或同一套接口中保持一致。例如选择小驼峰后,可以使用 bookTitle、authorName、publishDate,而不要同时混入 book_title 和 PublishDate。
XML 语法首先决定一个名称能不能被解析,一致的命名规范则决定文档是否容易阅读和长期维护。遇到名称问题时,先检查起始字符、空格和大小写匹配,再检查整份文档的命名风格是否统一。