go-web编程之处理xml

摘抄自astaxie的开源书籍

接下来的例子以下面XML描述的信息进行操作。

<?xml version="1.0" encoding="utf-8"?>

<servers version="">

    <server>

        <serverName>Shanghai_VPN</serverName>

        <serverIP>127.0.0.1</serverIP>

    </server>

    <server>

        <serverName>Beijing_VPN</serverName>

        <serverIP>127.0.0.2</serverIP>

    </server>

</servers>

解析XML

1，用xml包的Unmarshal函数解析XML文件。

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

data是接收的xml数据流；Interface（）是要输出的结构。目前只支持struct，slice，string。

package main

import (

    "encoding/xml"

    "fmt"

    "io/ioutil"

    "os"

)

type Recurlyservers struct {

    XMLName     xml.Name `xml:"servers"`   //<code>xml:"serverName"</code><span style="color:#333333;font-family:Helvetica, arial, freesans, clean, sans-serif;font-size:13.63636302947998px;line-height:20px;background-color:#FFFFFF;">称为 strcut tag</span> 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") // For read access.

    defer file.Close()

    if err != nil {

        fmt.Printf("error: %v", err)

        return

    }

    data, err := ioutil.ReadAll(file)

    if err != nil {

        fmt.Printf("error: %v", err)

        return

    }

    v := Recurlyservers{}

    err = xml.Unmarshal(data, &v)

    if err != nil {

        fmt.Printf("error: %v", err)

        return

    }

    fmt.Println(v)

}

以下是输出结果：

{{ servers} 1 [{{ server} Shanghai_VPN 127.0.0.1} {{ server} Beijing_VPN 127.0.0.2}]

<server>

    <serverName>Shanghai_VPN</serverName>

    <serverIP>127.0.0.1</serverIP>

</server>

<server>

    <serverName>Beijing_VPN</serverName>

    <serverIP>127.0.0.2</serverIP>

</server>

}

不过现在有一个问题，Unmarshal方法是怎么将xml的元素和strut的属性对应起来的呢？这是因为有一个优先读取流程的原因。

首先：Unmarshal方法会根据strut tag在strut找相应的属性，如果找到就给该属性赋值；

否则：Unmarshal方法会根据元素名在strut中找相应的属性；

必须注意的是解析的时候tag、字段名、XML元素都是大小写敏感的，所以必须一一对应字段。

解析XML到struct的时候遵循如下的规则：

如果struct的字段是string或[]byte类型且它的tag含有",innerxml"，Unmarshal将会将此字段所对应的元素内所有内嵌的原始xml累加到此字段上，如上面例子Description定义。最后的输出是

Shanghai_VPN127.0.0.1Beijing_VPN127.0.0.2

如果struct中有一个叫做XMLName，且类型为xml.Name字段，那么在解析的时候就会保存这个element的名字到该字段,如上面例子中的servers。

如果某个struct字段的tag定义中含有XML结构中element的名称，那么解析的时候就会把相应的element值赋值给该字段，如上servername和serverip定义。

如果某个struct字段的tag定义了中含有",attr"，那么解析的时候就会将该结构所对应的element的与字段同名的属性的值赋值给该字段，如上version定义。

如果某个struct字段的tag定义型如"a>b>c",则解析的时候，会将xml结构a下面的b下面的c元素的值赋值给该字段。

如果某个struct字段的tag定义了"-",那么不会为该字段解析匹配任何xml数据。

如果struct字段后面的tag定义了",any"，如果他的子元素在不满足其他的规则的时候就会匹配到这个字段。

如果某个XML元素包含一条或者多条注释，那么这些注释将被累加到第一个tag含有",comments"的字段上，这个字段的类型可能是[]byte或string,如果没有这样的字段存在，那么注释将会被抛弃。

额，终于把规则写完了。虽说比较多，但是写代码时注意点就熟悉了。

输出XML

xml包中提供了 Marshal 和 MarshalIndent 两个函数，来满足我们的需求。这两个函数主要的区别是第二个函数会增加前缀和缩进，函数的定义如下所示：

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

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

两个函数的第一个参数都是用来生成XML的结构定义类型数据，返回值都是XML数据流。

生成如上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: ""}

    v.Svs = append(v.Svs, server{"Shanghai_VPN", "127.0.0.1"})

    v.Svs = append(v.Svs, server{"Beijing_VPN", "127.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)

}

之所以会有os.Stdout.Write([]byte(xml.Header)) 这句代码的出现，是因为xml.MarshalIndent或者xml.Marshal输出的信息都是不带XML头的，为了生成正确的xml文件，我们使用了xml包预定义的Header变量。

我们看到Marshal函数接收的参数v是interface{}类型的，即它可以接受任意类型的参数，那么现在的问题是，在xml包，根据什么规则来生成相应的XML文件呢？

如果v是 array或者slice，那么输出每一个元素，类似value
如果v是指针，那么会Marshal指针指向的内容，如果指针为空，什么都不输出
如果v是interface，那么就处理interface所包含的数据
如果v是其他数据类型，就会输出这个数据类型所拥有的字段信息

生成的XML文件中的element的名字又是根据什么决定的呢？元素名按照如下优先级从struct中获取：

如果v是struct，XMLName的tag中定义的名称
类型为xml.Name的名叫XMLName的字段的值
通过strcut中字段的tag来获取
通过strcut的字段名用来获取
marshall的类型名称

我们应如何设置struct 中字段的tag信息以控制最终xml文件的生成呢？

XMLName不会被输出
tag中含有"-"的字段不会输出
tag中含有"name,attr"，会以name作为属性名，字段值作为值输出为这个XML元素的属性，如上version字段所描述
tag中含有",attr"，会以这个struct的字段名作为属性名输出为XML元素的属性，类似上一条，只是这个name默认是字段名了。
tag中含有",chardata"，输出为xml的 character data而非element。
tag中含有",innerxml"，将会被原样输出，而不会进行常规的编码过程
tag中含有",comment"，将被当作xml注释来输出，而不会进行常规的编码过程，字段值中不能含有"--"字符串
tag中含有"omitempty",如果该字段的值为空值那么该字段就不会被输出到XML，空值包括：false、0、nil指针或nil接口，任何长度为0的array, slice, map或者string
tag中含有"a>b>c"，那么就会循环输出三个元素a包含b，b包含c，例如如下代码就会输出

FirstName string   `xml:"name>first"`

LastName  string   `xml:"name>last"`

<name>

<first>Asta</first>

<last>Xie</last>

</name>

上面我们介绍了如何使用Go语言的xml包来编/解码XML文件，重要的一点是对XML的所有操作都是通过struct tag来实现的，所以学会对struct tag的运用变得非常重要，在文章中我们简要的列举了如何定义tag。更多内容或tag定义请参看相应的官方资料。