go xml 解析与生成 - Go语言中文社区

go xml 解析与生成


package main

import (
    "encoding/xml"
    "fmt"
)

type assets struct {
    XMLName xml.Name `xml:"Assets"`
    Version string   `xml:"version,attr"`
    Asset   []asset  `xml:"Asset"`
}

type asset struct {
    Type string `xml:"type,attr"`
    Test []Test `xml:"Test"`
}

type Test struct {
    XMLName xml.Name `xml:"Test"`
    Person  Person   `xml:"Person"`
}

type Person struct {
    Name  string `xml:"name,attr"`
    Value string `xml:",cdata"`
}

func main() {

    var Text = `
    <Assets version="3.0.2.1">
        <Asset type="10">
            <Test>
                <Person name="appid"><![CDATA[wx0f0df4fda4ff1937]]></Person>
            </Test>
            <Test>
                <Person name="appid1"><![CDATA[wx0f0df4fda4ff19371]]></Person>
            </Test>
        </Asset>
    </Assets>
    `

    pars := &assets{}
    xml.Unmarshal([]byte(Text), &pars)
    fmt.Println("%#v", pars)

    v := &assets{Version: "3.0.2.1"}
    //ass
    for cp := 0; cp < 2; cp++ {
        var ass asset
        ass.Type = "10"

        for testNum := 0; testNum < 2; testNum++ {
            var test Test
            var person Person
            person.Name = "appid"
            person.Value = "wx0f0df4fda4ff1937"
            test.Person = person
            ass.Test = append(ass.Test, test)
        }

        v.Asset = append(v.Asset, ass)
    }

    output, err := xml.MarshalIndent(v, "  ", "    ")
    if err != nil {
        fmt.Printf("error: %vn", err)
    }
    fmt.Println(string(output))

    /*
            var Text1 = `
            <Test>
                 <Person name="appid"><![CDATA[wx0f0df4fda4ff1937]]></Person>
            </Test>
            `
            v := &Test{
                 Person: person{Value: "bbbccc", Name: "ggggg"},
            }
            output, err := xml.MarshalIndent(v, "  ", "    ")
            if err != nil {
                fmt.Printf("error: %vn", err)
            }
            fmt.Println(string(output))
            pars := &Test{}
            xml.Unmarshal([]byte(output), &pars)
            fmt.Println("%#v", pars)
    */

    /*
        w := &asset{Type: "10"}
        w.Test = append(w.Test, *v)
        output, err = xml.MarshalIndent(v, "  ", "    ")
        if err != nil {
            fmt.Printf("error: %vn", err)
        }
        fmt.Println(string(output))
    */

}

结果

%#v &{{ Assets} 3.0.2.1 [{10 [{{ Test} {appid wx0f0df4fda4ff1937}} {{ Test} {appid1 wx0f0df4fda4ff19371}}]}]}
  <Assets version="3.0.2.1">
      <Asset type="10">
          <Test>
              <Person name="appid"><![CDATA[wx0f0df4fda4ff1937]]></Person>
          </Test>
          <Test>
              <Person name="appid"><![CDATA[wx0f0df4fda4ff1937]]></Person>
          </Test>
      </Asset>
      <Asset type="10">
          <Test>
              <Person name="appid"><![CDATA[wx0f0df4fda4ff1937]]></Person>
          </Test>
          <Test>
              <Person name="appid"><![CDATA[wx0f0df4fda4ff1937]]></Person>
          </Test>
      </Asset>
  </Assets>

//Example 2
这里写图片描述

type (
    // item defines the fields associated with the item tag
    // in the rss document.
    item struct {
        XMLName     xml.Name `xml:"item"`
        PubDate     string   `xml:"pubDate"`
        Title       string   `xml:"title"`
        Description string   `xml:"description"`
        Link        string   `xml:"link"`
        GUID        string   `xml:"guid"`
        GeoRssPoint string   `xml:"georss:point"`
    }

    // image defines the fields associated with the image tag
    // in the rss document.
    image struct {
        XMLName xml.Name `xml:"image"`
        URL     string   `xml:"url"`
        Title   string   `xml:"title"`
        Link    string   `xml:"link"`
    }

    // channel defines the fields associated with the channel tag
    // in the rss document.
    channel struct {
        XMLName        xml.Name `xml:"channel"`
        Title          string   `xml:"title"`
        Description    string   `xml:"description"`
        Link           string   `xml:"link"`
        PubDate        string   `xml:"pubDate"`
        LastBuildDate  string   `xml:"lastBuildDate"`
        TTL            string   `xml:"ttl"`
        Language       string   `xml:"language"`
        ManagingEditor string   `xml:"managingEditor"`
        WebMaster      string   `xml:"webMaster"`
        Image          image    `xml:"image"`
        Item           []item   `xml:"item"`
    }

    // rssDocument defines the fields associated with the rss document.
    rssDocument struct {
        XMLName xml.Name `xml:"rss"`
        Channel channel  `xml:"channel"`
    }
)

//解析与生成规则

<?xml version="1.0" encoding="utf-8"?>
<servers version="1">
    <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文档描述了两个服务器的信息,包含了服务器名和服务器的IP信息,接下来的Go例子以此XML描述的信息进行操作。


解析XML


如何解析如上这个XML文件呢? 我们可以通过xml包的Unmarshal函数来达到我们的目的


func Unmarshal(data []byte, v interface{}) error
data接收的是XML数据流,v是需要输出的结构,定义为interface,也就是可以把XML转换为任意的格式。我们这里主要介绍struct的转换,因为struct和XML都有类似树结构的特征。


