登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go问答

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映射表中的字符串
<无需配置
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删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>