Go语言中的XML处理

XML文件想必大家应该都不陌生吧，现在XML在日常的开发工作中也扮演了愈发重要的角色。接下来我们就一起来看看Go语言是如何对XML文件进行操作的吧。

解析XML

我们可以通过xml包中的Unmarshal函数来解析XML文件。

func Unmarshal(data []byte, v interface{}) error

第一个参数接收的是XML数据流，v则是需要输出的结构，因为我们发现v的类型是interface{}，因此说明XML是可以转换为任意格式的，我们先来看一下他是如何转化为struct格式的：

package main

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

type Recurlyservers struct {
    XMLName xml.Name `xml:"servers"`
    Version string `xml:"version,attr"`
    Svs []server `xml:"server"`
    Description string `xml:",innerxml"`
}

type server struct {
    XMLName xml.Name `xml:"server"`
    ServerName string `xml:"serverName"`
    ServerIP string `xml:"serverIP"`
}

func main() {
    file, err := os.Open("servers.xml")
    CheckError(err)
    defer file.Close()
    data, err := ioutil.ReadAll(file)
    CheckError(err)
    v := Recurlyservers{}
    err = xml.Unmarshal(data, &v)
    CheckError(err)
    fmt.Println(v)
}

func CheckError(err error) {
    if err != nil {
        fmt.Printf("error: %v", err)
        return
    }
}

我们可以在struct中看到后面有类似于xml:"serverName"的内容，这个被称为struct tag，是用来辅助反射的，一开始我们说了Unmarshal的定义，接下来我们详细的说一下：第一个参数是XML的数据流，这里就不再多说了，第二个是存储的对应类型，目前支持的有struct,slice,string三种，xml包中采用了反射进行数据的映射，因此v里面的字段是必须要导出的。
Go语言中的反射机制，是可以利用这些struct tag信息将XML文件中的数据反射成对应的struct对象的。
而且我们在解析XML到struct中时要遵循一些原则，在这里大致说明一下：

如果struct中的一个字段是string或者[]byte类型且它的tag含有",innerxml"，Unmearshal会将此字段所对应的元素内所有内嵌的原始XML累加到此字段上。
如果struct中有一个叫做XLMName,且类型为xml.Name的字段，那么在解析的时候就会保存这个element的名字到该字段。
如果某个struct字段的tag定义中含有XML结构中element的名称，那么解析的时候就会把相应的element值赋给该字段。
如果某个struct字段的tag中定义了",attr"，那么解析的时候就会将该结构所对应的element的与字段同名的属性的值赋给该字段。
如果某个struct字段的tag定了了"-"，那么不会为该字段解析匹配任何XML数据。
如果某个struct字段的tag定义了形如"a>b>c",则解析的时候，会将XML结构a下面的b下面的c元素的值赋给该字段。
如果struct字段后面的tag定义了",any"，如果它的子元素在不满足其他规则的时候就会匹配到这个字段。

最后还有一个要注意的小点，就是Go语言的xml包要求struct定义中的所有字段必须是可以导出的，因此我们在定义的时候一定要保证首字母的大写。

---

生成XML

xml包中提供了Marshal和MarshalIndent两个函数用于输出XML，这两个函数的主要区别是第二个函数会增加前缀和缩进：

func Marshal(v interface{}) ([]byte, error)
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error)

我们来一起看一下是如何生成XML的：

package main

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

type Servers struct {
    XMLName xml.Name `xml:"servers"`
    Version string `xml:"version,attr"`
    Svs []server `xml:"server"`
}

type server struct {
    ServerName string `xml:"serverName"`
    ServerIP string `xml:"serverIP"`
}

func main() {
    v := &Servers{Version: "1"}
    v.Svs = append(v.Svs, server{"Local_Web", "172.0.0.1"})
    v.Svs = append(v.Svs, server{"Local_DB", "172.0.0.2"})
    output, err := xml.MarshalIndent(v, " ", "  ")
    if err != nil {
        fmt.Printf("error: %v\n", err)
    }
    os.Stdout.Write([]byte(xml.Header))

    os.Stdout.Write(output)
}
/**The result is:
<?xml version="1.0" encoding="UTF-8"?>
 <servers version="1">
    <server>
        <serverName>Local_Web</serverName>
        <serverIP>172.0.0.1</serverIP>
    </server>
    <server>
        <serverName>Local_DB</serverName>
        <serverIP>172.0.0.2</serverIP>
    </server>
 </servers>
 */

为什么会出现os.Stdout.Write([]byte(xml.Header))这行代码呢，因为我们无论我们使用的xml.Marshal还是xml.MarshalIndent函数来说，他们输出的信息都是不带XML头的，因此我们使用了xml包生成了预定义的Header变量。和前面的解析XML一样，我们在使用tag控制最终XML文件生成的规则有以下几条：

XMLName不会被输出。
tag中含有-的字段不会被输出。
tag中含有,attr，会以这个struct的字段名作为属性名输出为XML元素的属性。
tag中含有,chardata，输出为XML的character data而不是element。
tag中含有,innerxml，将会被原样输出，而不会进行常规的编码过程。
tag中含有,comment，将被当做XML注释来输出，而不会进行常规的编码过程，字段值中不能含有--字符串。
tag中含有omitempty，如果该字段的值为空值，那么该字段就不会被输出到XML。
tag中含有a>b>c，那么就会循环输出三个元素，a包含b，b包含c，如下：

FirstName string `xml:"name>first“`
LastName string `xml:"name>last"`

输出结果如下：

<name>
          <first>Alice</first>
          <last>Bob</last>
</name>