文档章节

go-web编程之处理xml

梁援-晋
 梁援-晋
发布于 2012/11/05 21:53
字数 1723
阅读 2153
收藏 1
摘抄自astaxie的开源书籍

 build-web-application-with-golang

接下来的例子以下面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

1,用xml包的Unmarshal函数解析XML文件。

func Unmarshal(data []byte, v interface{}) error

func Unmarshal(data []byte, v interface{}) error


data是接收的xml数据流;Interface()是要输出的结构。目前只支持struct,slice,string。


package main

import (
    "encoding/xml"
    "fmt"
    "io/ioutil"
    "os"
)

type Recurlyservers struct {
    XMLName     xml.Name `xml:"servers"`   //xml:"serverName"称为 strcut tag 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.
    defer file.Close()
    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)
}


以下是输出结果:


{{ 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>
}
不过现在有一个问题,Unmarshal方法是怎么将xml的元素和strut的属性对应起来的呢?这是因为有一个优先读取流程的原因。


首先:Unmarshal方法会根据strut  tag在strut找相应的属性,如果找到就给该属性赋值;

否则:Unmarshal方法会根据元素名在strut中找相应的属性;

必须注意的是解析的时候tag、字段名、XML元素都是大小写敏感的,所以必须一一对应字段。

解析XML到struct的时候遵循如下的规则:

如果struct的字段是string或[]byte类型且它的tag含有",innerxml",Unmarshal将会将此字段所对应的元素内所有内嵌的原始xml累加到此字段上,如上面例子Description定义。最后的输出是

Shanghai_VPN127.0.0.1Beijing_VPN127.0.0.2

如果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,如果没有这样的字段存在,那么注释将会被抛弃。

额,终于把规则 写完了。虽说比较多,但是写代码时注意点就熟悉了。

输出XML

 xml包中提供了 Marshal MarshalIndent 两个函数,来满足我们的需求。这两个函数主要的区别是第二个函数会增加前缀和缩进,函数的定义如下所示:
func Marshal(v interface{}) ([]byte, error)
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error)
两个函数的第一个参数都是用来生成XML的结构定义类型数据,返回值都是XML数据流。

生成如上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)
}

之所以会有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的字段的值
  • 通过strcut中字段的tag来获取
  • 通过strcut的字段名用来获取
  • 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> 

上面我们介绍了如何使用Go语言的xml包来编/解码XML文件,重要的一点是对XML的所有操作都是通过struct tag来实现的,所以学会对struct tag的运用变得非常重要,在文章中我们简要的列举了如何定义tag。更多内容或tag定义请参看相应的官方资料。











© 著作权归作者所有

梁援-晋
粉丝 4
博文 17
码字总数 12195
作品 0
东城
高级程序员
私信 提问
加载中

评论(1)

lunar_stud
lunar_stud
你忘了很重要的一条,结构体中的字段必须是大写字母开头才可以导出。虽然是很小的一部分,但是影响很大呀
java入门学习之路

java是面向对象的编程,个人觉得记忆比较重要。 第一阶段 java基础部分 unix开发环境 熟练掌握开发中常用的操作系统linux的安装及使用:掌握文件系统、网络、用户管理方法:能熟练使用vi和v...

瑞克3号
2017/07/10
0
0
三日php之路 -- 第二,三天(php知识要点)

一、基础 (1)数组 // 数组的创建$arr = array("apple", "banana"); $arr = array("f1"=>"apple", "f2"=>"banana"); // 在php5.4之后 可以使用 $arr = [1,2,3]; // 对于数组的遍历$arr_len ......

明天以后
2014/09/29
130
0
Python的前景及应用

前景   Python在编程领域的占有率一直处于稳步上升之中,根据最新的数据,Python排名第六。前五名分别是 Java、C、PHP、C++ 和 VB. 作为一个很年轻的语言,Python的位置已经相当令人振奋了...

StreamWang
2010/04/21
3.4K
0
Servlet、Filter、Listener、Interceptor

首先,JSP/Servlet规范中定义了Servlet、Filter、Listener这三种角色,并没有定义Interceptor这个角色,Interceptor是某些MVC框架中的角色,比如Struts2中,Interceptor是用来拦截Action中的...

iphoenix
2016/09/05
51
0
SSH 网站制作之AJAX无刷新动态更新页面

  在做网页时,经常需要根据用户输入信息,进行“局部页面的刷新”也就是要使用所谓的AJAX技术。最近正好也在用,就总结一下。   1.AJAX介绍 AJAX不是一种新的编程语言,而是一种用于创建...

旭东的博客
2013/04/28
0
0

没有更多内容

加载失败,请刷新页面

加载更多

作为一个(IT)程序员!聊天没有话题?试试这十二种技巧

首先呢?我是一名程序员,经常性和同事没话题。 因为每天都会有自己的任务要做,程序员对于其他行业来说;是相对来说比较忙的。你会经常看到程序员在发呆、调试密密麻麻代码、红色报错发呆;...

小英子wep
今天
15
0
【SpringBoot】产生背景及简介

一、SpringBoot介绍 Spring Boot 是由 Pivotal 团队提供的全新框架,其设计目的是用来简化新 Spring 应用的初始搭建以及开发过程,该框架使用了特定的方式来进行配置,从而使开发人员不再需要...

zw965
今天
5
0
简述并发编程分为三个核心问题:分工、同步、互斥。

总的来说,并发编程可以总结为三个核心问题:分工、同步、互斥。 所谓分工指的是如何高效地拆解任务并分配给线程,而同步指的是线程之间如何协作,互斥则是保证同一时刻只允许一个线程访问共...

dust8080
今天
6
0
OSChina 周四乱弹 —— 当你简历注水但还是找到了工作

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @花间小酌 :#今日歌曲推荐# 分享成龙的单曲《男儿当自强》。 《男儿当自强》- 成龙 手机党少年们想听歌,请使劲儿戳(这里) @hxg2016 :刚在...

小小编辑
今天
3.3K
22
靠写代码赚钱的一些门路

作者 @mezod 译者 @josephchang10 如今,通过自己的代码去赚钱变得越来越简单,不过对很多人来说依然还是很难,因为他们不知道有哪些门路。 今天给大家分享一个精彩的 GitHub 库,这个库整理...

高级农民工
昨天
10
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部