Add 0.7.1.md syntax highlighting
This commit is contained in:
27
zh/07.1.md
27
zh/07.1.md
@@ -4,6 +4,7 @@ XML作为一种数据交换和信息传递的格式已经十分普及。而随
|
||||
这个小节不会涉及XML规范相关的内容(如需了解相关知识请参考其他文献),而是介绍如何用Go语言来编解码XML文件相关的知识。
|
||||
|
||||
假如你是一名运维人员,你为你所管理的所有服务器生成了如下内容的xml的配置文件:
|
||||
```xml
|
||||
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<servers version="1">
|
||||
@@ -16,17 +17,19 @@ XML作为一种数据交换和信息传递的格式已经十分普及。而随
|
||||
<serverIP>127.0.0.2</serverIP>
|
||||
</server>
|
||||
</servers>
|
||||
|
||||
```
|
||||
上面的XML文档描述了两个服务器的信息,包含了服务器名和服务器的IP信息,接下来的Go例子以此XML描述的信息进行操作。
|
||||
|
||||
## 解析XML
|
||||
如何解析如上这个XML文件呢? 我们可以通过xml包的`Unmarshal`函数来达到我们的目的
|
||||
```Go
|
||||
|
||||
func Unmarshal(data []byte, v interface{}) error
|
||||
|
||||
```
|
||||
data接收的是XML数据流,v是需要输出的结构,定义为interface,也就是可以把XML转换为任意的格式。我们这里主要介绍struct的转换,因为struct和XML都有类似树结构的特征。
|
||||
|
||||
示例代码如下:
|
||||
```Go
|
||||
|
||||
package main
|
||||
|
||||
@@ -72,8 +75,9 @@ data接收的是XML数据流,v是需要输出的结构,定义为interface,
|
||||
fmt.Println(v)
|
||||
}
|
||||
|
||||
|
||||
```
|
||||
XML本质上是一种树形的数据格式,而我们可以定义与之匹配的go 语言的 struct类型,然后通过xml.Unmarshal来将xml中的数据解析成对应的struct对象。如上例子输出如下数据
|
||||
```xml
|
||||
|
||||
{{ servers} 1 [{{ server} Shanghai_VPN 127.0.0.1} {{ server} Beijing_VPN 127.0.0.2}]
|
||||
<server>
|
||||
@@ -86,11 +90,12 @@ XML本质上是一种树形的数据格式,而我们可以定义与之匹配
|
||||
</server>
|
||||
}
|
||||
|
||||
|
||||
```
|
||||
上面的例子中,将xml文件解析成对应的struct对象是通过`xml.Unmarshal`来完成的,这个过程是如何实现的?可以看到我们的struct定义后面多了一些类似于`xml:"serverName"`这样的内容,这个是struct的一个特性,它们被称为 struct tag,它们是用来辅助反射的。我们来看一下`Unmarshal`的定义:
|
||||
```Go
|
||||
|
||||
func Unmarshal(data []byte, v interface{}) error
|
||||
|
||||
```
|
||||
我们看到函数定义了两个参数,第一个是XML数据流,第二个是存储的对应类型,目前支持struct、slice和string,XML包内部采用了反射来进行数据的映射,所以v里面的字段必须是导出的。`Unmarshal`解析的时候XML元素和字段怎么对应起来的呢?这是有一个优先级读取流程的,首先会读取struct tag,如果没有,那么就会对应字段名。必须注意一点的是解析的时候tag、字段名、XML元素都是大小写敏感的,所以必须一一对应字段。
|
||||
|
||||
Go语言的反射机制,可以利用这些tag信息来将来自XML文件中的数据反射成对应的struct对象,关于反射如何利用struct tag的更多内容请参阅reflect中的相关内容。
|
||||
@@ -99,6 +104,8 @@ Go语言的反射机制,可以利用这些tag信息来将来自XML文件中的
|
||||
|
||||
- 如果struct的一个字段是string或者[]byte类型且它的tag含有`",innerxml"`,Unmarshal将会将此字段所对应的元素内所有内嵌的原始xml累加到此字段上,如上面例子Description定义。最后的输出是
|
||||
|
||||
```xml
|
||||
|
||||
<server>
|
||||
<serverName>Shanghai_VPN</serverName>
|
||||
<serverIP>127.0.0.1</serverIP>
|
||||
@@ -108,6 +115,8 @@ Go语言的反射机制,可以利用这些tag信息来将来自XML文件中的
|
||||
<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定义。
|
||||
@@ -129,6 +138,7 @@ Go语言的反射机制,可以利用这些tag信息来将来自XML文件中的
|
||||
两个函数第一个参数是用来生成XML的结构定义类型数据,都是返回生成的XML数据流。
|
||||
|
||||
下面我们来看一下如何输出如上的XML:
|
||||
```Go
|
||||
|
||||
package main
|
||||
|
||||
@@ -161,7 +171,10 @@ Go语言的反射机制,可以利用这些tag信息来将来自XML文件中的
|
||||
|
||||
os.Stdout.Write(output)
|
||||
}
|
||||
|
||||
```
|
||||
上面的代码输出如下信息:
|
||||
```xml
|
||||
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<servers version="1">
|
||||
@@ -175,6 +188,7 @@ Go语言的反射机制,可以利用这些tag信息来将来自XML文件中的
|
||||
</server>
|
||||
</servers>
|
||||
|
||||
```
|
||||
和我们之前定义的文件的格式一模一样,之所以会有`os.Stdout.Write([]byte(xml.Header))` 这句代码的出现,是因为`xml.MarshalIndent`或者`xml.Marshal`输出的信息都是不带XML头的,为了生成正确的xml文件,我们使用了xml包预定义的Header变量。
|
||||
|
||||
我们看到`Marshal`函数接收的参数v是interface{}类型的,即它可以接受任意类型的参数,那么xml包,根据什么规则来生成相应的XML文件呢?
|
||||
@@ -204,6 +218,7 @@ Go语言的反射机制,可以利用这些tag信息来将来自XML文件中的
|
||||
- tag中含有`"omitempty"`,如果该字段的值为空值那么该字段就不会被输出到XML,空值包括:false、0、nil指针或nil接口,任何长度为0的array, slice, map或者string
|
||||
- tag中含有`"a>b>c"`,那么就会循环输出三个元素a包含b,b包含c,例如如下代码就会输出
|
||||
|
||||
```xml
|
||||
FirstName string `xml:"name>first"`
|
||||
LastName string `xml:"name>last"`
|
||||
|
||||
@@ -212,7 +227,7 @@ Go语言的反射机制,可以利用这些tag信息来将来自XML文件中的
|
||||
<last>Xie</last>
|
||||
</name>
|
||||
|
||||
|
||||
```
|
||||
上面我们介绍了如何使用Go语言的xml包来编/解码XML文件,重要的一点是对XML的所有操作都是通过struct tag来实现的,所以学会对struct tag的运用变得非常重要,在文章中我们简要的列举了如何定义tag。更多内容或tag定义请参看相应的官方资料。
|
||||
|
||||
## links
|
||||
|
||||
Reference in New Issue
Block a user