Go xml.Decoder.Entity 怎样自定义 XML 实体替换
来源:17golang原创
时间:2026-11-19 04:40:32 220浏览 收藏
要自定义 Go 里 xml.Decoder 的 XML 实体替换逻辑,直接给 Decoder 实例的 Entity 字段赋值自定义的实体映射表,就能覆盖标准库的默认替换规则,实现你想要的自定义替换效果。
解析第三方 XML 时,如果正文出现 &company;、&product; 这类业务实体,Go 的 encoding/xml 不会替你猜它们代表什么。解决办法是给 xml.Decoder.Entity 设置一个 map[string]string:键写实体名本身,值写希望得到的字符串。比如把 company 映射为 Acme,解码后的字符数据就能直接进入结构体字段。
要注意,Entity 只处理命名实体替换,不负责 DTD 声明、字符集转换、网络请求或 XML 结构修复。下面从一次“未知实体导致 Decode 失败”的排查开始。
先看 Entity 到底改变了哪一层
xml.Decoder 默认把输入当作 UTF-8 XML 读取。它的 Entity 字段是一个命名映射表,作用位置在 XML 解析器处理实体引用时:&company; 会按 company 这个键查表,再把结果交给后续的字符数据或属性值解析。
因此,键不要写成 &company;,也不要把 XML 中的完整片段当成键。真正的映射关系是:
| XML 写法 | Entity 的键 | 解码后的文本 |
|---|---|---|
&company; | company | 映射表中的字符串 |
< | 无需配置 | |

用 map[string]string 配置业务实体
把实体名当作普通字符串键即可。下面的示例把订单中的 &company; 和 ¤cy; 替换为实际文本,再交给 Decode 填充结构体。
package main
import (
"encoding/xml"
"fmt"
"log"
"strings"
)
type Order struct {
Customer string `xml:"customer"`
Amount string `xml:"amount"`
}
func main() {
data := `&company; 100¤cy; `
decoder := xml.NewDecoder(strings.NewReader(data))
// 键只写实体名,不带前后的 & 和分号。
decoder.Entity = map[string]string{
"company": "Acme",
"currency": " 元",
}
var order Order
// Decode 负责把实体替换后的字符数据填入结构体。
if err := decoder.Decode(&order); err != nil {
log.Fatal(err)
}
fmt.Printf("%s / %s\\n", order.Customer, order.Amount)
}
这个映射表只属于当前 decoder。如果同一个程序要解析另一套实体词表,应为那次输入建立独立的配置,避免把一个业务协议的名称带到另一个 XML 文档里。
未知实体报错时,先检查 Strict 和实体名
当 XML 中出现 ®ion;,而 Entity 没有对应键时,默认严格模式会把它当作无法识别的实体。排查时先确认三件事:键是否漏写、键名大小写是否一致、输入中的实体是否真的以分号结束。
decoder := xml.NewDecoder(strings.NewReader(data))
// Strict 默认为 true;未知实体应尽早暴露,适合协议数据。
decoder.Strict = true
decoder.Entity = map[string]string{
"region": "华东",
}
var document Document
if err := decoder.Decode(&document); err != nil {
// 保留原始错误,便于定位具体 XML 输入和实体词表。
return fmt.Errorf("decode xml: %w", err)
}
如果输入是容错 HTML 或历史系统产生的非规范片段,可以把 Strict 设为 false。但这不是“自动补全实体”:未知或格式异常的实体会被保留,调用方仍要决定如何处理它们。协议型 XML 通常更适合保持严格模式,让词表遗漏尽早暴露。

别把 Entity 和三个相邻配置混在一起
实际排查中最容易混淆的是下面三组概念:
- 内置实体:
lt、gt、amp、apos、quot的标准映射始终存在,不需要重复塞进自定义表。 - CharsetReader:只负责把非 UTF-8 输入转换为 UTF-8;它解决的是字节编码,不是
&name;的业务替换。 - Strict:控制解析器对常见不规范 XML 的容忍程度;关闭它不会替你构造缺失的实体值。
还有一个边界:Entity 是解析配置,不是外部实体加载器。不要因为 XML 中出现一个名字,就去读取本地文件或访问网络。若业务需要允许的实体集合,把它限制在明确的静态 map 中,未知名称按错误或原文处理。
记住这套判断就够了
需要自定义 XML 命名实体时,使用 xml.NewDecoder 后设置 decoder.Entity["实体名"] = "替换文本";键不带 & 和分号,内置五种实体无需配置。严格模式适合发现词表遗漏,非严格模式只会保留未知实体文本。遇到乱码则去看 CharsetReader,不要继续扩大 Entity。
相关问题
- 为什么给 Entity 写了
&name;作为键仍然不生效? - Strict=false 是否会自动把未知实体转换成普通文字?
- 非 UTF-8 XML 应该配置 Entity 还是 CharsetReader?
-
369 收藏
-
344 收藏
-
464 收藏
-
327 收藏
-
264 收藏
-
150 收藏
-
242 收藏
-
Golang · Go问答 | 39分钟前 | 标准库 · net/http · 后端开发 · Go问答 · Go net/http POST表单 ParseForm http.Request.PostFormValue FormValue491 收藏
-
Golang · Go问答 | 42分钟前 | 标准库 · Context · 并发控制 · net/http · Go问答 · Go 请求超时 handler 取消信号 ErrHandlerTimeout Request.Context http.TimeoutHandler311 收藏
-
389 收藏
-
Golang · Go问答 | 49分钟前 | 错误处理 · 重定向 · net/http · HTTP客户端 · Go问答 · Go net/http error response CheckRedirect http.Client.Do ErrUseLastResponse164 收藏
-
Golang · Go问答 | 51分钟前 | 网络编程 · TCP · Go问答 · Go KeepAliveConfig SetKeepAlivePeriod net.TCPConn.SetKeepAlive TCP keep-alive474 收藏
-
181 收藏
-
339 收藏
-
Golang · Go问答 | 1小时前 | 文件处理 · csv · Go问答 · 错误排查 · Go encoding/csv csv.Reader CSV读取 FieldsPerRecord ErrFieldCount210 收藏
-
170 收藏
-
440 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习