要让Go自定义类型支持XML序列化,需实现xml.Marshaler接口的MarshalXML方法;接收者推荐用指针,手动调用Encoder写入起始标签、字段内容和结束标签,并处理错误。

要让 Go 语言的自定义类型支持 XML 序列化(即能被 xml.Marshal 正确编码),只需为该类型实现 xml.Marshaler 接口,也就是实现一个名为 MarshalXML 的方法。
接口定义和基本要求
xml.Marshaler 是一个内建接口:
MarshalXML(e *xml.Encoder, start xml.StartElement) error
}
你必须在自定义类型上定义这个方法,接收者可以是值或指针,但**推荐用指针**(避免复制大结构体,也方便内部修改状态)。
实现步骤和注意事项
实现时需手动控制 XML 元素的开始标签、内容和结束标签。常见操作包括:
立即学习“go语言免费学习笔记(深入)”;
- 调用
e.EncodeToken(start)写入起始标签 - 对字段逐个调用
e.EncodeToken(...)或e.Encode(...)输出子元素或文本内容 - 调用
e.EncodeToken(xml.EndElement{start.Name})写入闭合标签 - 每步都要检查并返回错误,不能忽略
e.Flush()可能的失败(虽然通常不用显式 flush)
一个实用示例:带属性和嵌套结构的自定义类型
假设有个 Person 类型,想输出为:
可以这样实现:
type Person struct {ID int `xml:"-"` // 不自动序列化
Name string `xml:"name"`
Age int `xml:"age"`
}
func (p *Person) MarshalXML(e *xml.Encoder, start xml.StartElement) error {
// 添加自定义属性
start.Attr = append(start.Attr, xml.Attr{Name: xml.Name{Local: "id"}, Value: fmt.Sprintf("%d", p.ID)})
if err := e.EncodeToken(start); err != nil {
return err
}
// 手动编码字段(注意:不走 struct tag 自动逻辑)
if err := e.EncodeElement(p.Name, xml.StartElement{Name: xml.Name{Local: "name"}}); err != nil {
return err
}
if err := e.EncodeElement(p.Age, xml.StartElement{Name: xml.Name{Local: "age"}}); err != nil {
return err
}
return e.EncodeToken(xml.EndElement{start.Name})
}
常见陷阱与建议
- 不要在
MarshalXML中直接调用xml.Marshal处理自身(会无限递归) - 如果只想“微调”默认行为(比如加个属性、改个字段名),可先用
xml.Marshal序列化为字节,再解析/修改 —— 但性能差,仅适合简单场景 - 若类型含嵌套自定义类型,且它们也实现了
MarshalXML,记得在父类型的实现中主动调用e.Encode(...),否则不会触发子类型的自定义逻辑 - 空结构体或零值字段的处理逻辑由你完全控制,比如是否省略、是否输出空标签等
基本上就这些。核心就是掌握 *xml.Encoder 的 Token 编码流程,把控制权从反射式自动序列化转为手动构造 XML 树。








