XML参数实体是DTD(文档类型定义)中用于传递参数的特殊实体,它只能在DTD内部被引用,无法在XML文档的正文内容中使用,主要作用是复用DTD中的重复定义片段,减少冗余配置。合理使用参数实体可以让复杂的DTD结构更清晰,也便于后续的维护修改。

XML参数实体的基础定义
参数实体的定义语法和通用实体有明显区别,需要在实体名称前添加百分号%,并且定义语句必须放在DTD的内部子集或者外部子集当中。基本的定义格式如下:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE root [
<!ENTITY % 参数实体名 "实体内容">
]>
和普通通用实体不同,参数实体的名称在定义和引用时都需要保留百分号前缀,而且它的作用域仅限于DTD内部,不能出现在XML元素的内容里。
参数实体的引用规则
参数实体的引用同样只能在DTD内部进行,引用时需要使用%参数实体名;的格式,并且引用语句需要以分号结尾。下面是一个简单的引用示例:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE user [
<!ENTITY % 基础属性 "id CDATA #REQUIRED name CDATA #REQUIRED">
<!ELEMENT user (%基础属性;) >
]>
<user id="1" name="张三"></user>
上面的示例中,参数实体%基础属性被引用到了user元素的定义中,相当于把id CDATA #REQUIRED name CDATA #REQUIRED这段内容直接替换到了引用位置,简化了元素属性的定义过程。
外部参数实体的使用
参数实体也支持引用外部的资源内容,这类实体被称为外部参数实体,定义时需要使用SYSTEM关键字指定外部资源的路径。外部参数实体常用于拆分复杂的DTD配置,把不同模块的DTD定义放到不同的文件中,提升可维护性。
外部参数实体的定义格式如下:
<!ENTITY % 外部参数实体名 SYSTEM "外部DTD文件路径">
引用外部参数实体时,需要先定义实体,再通过%实体名;触发外部内容的加载,示例如下:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE config [
<!ENTITY % 公共定义 SYSTEM "http://ipipp.com/common.dtd">
%公共定义;
]>
<config>
<item>测试内容</item>
</config>
如果外部DTD文件common.dtd的内容是<!ELEMENT config (item+)><!ELEMENT item (#PCDATA)>,那么上述XML文档的DTD结构就会自动包含这些内容,不需要在内部重复编写。
参数实体和通用实体的区别
很多开发者容易混淆参数实体和通用实体,两者的核心区别可以通过以下表格清晰区分:
| 对比维度 | 参数实体 | 通用实体 |
|---|---|---|
| 定义前缀 | 需要添加% | 不需要添加前缀 |
| 引用位置 | 仅能在DTD内部引用 | 可以在XML正文和DTD中引用 |
| 引用格式 | %实体名; | &实体名; |
| 主要作用 | 复用DTD内部的定义片段 | 复用XML文档中的内容片段 |
使用参数实体的注意事项
- 参数实体的定义必须放在所有引用它的语句之前,否则解析器会提示实体未定义的错误。
- 不要在不可信的XML解析场景中开启外部参数实体的加载功能,避免触发XXE(XML外部实体注入)攻击,导致敏感文件泄露等问题。
- 参数实体的内容如果是DTD定义片段,需要保证片段本身的语法正确,否则会导致整个DTD解析失败。
- 如果参数实体定义的内容包含特殊字符,需要进行正确的转义,比如
<需要转义为<,避免解析错误。
常见应用场景
参数实体的常见应用场景主要有三类:
简化复杂DTD的编写
当DTD中存在大量重复的属性列表或者元素定义时,可以把重复部分定义为参数实体,在需要的位置引用,减少冗余代码。
拆分DTD配置模块
大型项目的DTD配置通常比较复杂,可以把不同业务模块的DTD定义放到不同的外部文件中,通过外部参数实体加载,让结构更清晰。
统一修改公共定义
如果多个XML文档的DTD有公共的定义部分,可以把公共部分定义为外部参数实体,修改时只需要调整外部文件,不需要逐个修改每个XML的DTD。
注意:在Java等语言的XML解析器中,默认可能会禁用外部参数实体的加载,如果需要使用外部参数实体,需要手动开启对应配置,但同时要做好安全防护。