示例代码如下:


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") // For read access.     
    if err != nil {
        fmt.Printf("error: %v", err)
        return
    }
    defer file.Close()
    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)
}
XML本质上是一种树形的数据格式,而我们可以定义与之匹配的go 语言的 struct类型,然后通过xml.Unmarshal来将xml中的数据解析成对应的struct对象。如上例子输出如下数据


{{ 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>
}
上面的例子中,将xml文件解析成对应的struct对象是通过xml.Unmarshal来完成的,这个过程是如何实现的?可以看到我们的struct定义后面多了一些类似于xml:"serverName"这样的内容,这个是struct的一个特性,它们被称为 struct tag,它们是用来辅助反射的。我们来看一下Unmarshal的定义:


func Unmarshal(data []byte, v interface{}) error
我们看到函数定义了两个参数,第一个是XML数据流,第二个是存储的对应类型,目前支持structslicestringXML包内部采用了反射来进行数据的映射,所以v里面的字段必须是导出的。Unmarshal解析的时候XML元素和字段怎么对应起来的呢?这是有一个优先级读取流程的,首先会读取struct tag,如果没有,那么就会对应字段名。必须注意一点的是解析的时候tag、字段名、XML元素都是大小写敏感的,所以必须一一对应字段。


Go语言的反射机制,可以利用这些tag信息来将来自XML文件中的数据反射成对应的struct对象,关于反射如何利用struct tag的更多内容请参阅reflect中的相关内容。


解析XMLstruct的时候遵循如下的规则:


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


<server>
    <serverName>Shanghai_VPN</serverName>
    <serverIP>127.0.0.1</serverIP>
</server>
<server>
    <serverName>Beijing_VPN</serverName>
    <serverIP>127.0.0.2</serverIP>
</server>
如果struct中有一个叫做XMLName,且类型为xml.Name字段,那么在解析的时候就会保存这个element的名字到该字段,如上面例子中的servers。


如果某个struct字段的tag定义中含有XML结构中element的名称,那么解析的时候就会把相应的element值赋值给该字段,如上servernameserverip定义。
如果某个struct字段的tag定义了中含有",attr",那么解析的时候就会将该结构所对应的element的与字段同名的属性的值赋值给该字段,如上version定义。
如果某个struct字段的tag定义 型如"a>b>c",则解析的时候,会将xml结构a下面的b下面的c元素的值赋值给该字段。
如果某个struct字段的tag定义了"-",那么不会为该字段解析匹配任何xml数据。
如果struct字段后面的tag定义了",any",如果他的子元素在不满足其他的规则的时候就会匹配到这个字段。
如果某个XML元素包含一条或者多条注释,那么这些注释将被累加到第一个tag含有",comments"的字段上,这个字段的类型可能是[]bytestring,如果没有这样的字段存在,那么注释将会被抛弃。
上面详细讲述了如何定义structtag。 只要设置对了tag,那么XML解析就如上面示例般简单,tagXMLelement是一一对应的关系,如上所示,我们还可以通过slice来表示多个同级元素。


注意: 为了正确解析,go语言的xml包要求struct定义中的所有字段必须是可导出的(即首字母大写)
输出XML


假若我们不是要解析如上所示的XML文件,而是生成它,那么在go语言中又该如何实现呢? xml包中提供了MarshalMarshalIndent两个函数,来满足我们的需求。这两个函数主要的区别是第二个函数会增加前缀和缩进,函数的定义如下所示:


func Marshal(v interface{}) ([]byte, error)
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error)
两个函数第一个参数是用来生成XML的结构定义类型数据,都是返回生成的XML数据流。


下面我们来看一下如何输出如上的XMLpackage 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{"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: %vn", err)
    }
    os.Stdout.Write([]byte(xml.Header))


    os.Stdout.Write(output)
}
上面的代码输出如下信息:


<?xml version="1.0" encoding="UTF-8"?>
<servers version="1">
<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>
和我们之前定义的文件的格式一模一样,之所以会有os.Stdout.Write([]byte(xml.Header)) 这句代码的出现,是因为xml.MarshalIndent或者xml.Marshal输出的信息都是不带XML头的,为了生成正确的xml文件,我们使用了xml包预定义的Header变量。


我们看到Marshal函数接收的参数vinterface{}类型的,即它可以接受任意类型的参数,那么xml包,根据什么规则来生成相应的XML文件呢?


如果varray或者slice,那么输出每一个元素,类似value
如果v是指针,那么会Marshal指针指向的内容,如果指针为空,什么都不输出
如果vinterface,那么就处理interface所包含的数据
如果v是其他数据类型,就会输出这个数据类型所拥有的字段信息
生成的XML文件中的element的名字又是根据什么决定的呢?元素名按照如下优先级从struct中获取:


如果vstructXMLNametag中定义的名称
类型为xml.Name的名叫XMLName的字段的值
通过struct中字段的tag来获取
通过struct的字段名用来获取
marshall的类型名称
我们应如何设置struct 中字段的tag信息以控制最终xml文件的生成呢?


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


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


<name>
<first>Asta</first>
<last>Xie</last>
</name> 

版权声明:本文来源CSDN,感谢博主原创文章,遵循 CC 4.0 by-sa 版权协议,转载请附上原文出处链接和本声明。
原文链接:https://blog.csdn.net/qiuyoujie/article/details/79289181
站方申明:本站部分内容来自社区用户分享,若涉及侵权,请联系站方删除。
  • 发表于 2020-04-18 17:47:47
  • 阅读 ( 1019 )
  • 分类:Go

0 条评论

请先 登录 后评论

官方社群

GO教程

猜你喜欢