Files
build-web-application-with-…/7.1.md
2012-09-29 00:05:47 +08:00

7.7 KiB
Raw Blame History

#7.1 XML处理 XML作为一种数据交换和信息传递的格式已经得到了普及。随着Web服务日益广泛的应用XML在开发人员的日常工作中扮演了愈来愈重要的角色。Go语言标准包里面已经有了XML包让我们可以在各种应用中实现对XML的操纵。

本小节并不是介绍XML是什么如果要了解XML可以参考其他文献本小节主要是介绍如何用Go语言来解析XML以及如何输出XML。

下面我们就来看一个例子假如你是一名系统维护员想把所有的服务器转换为XML文件那么我们就可以从以下基本的XML标签开始做起

<?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 假如有了上面这个XML那么我们如何来解析这个XML呢Go的XML包可以通过xml.Unmarshal函数来做解析,请看下面的例子:

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
	}
	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类似所以在Go语言里面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.Unmarshal就可以把数据解析到strcut里面那么他是怎么解析进去的呢我们看到我们的struct定义后面多了一个类似注释的东西xml:"serverName",这个是strcut的一个特性这个定义叫做tag主要是用来反射用的当反射的时候可以读取到这个信息XML解析利用的就是reflect包通过反射读取到这个tag的定义然后利用这个tag的定义和XML数据存到里面。那么struct需要怎么设置这个tag呢

  • 如果struct中一个string或者[]type类型的字段中tag定义了",innerxml",那么这个字段会累计把这些原始的XML数据累计起来如上Description定义。
  • 如果strcut中有一个字段类型xml.Name叫做XMLName那么在解析的时候就会这个element的名字
  • 如果strcut里面字段后面的tag里面定义了XML的element那么解析的时候就会把相应的element值赋值给struct字段如上servername和serverip定义。
  • 如果strcut里面字段后面的tag定义了",attr"那么会读取该element下面的属性字段如上version定义。
  • 如果strcut字段后面的tag定义了"a>b>c",那么会解析xml元素的结构a下面的b下面的c元素。
  • 如果strcut字段后面的tag定义了"-",那么这个字段不会被解析到任何数据。
  • 如果strcut字段后面的tag定义了",any",如果他的子元素在不满足其他的规则的时候就会匹配到这个字段。
  • 如果strcut字段后面的tag定义了",comments",这个字段一般都是[]byte或者string类型那么在这个元素下面的注释会累积在这个字段里面。

上面详细讲述了如何设置我们的struct的tag只要设置对了tag那么XML解析是非常简单的tag和xml的element是一一对应的关系然后多个元素我们可以利用struct的slice实现如上例子所示。

Go解析的XML文件都要首字母大写,不然在解析的时候会比较的麻烦。那我们就规范全部用大写开头。

##输出XML 假如我们想要输出如上所示的XML文件那么Go如何来处理呢Go语言的XML包里面有如下两个函数来处理MarshalMarshalIndent这两个函数主要的区别是第二个函数会增加前缀和缩进。下面我们来看一下如何输出如上的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{"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)
}

通过上面struct组织了xml的结构上面的代码输出如下信息

<?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.MarshalIndent或者xml.Marshal返回的信息都是不带XML头的XML头信息XML包里面定义了Header变量而输出的xml格式也是根据struct的tag信息。

XML的element名字通过如下方式获取

  • 字段名XMLName类型xml.Name
  • 通过strcut的字段中定义的tag来获取
  • 通过strcut的字段名用来获取

那么里面的结构和数据是如何输出的呢我们需要如何设置struct里面的tag信息呢

  • XMLName不会被输出

  • tag中含有"-"的不会输出

  • tag中含有"name,attr"会以name作为字段作为名称被输出为这个XML元素的属性

  • tag中含有",attr"会以这个struct的字段名作为名称作为XML元素的属性

  • tag中含有",chardata"写为data数据

  • tag中含有",innerxml"里面保存的是所有数据而不会输出到XML

  • tag中含有",comment"这个用来写XML的注释

  • tag中含有"omitempty",这是是如果该字段的值为空值那么就不会被输出到XML空值包括false、0、nil或者""

  • 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>	
    

通过上面的介绍我们了解了如何通过Go语言的XML包来解析XML和生成XMLXML包的这个操作都是通过反射来获取struct中的tag定义然后来操作XML的所以struct的tag定义非常重要上面也列举了一些如何定义这个tag这样我们在将来用XML开发Web应用的时候就非常方便了。

LastModified

  • Id