嵌套自定义类型时Go XML Unmarshal值丢失问题排查与解决

问题场景 #

单独解析<gd:name>节点时，定义GDName结构体可成功获取内容：

type GDName struct {
    GivenName string `xml:"gd givenName"`
}

测试代码：

bs := []byte(`  <gd:name>
    <gd:givenName>FIRST_NAME</gd:givenName>
    </gd:name>
    `)

var n GDName
err := xml.Unmarshal(bs, &n)
if err != nil {
    fmt.Println(err)
}

fmt.Printf("%#v", n) // 输出 main.GDName{GivenName:"FIRST_NAME"}

但当处理外层带命名空间的<entry>嵌套结构时，定义ContactKind结构体并使用自定义UnmarshalXML方法后，无法将<gd:name>内容解析到ContactKind.Name字段：

bs2 := []byte(`<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gd='http://schemas.google.com/g/2005'>
<gd:name>
    <gd:givenName>FIRST_NAME</gd:givenName>
</gd:name></entry>`)

var ct ContactKind
err = xml.Unmarshal(bs2, &ct)
if err != nil {
    fmt.Println(err)
}

fmt.Printf("%#v", ct.Name) // 无法得到期望的GDName实例

期望输出与单独解析结果一致：main.GDName{GivenName:"FIRST_NAME"}。

问题原因 #

核心问题是XML命名空间的匹配逻辑：

• 外层<entry>定义了默认命名空间（http://www.w3.org/2005/Atom）和gd前缀对应的命名空间（http://schemas.google.com/g/2005）。
• 若ContactKind的结构体标签未明确指定<gd:name>对应的完整命名空间URI，或自定义UnmarshalXML方法未处理命名空间匹配，解析器无法将带gd前缀的元素与结构体字段关联。

修复方法 #

方法一：通过结构体标签直接关联命名空间 #

无需自定义UnmarshalXML，给ContactKind的Name字段指定完整的命名空间URI标签：

import "encoding/xml"

type GDName struct {
    GivenName string `xml:"gd givenName"`
}

type ContactKind struct {
    XMLName xml.Name `xml:"http://www.w3.org/2005/Atom entry"` // 匹配外层entry的命名空间
    Name    GDName   `xml:"http://schemas.google.com/g/2005 name"` // 匹配gd:name的命名空间
}

此时直接调用xml.Unmarshal即可正确解析<gd:name>内容到Name字段。

方法二：自定义UnmarshalXML时处理命名空间 #

若必须使用自定义解析逻辑，需在方法中通过元素的Space（命名空间URI）和Local（本地名称）匹配<gd:name>：

import (
    "encoding/xml"
)

type GDName struct {
    GivenName string `xml:"gd givenName"`
}

type ContactKind struct {
    Name GDName
}

func (c *ContactKind) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error {
    for {
        tok, err := d.Token()
        if err != nil {
            return err
        }

        switch elem := tok.(type) {
        case xml.StartElement:
            // 匹配gd:name对应的命名空间和本地名称
            if elem.Name.Space == "http://schemas.google.com/g/2005" && elem.Name.Local == "name" {
                var name GDName
                if err := d.DecodeElement(&name, &elem); err != nil {
                    return err
                }
                c.Name = name
            }
        case xml.EndElement:
            if elem == start.End() {
                return nil
            }
        }
    }
}

这种方式在遍历XML元素时精准匹配目标节点，完成解析后赋值给ContactKind的Name字段。

内容的提问来源于stack exchange，提问作者程柏硯