12.9 JSON 数据格式

数据结构要在网络中传输或保存到文件,就必须对其编码和解码;目前存在很多编码格式:JSON,XML,gob,Google 缓冲协议等等。Go 语言支持所有这些编码格式;在后面的章节,我们将讨论前三种格式。

结构可能包含二进制数据,如果将其作为文本打印,那么可读性是很差的。另外结构内部可能包含匿名字段,而不清楚数据的用意。

通过把数据转换成纯文本,使用命名的字段来标注,让其具有可读性。这样的数据格式可以通过网络传输,而且是与平台无关的,任何类型的应用都能够读取和输出,不与操作系统和编程语言的类型相关。

下面是一些术语说明:

  • 数据结构 —> 指定格式 = 序列化编码(传输之前)
  • 指定格式 —> 数据结构 = 反序列化解码(传输之后)

序列化是在内存中把数据转换成指定格式(数据 -> 字符串),反之亦然(字符串 -> 数据)。

编码也是一样的,只是输出一个数据流(实现了 io.Writer 接口);解码是从一个数据流(实现了 io.Reader)输出到一个数据结构。

我们都比较熟悉 XML 格式(参阅 12.10);但有些时候 JSON(JavaScript Object Notation,参阅 http://json.org)被作为首选,主要是由于其格式上非常简洁。通常 JSON 被用于 web 后端和浏览器之间的通讯,但是在其它场景也同样的有用。

这是一个简短的 JSON 片段:

  1. {
  2. "Person": {
  3. "FirstName": "Laura",
  4. "LastName": "Lynn"
  5. }
  6. }

尽管 XML 被广泛的应用,但是 JSON 更加简洁、轻量(占用更少的内存、磁盘及网络带宽)和更好的可读性,这也使它越来越受欢迎。

Go 语言的 json 包可以让你在程序中方便的读取和写入 JSON 数据。

我们将在下面的例子里使用 json 包,并使用练习 10.1 vcard.go 中一个简化版本的 AddressVCard 结构(为了简单起见,我们忽略了很多错误处理,不过在实际应用中你必须要合理的处理这些错误,参阅 13 章)。

示例 12.16 json.go

  1. // json.go
  2. package main
  3. import (
  4. "encoding/json"
  5. "fmt"
  6. "log"
  7. "os"
  8. )
  9. type Address struct {
  10. Type string
  11. City string
  12. Country string
  13. }
  14. type VCard struct {
  15. FirstName string
  16. LastName string
  17. Addresses []*Address
  18. Remark string
  19. }
  20. func main() {
  21. pa := &Address{"private", "Aartselaar", "Belgium"}
  22. wa := &Address{"work", "Boom", "Belgium"}
  23. vc := VCard{"Jan", "Kersschot", []*Address{pa, wa}, "none"}
  24. // fmt.Printf("%v: \n", vc) // {Jan Kersschot [0x126d2b80 0x126d2be0] none}:
  25. // JSON format:
  26. js, _ := json.Marshal(vc)
  27. fmt.Printf("JSON format: %s", js)
  28. // using an encoder:
  29. file, _ := os.OpenFile("vcard.json", os.O_CREATE|os.O_WRONLY, 0666)
  30. defer file.Close()
  31. enc := json.NewEncoder(file)
  32. err := enc.Encode(vc)
  33. if err != nil {
  34. log.Println("Error in encoding json")
  35. }
  36. }

json.Marshal() 的函数签名是 func Marshal(v interface{}) ([]byte, error),下面是数据编码后的 JSON 文本(实际上是一个 []byte):

  1. {
  2. "FirstName": "Jan",
  3. "LastName": "Kersschot",
  4. "Addresses": [{
  5. "Type": "private",
  6. "City": "Aartselaar",
  7. "Country": "Belgium"
  8. }, {
  9. "Type": "work",
  10. "City": "Boom",
  11. "Country": "Belgium"
  12. }],
  13. "Remark": "none"
  14. }

出于安全考虑,在 web 应用中最好使用 json.MarshalforHTML() 函数,其对数据执行 HTML 转码,所以文本可以被安全地嵌在 HTML <script> 标签中。

json.NewEncoder() 的函数签名是 func NewEncoder(w io.Writer) *Encoder,返回的 Encoder 类型的指针可调用方法 Encode(v interface{}),将数据对象 v 的 json 编码写入 io.Writer w 中。

JSON 与 Go 类型对应如下:

  • bool 对应 JSON 的 boolean
  • float64 对应 JSON 的 number
  • string 对应 JSON 的 string
  • nil 对应 JSON 的 null

不是所有的数据都可以编码为 JSON 类型,只有验证通过的数据结构才能被编码:

  • JSON 对象只支持字符串类型的 key;要编码一个 Go map 类型,map 必须是 map[string]TTjson 包中支持的任何类型)
  • Channel,复杂类型和函数类型不能被编码
  • 不支持循环数据结构;它将引起序列化进入一个无限循环
  • 指针可以被编码,实际上是对指针指向的值进行编码(或者指针是 nil

反序列化:

json.Unmarshal() 的函数签名是 func Unmarshal(data []byte, v interface{}) error 把 JSON 解码为数据结构。

示例 12.16 中对 vc 编码后的数据为 js ,对其解码时,我们首先创建结构 VCard 用来保存解码的数据:var v VCard 并调用 json.Unmarshal(js, &v),解析 []byte 中的 JSON 数据并将结果存入指针 &v 指向的值。

虽然反射能够让 JSON 字段去尝试匹配目标结构字段;但是只有真正匹配上的字段才会填充数据。字段没有匹配不会报错,而是直接忽略掉。

(练习 15.2b twitter_status_json.go 中用到了 Unmarshal()

解码任意的数据:

json 包使用 map[string]interface{}[]interface{} 储存任意的 JSON 对象和数组;其可以被反序列化为任何的 JSON blob 存储到接口值中。

来看这个 JSON 数据,被存储在变量 b 中:

  1. b := []byte(`{"Name": "Wednesday", "Age": 6, "Parents": ["Gomez", "Morticia"]}`)

不用理解这个数据的结构,我们可以直接使用 Unmarshal() 把这个数据编码并保存在接口值中:

  1. var f interface{}
  2. err := json.Unmarshal(b, &f)

f 指向的值是一个 map,key 是一个字符串,value 是自身存储作为空接口类型的值:

  1. map[string]interface{} {
  2. "Name": "Wednesday",
  3. "Age": 6,
  4. "Parents": []interface{} {
  5. "Gomez",
  6. "Morticia",
  7. },
  8. }

要访问这个数据,我们可以使用类型断言

  1. m := f.(map[string]interface{})

我们可以通过 for range 语法和 type switch 来访问其实际类型:

  1. for k, v := range m {
  2. switch vv := v.(type) {
  3. case string:
  4. fmt.Println(k, "is string", vv)
  5. case int:
  6. fmt.Println(k, "is int", vv)
  7. case []interface{}:
  8. fmt.Println(k, "is an array:")
  9. for i, u := range vv {
  10. fmt.Println(i, u)
  11. }
  12. default:
  13. fmt.Println(k, "is of a type I don’t know how to handle")
  14. }
  15. }

通过这种方式,你可以处理未知的 JSON 数据,同时可以确保类型安全。

解码数据到结构

如果我们事先知道 JSON 数据,我们可以定义一个适当的结构并对 JSON 数据反序列化。下面的例子中,我们将定义:

  1. type FamilyMember struct {
  2. Name string
  3. Age int
  4. Parents []string
  5. }

并对其反序列化:

  1. var m FamilyMember
  2. err := json.Unmarshal(b, &m)

程序实际上是分配了一个新的切片。这是一个典型的反序列化引用类型(指针、切片和 map)的例子。

编码和解码流

json 包提供 DecoderEncoder 类型来支持常用 JSON 数据流读写。NewDecoder()NewEncoder() 函数分别封装了 io.Readerio.Writer 接口。

  1. func NewDecoder(r io.Reader) *Decoder
  2. func NewEncoder(w io.Writer) *Encoder

要想把 JSON 直接写入文件,可以使用 json.NewEncoder 初始化文件(或者任何实现 io.Writer 的类型),并调用 Encode();反过来与其对应的是使用 json.NewDecoderDecode() 函数:

  1. func NewDecoder(r io.Reader) *Decoder
  2. func (dec *Decoder) Decode(v interface{}) error

来看下接口是如何对实现进行抽象的:数据结构可以是任何类型,只要其实现了某种接口,目标或源数据要能够被编码就必须实现 io.Writerio.Reader 接口。由于 Go 语言中到处都实现了 Reader 和 Writer,因此 EncoderDecoder 可被应用的场景非常广泛,例如读取或写入 HTTP 连接、websockets 或文件。

链接