Go语言XML反序列化无法获取节点名称的问题排查与解决

问题场景 #

现有athletes.xml文件内容如下：

<athletes>
  <boxer>
    <name>John</name>
  </boxer>
  <boxer>
    <name>Sam</name>
  </boxer>
  <gymnast>
    <name>Jessica</name>
  </gymnast>
</athletes>

编写Go代码尝试反序列化并打印每位运动员的类型和姓名，但Type字段始终输出为空：

package main

import (
        "encoding/xml"
        "fmt"
        "io/ioutil"
        "os"
)

type Athlete struct {
        Type string `xml:"-"`
        // Type xml.Name `xml:",any"` // also tried this
        Name string `xml:"name"`
}

type AthletesWrapper struct {
        XMLName  xml.Name   `xml:"athletes"`
        Athletes []Athlete `xml:",any"`
}

func main() {
        xmlFile, _ := os.Open("athletes.xml")
        defer xmlFile.Close()

        xmlContent, _ := ioutil.ReadAll(xmlFile)

        var athletesWrapper AthletesWrapper

        _ = xml.Unmarshal(xmlContent, &athletesWrapper)

        fmt.Println("Parent Node Name: ", athletesWrapper.XMLName)
        for _, athlete := range athletesWrapper.Athletes {
                fmt.Println("Type: ", athlete.Type)
                fmt.Println("Name: ", athlete.Name)
        }
}

错误原因 #

1. Type string \xml:"-"`` 中的xml:"-"标签会告诉Go的XML反序列化器忽略该字段，自然无法填充任何值。
2. 尝试的Type xml.Name \xml:",any"`写法也不正确，xml:",any"标签的作用是捕获任意未匹配的XML元素，而非绑定节点名称。

修正方案 #

要获取每个运动员节点的类型（boxer/gymnast），需要利用xml.Name类型捕获节点名称，同时正确使用xml:",any"标签：

修正后的代码 #

package main

import (
        "encoding/xml"
        "fmt"
        "io/ioutil"
        "os"
)

type Athlete struct {
        XMLName xml.Name `xml:",any"` // 捕获当前节点的名称
        Name    string   `xml:"name"`
}

type AthletesWrapper struct {
        XMLName  xml.Name   `xml:"athletes"`
        Athletes []Athlete `xml:",any"` // 匹配所有子节点
}

func main() {
        xmlFile, err := os.Open("athletes.xml")
        if err != nil {
                fmt.Printf("打开文件失败: %v\n", err)
                return
        }
        defer xmlFile.Close()

        xmlContent, err := ioutil.ReadAll(xmlFile)
        if err != nil {
                fmt.Printf("读取文件失败: %v\n", err)
                return
        }

        var athletesWrapper AthletesWrapper
        err = xml.Unmarshal(xmlContent, &athletesWrapper)
        if err != nil {
                fmt.Printf("反序列化失败: %v\n", err)
                return
        }

        fmt.Println("Parent Node Name: ", athletesWrapper.XMLName.Local)
        for _, athlete := range athletesWrapper.Athletes {
                fmt.Println("Type: ", athlete.XMLName.Local) // 取节点的本地名称作为类型
                fmt.Println("Name: ", athlete.Name)
        }
}

关键说明 #

• Athlete结构体中的XMLName字段会被自动填充为对应XML节点的名称（如boxer、gymnast），通过XMLName.Local可获取节点的本地名称。
• xml:",any"标签用于Athletes切片时，会将所有未被显式匹配的子节点（即<boxer>和<gymnast>）反序列化为Athlete实例。
• 补充了错误处理代码，避免忽略潜在的文件操作、反序列化错误。

输出结果 #

运行修正后的代码，会得到如下输出：

Parent Node Name:  athletes
Type:  boxer
Name:  John
Type:  boxer
Name:  Sam
Type:  gymnast
Name:  Jessica

内容的提问来源于stack exchange，提问作者learningtech