当前位置:首页 > 文章列表 > Golang > Go问答 > Go xml.Decoder.Entity 怎样自定义 XML 实体替换

Go xml.Decoder.Entity 怎样自定义 XML 实体替换

来源:17golang原创 2026-11-19 04:40:32 0浏览 收藏

要自定义 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映射表中的字符串
<无需配置
XML 命名实体、Decoder.Entity 映射表和结构体字段之间的静态关系说明图
图1:结构说明图,查看自定义实体名如何经过 Entity 映射进入解码结果;这不是运行截图。

用 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 已知未知实体之间的静态边界说明图
图2:边界说明图,区分已注册实体、严格模式错误和非严格模式下保留的未知文本;这不是运行截图。

别把 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?
版本声明
本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
Go math/big.Int.GCD 怎样计算大整数的最大公约数Go math/big.Int.GCD 怎样计算大整数的最大公约数
上一篇
Go math/big.Int.GCD 怎样计算大整数的最大公约数
Go io.LimitedReader 为什么不会关闭底层 Reader
下一篇
Go io.LimitedReader 为什么不会关闭底层 Reader
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • PubMedQA数据集详解:生物医学问答基准、功能与应用指南
    PubMedQA
    深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
    1102次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    1098次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    1268次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    1209次使用
  • MMBench详解:多模态大模型基准测试、功能特点与使用指南
    MMBench
    MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
    1056次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议 和 隐私政策
返回登录
  • 重置密码