From 347c7ed150b854fbfba14d679de374960e2f928b Mon Sep 17 00:00:00 2001 From: astaxie Date: Sat, 29 Sep 2012 14:50:51 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E4=BA=86=E9=83=A8=E5=88=86?= =?UTF-8?q?=E6=95=B0=E6=8D=AE=E6=8F=8F=E8=BF=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 7.1.md | 53 ++++++++++++++++++++++++++++++++++------------------- 1 file changed, 34 insertions(+), 19 deletions(-) diff --git a/7.1.md b/7.1.md index ac8ee229..733f0e9f 100644 --- a/7.1.md +++ b/7.1.md @@ -1,9 +1,9 @@ #7.1 XML处理 -XML作为一种数据交换和信息传递的格式已经得到了普及。随着Web服务日益广泛的应用，XML在开发人员的日常工作中扮演了愈来愈重要的角色。Go语言标准包里面已经有了XML包让我们可以在各种应用中实现对XML的操纵。 +XML作为一种数据交换和信息传递的格式已经十分普及。而随着Web服务日益广泛的应用，现在XML在日常的开发工作中也扮演了愈发重要的角色。这一小节， 我们将就Go语言标准包中的XML相关处理的包进行介绍。 -本小节并不是介绍XML是什么，如果要了解XML可以参考其他文献，本小节主要是介绍如何用Go语言来解析XML以及如何输出XML。 +这个小节不会涉及XML规范相关的内容（如需了解相关知识请参考其他文献），而是介绍如何用Go语言来编解码XML文件相关的知识。 -下面我们就来看一个例子：假如你是一名系统维护员，想把所有的服务器转换为XML文件，那么我们就可以从以下基本的XML标签开始做起： +假如你是一名运维人员，你为你所管理的所有服务器生成了如下内容的xml的配置文件： @@ -17,10 +17,16 @@ XML作为一种数据交换和信息传递的格式已经得到了普及。随 -以此为基础，我们就可以添加新的元素或者修改现有的元素，例如可以分成地区和服务器编号。 +上面的XML文档描述了两个服务器的信息，包含了服务器名和服务器的IP信息，接下来的Go例子以此XML描述的信息进行操作。 ##解析XML -假如有了上面这个XML，那么我们如何来解析这个XML呢？Go的XML包可以通过`xml.Unmarshal`函数来做解析，请看下面的例子： +如何解析如上这个XML文件喃呢？ 我们可以通过xml包的`Unmarshal`函数来达到我们的目的 + + func Unmarshal(data []byte, v interface{}) error + +data接收的是XML数据流，v是需要输出的结构，定义为interface，也就是可以把XML转换为任意的格式。我们这里主要介绍struct的转换，因为struct和XML都有类似树结构的特征。 + +示例代码如下： package main @@ -46,6 +52,7 @@ XML作为一种数据交换和信息传递的格式已经得到了普及。随 func main() { file, err := os.Open("servers.xml") // For read access. + defer file.Close() if err != nil { fmt.Printf("error: %v", err) return @@ -66,7 +73,7 @@ XML作为一种数据交换和信息传递的格式已经得到了普及。随 } -我们知道XML其实就是一种树形的数据格式，这个和我们Go语言里面的struct类似，所以在Go语言里面XML都是被转换成struct结构的。如上例子输出如下数据 +XML本质上是一种树形的数据格式，而我们可以定义与之匹配的go 语言的 struct类型，然后通过xml.Unmarshal来将xml中的数据解析成对应的struct对象。如上例子输出如下数据 {{ servers} 1 [{{ server} Shanghai_VPN 127.0.0.1} {{ server} Beijing_VPN 127.0.0.2}] @@ -80,7 +87,7 @@ XML作为一种数据交换和信息传递的格式已经得到了普及。随 } -通过上面的例子我们可以看到我们调用了`xml.Unmarshal`，就可以把数据解析到strcut里面，那么他是怎么解析进去的呢？我们看到我们的struct定义后面多了一个类似注释的东西`xml:"serverName"`,这个是strcut的一个特性，这个定义叫做tag，主要是用来反射用的，当反射的时候可以读取到这个信息，XML解析利用的就是reflect包，通过反射读取到这个tag的定义，然后利用这个tag的定义和XML数据存到里面。那么struct需要怎么设置这个tag呢？ +上面的例子中，将xml文件解析成对应的strcut对象是通过`xml.Unmarshal`来完成的，这个过程是如何实现的？可以看到我们的struct定义后面多了一些类似于`xml:"serverName"`这样的内容,这个是strcut的一个特性，它们被称为 strcut tag，它们是用来辅助反射的，Go语言的反射机制，可以利用这些tag信息来将来自XML文件中的数据反射成对应的struct对象，关于反射如何利用struct tag的更多内容请参阅reflect中的相关内容。在定义struct的时候，应该如何设置 struct tag呢？ - 如果struct中一个string或者[]type类型的字段中tag定义了`",innerxml"`,那么这个字段会累计把这些原始的XML数据累计起来，如上Description定义。 - 如果strcut中有一个字段类型xml.Name，叫做XMLName，那么在解析的时候就会这个element的名字 @@ -91,12 +98,19 @@ XML作为一种数据交换和信息传递的格式已经得到了普及。随 - 如果strcut字段后面的tag定义了`",any"`，如果他的子元素在不满足其他的规则的时候就会匹配到这个字段。 - 如果strcut字段后面的tag定义了`",comments"`,这个字段一般都是[]byte或者string类型，那么在这个元素下面的注释会累积在这个字段里面。 -上面详细讲述了如何设置我们的struct的tag，只要设置对了tag，那么XML解析是非常简单的，tag和xml的element是一一对应的关系，然后多个元素我们可以利用struct的slice实现，如上例子所示。 +上上面详细讲述了如何定义struct的tag。 只要设置对了tag，那么XML解析就如上面示例般简单，tag和xml的element是一一对应的关系，如上所示，我们可以通过slice来表示多个同级元素。 ->Go解析的XML文件都要首字母大写,不然在解析的时候会比较的麻烦。那我们就规范全部用大写开头。 +>注意： 为了正确解析，go语言的xml包要求struct定义中的所有字段必须是可导出的（即首字母大写） ##输出XML -假如我们想要输出如上所示的XML文件，那么Go如何来处理呢？Go语言的XML包里面有如下两个函数来处理`Marshal`和`MarshalIndent`，这两个函数主要的区别是第二个函数会增加前缀和缩进。下面我们来看一下如何输出如上的XML： +假若我们不是要解析如上所示的XML文件，而是生成它，那么在go语言中又该如何实现呢？ xml包中提供了`Marshal`和`MarshalIndent`两个函数，来满足我们的需求。这两个函数主要的区别是第二个函数会增加前缀和缩进，函数的定义如下所示： + + func Marshal(v interface{}) ([]byte, error) + func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error) + +两个函数第一个参数是用来生成XML的结构定义类型数据，都是返回生成的XML数据流。 + +下面我们来看一下如何输出如上的XML： package main @@ -129,7 +143,7 @@ XML作为一种数据交换和信息传递的格式已经得到了普及。随 os.Stdout.Write(output) } -通过上面struct组织了xml的结构，上面的代码输出如下信息： +上面的代码输出如下信息： @@ -142,21 +156,22 @@ XML作为一种数据交换和信息传递的格式已经得到了普及。随 127.0.0.2 -和我们定义的文件的格式一模一样，通过上面的例子我们知道`xml.MarshalIndent`或者`xml.Marshal`返回的信息都是不带XML头的，XML头信息XML包里面定义了Header变量，而输出的xml格式也是根据struct的tag信息。 -XML的element名字通过如下方式获取： +和我们之前定义的文件的格式一模一样，之所以会有`os.Stdout.Write([]byte(xml.Header))` 这句代码的出现，是因为`xml.MarshalIndent`或者`xml.Marshal`输出的信息都是不带XML头的，为了生成正确的xml文件，我们使用了xml包预定义的Header变量，另外生成的xml文件的无层次结构，也是由struct tag来控制的。 + +那么生成的XML文件中的element名字是通过获取的呢？他有如下几种方式获取： - 字段名XMLName，类型xml.Name - 通过strcut的字段中定义的tag来获取 - 通过strcut的字段名用来获取 -那么里面的结构和数据是如何输出的呢？我们需要如何设置struct里面的tag信息呢？ +而那么里面的结构和数据是如何输出的呢？我们需要如何设置struct里面的tag信息呢？ - XMLName不会被输出 -- tag中含有`"-"`的不会输出 -- tag中含有`"name,attr"`，会以name作为字段作为名称被输出为这个XML元素的属性 -- tag中含有`",attr"`，会以这个struct的字段名作为名称作为XML元素的属性 -- tag中含有`",chardata"`，写为data数据 +- tag中含有`"-"`的字段不会输出 +- tag中含有`"name,attr"`，会以name作为属性名，字段值作为值输出为这个XML元素的属性，如上version字段所描述 +- tag中含有`",attr"`，会以这个struct的字段名作为属性名输出为XML元素的属性，类似上一条，只是这个name默认是字段名了。 +- tag中含有`",chardata"`，写为xml的data数据 - tag中含有`",innerxml"`，里面保存的是所有数据，而不会输出到XML - tag中含有`",comment"`，这个用来写XML的注释 - tag中含有`"omitempty"`,这是是如果该字段的值为空值那么就不会被输出到XML，空值包括：false、0、nil或者"" @@ -171,7 +186,7 @@ XML的element名字通过如下方式获取： -通过上面的介绍我们了解了如何通过Go语言的XML包来解析XML和生成XML，XML包的这个操作都是通过反射来获取struct中的tag定义，然后来操作XML的，所以struct的tag定义非常重要，上面也列举了一些如何定义这个tag，这样我们在将来用XML开发Web应用的时候就非常方便了。 +上面我们介绍了如何使用Go语言的xml包来编/解码XML文件，重要的一点是对XML的所有操作都是通过struct tag来实现的，所以学会对struct tag的运用变得非常重要，在文章中我们简要的列举了如何定义tag。更多内容请参看相应的官方资料。 ## links * [目录]()