介绍
XML 应用于 web 开发的许多方面,常用于简化数据的存储和共享。
什么是 XML?
- XML 指可扩展标记语言(EXtensible Markup Language)
- XML 是一种标记语言,很类似 HTML
- XML的设计宗旨是传输数据,而非显示数据
- XML 标签没有被预定义。您需要自行定义标签。
- XML 被设计为具有自我描述性。
- XML 是 W3C 的推荐标准
看如下的 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 用到了 Go 的 encoding/xml
包,可用该包的Unmarshal函数来达到目的:
func Unmarshal(data []byte, v interface{}) error
data 接收的是 XML 数据流,v 是需要输出的结构,定义为 interface,也就是可以把 XML 转换为任意的格式。这里主要介绍 struct 的转换,因为 struct 和 XML 都有类似树结构的特征。
示例代码如下:
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 数据流,第二个是存储的对应类型,目前支持struct、slice和string,XML 包内部采用了反射来进行数据的映射,所以 v 里面的字段必须是导出的。Unmarshal 解析的时候 XML 元素和字段的对应是有一个优先级读取流程的,首先会读取 struct tag,如果没有,那么就会对应字段名。必须注意一点的是解析的时候 tag、字段名、XML 元素都是大小写敏感的,所以必须一一对应字段。
Go 语言的反射机制,可以利用这些 tag 信息来将来自 XML 文件中的数据反射成对应的 struct对象。
解析 XML 到 struct 的时候遵循如下的规则:
- 如果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值赋值给该字段,如上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,如果没有这样的字段存在,那么注释将会被抛弃。
上面详细讲述了如何定义 struct 的 tag。 只要设置对了tag,那么XML解析就如上面示例般简单,tag和XML的element是一一对应的关系,如上所示,还可以通过slice来表示多个同级元素。
注意: 为了正确解析,go语言的xml包要求struct定义中的所有字段必须是可导出的(即首字母大写)
输出 XML
生成所示的 XML 文件,xml 包中提供了 Marshal 和 MarshalIndent 两个函数,来满足需求。这两个函数主要的区别是第二个函数会增加前缀和缩进,函数的定义如下所示:
func Marshal(v interface{}) ([]byte, error)
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error)
两个函数第一个参数是用来生成XML的结构定义类型数据,都是返回生成的XML数据流。
下面来看一下如何输出如上的XML:
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)
}
输出为:
<?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函数接收的参数v是interface{}类型的,即它可以接受任意类型的参数,那么xml包,根据什么规则来生成相应的XML文件呢?
- 如果v是 array或者slice,那么输出每一个元素,类似value
- 如果v是指针,那么会Marshal指针指向的内容,如果指针为空,什么都不输出
- 如果v是interface,那么就处理interface所包含的数据
- 如果v是其他数据类型,就会输出这个数据类型所拥有的字段信息
生成的XML文件中的element的名字又是根据什么决定的呢?元素名按照如下优先级从struct中获取:
- 如果v是struct,XMLName的tag中定义的名称
- 类型为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",输出为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>
参考
https://github.com/astaxie/build-web-application-with-golang/blob/master/zh
http://www.w3school.com.cn/xml/xml_usedfor.asp