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对象的。
而且我们在解析XMLstruct中时要遵循一些原则,在这里大致说明一下:

如果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包中提供了MarshalMarshalIndent两个函数用于输出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,输出为XMLcharacter data而不是element
tag中含有,innerxml,将会被原样输出,而不会进行常规的编码过程。
tag中含有,comment,将被当做XML注释来输出,而不会进行常规的编码过程,字段值中不能含有--字符串。
tag中含有omitempty,如果该字段的值为空值,那么该字段就不会被输出到XML
tag中含有a>b>c,那么就会循环输出三个元素,a包含bb包含c,如下:

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

输出结果如下:

<name>
          <first>Alice</first>
          <last>Bob</last>
</name>
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,657评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,662评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,143评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,732评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,837评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,036评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,126评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,868评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,315评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,641评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,773评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,859评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,584评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,676评论 2 351

推荐阅读更多精彩内容