Go 博客

JSON 和 Go

Andrew Gerrand
2011 年 1 月 25 日

引言

JSON (JavaScript Object Notation) 是一种简单的数据交换格式。它的语法类似于 JavaScript 中的对象和列表。它最常用于 Web 后端与浏览器中运行的 JavaScript 程序之间的通信，但也用于许多其他地方。它的主页 json.org 对该标准提供了清晰简洁的定义。

使用 json 包，从 Go 程序读写 JSON 数据非常容易。

编码

要编码 JSON 数据，我们使用 Marshal 函数。

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

给定 Go 数据结构 Message，

type Message struct {
    Name string
    Body string
    Time int64
}

以及 Message 的一个实例

m := Message{"Alice", "Hello", 1294706395881547000}

我们可以使用 json.Marshal 编组 m 的 JSON 编码版本

b, err := json.Marshal(m)

如果一切正常，err 将是 nil，并且 b 将是一个包含此 JSON 数据的 []byte

b == []byte(`{"Name":"Alice","Body":"Hello","Time":1294706395881547000}`)

只有可以表示为有效 JSON 的数据结构才会被编码

  • JSON 对象只支持字符串作为键；要编码 Go map 类型，它必须是 map[string]T 的形式（其中 T 是 json 包支持的任何 Go 类型）。

  • 通道、复数和函数类型不能被编码。

  • 不支持循环数据结构；它们将导致 Marshal 进入无限循环。

  • 指针将被编码为它们指向的值（如果指针是 nil，则为 'null'）。

json 包只访问结构体类型的导出字段（以大写字母开头的字段）。因此，JSON 输出中只会包含结构体的导出字段。

解码

要解码 JSON 数据，我们使用 Unmarshal 函数。

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

我们首先必须创建一个用于存储解码数据的场所

var m Message

并调用 json.Unmarshal，将 JSON 数据 []byte 和指向 m 的指针传递给它

err := json.Unmarshal(b, &m)

如果 b 包含适合 m 的有效 JSON，调用后 err 将为 nil，并且来自 b 的数据将存储在结构体 m 中，就像通过赋值一样

m = Message{
    Name: "Alice",
    Body: "Hello",
    Time: 1294706395881547000,
}

Unmarshal 如何识别存储解码数据的字段？对于给定的 JSON 键 "Foo"，Unmarshal 会按偏好顺序查找目标结构体的字段，以找到

  • 具有 "Foo" 标签的导出字段（有关结构体标签的更多信息，请参阅 Go 规范），

  • 名为 "Foo" 的导出字段，或

  • 名为 "FOO" 或 "FoO" 或其他对 "Foo" 进行大小写不敏感匹配的导出字段。

当 JSON 数据的结构与 Go 类型不完全匹配时会发生什么？

b := []byte(`{"Name":"Bob","Food":"Pickle"}`)
var m Message
err := json.Unmarshal(b, &m)

Unmarshal 只会解码它在目标类型中找到的字段。在这种情况下，只会填充 m 的 Name 字段，Food 字段将被忽略。当您希望从大型 JSON blob 中仅选择少数特定字段时，此行为特别有用。这也意味着目标结构体中的任何未导出字段都不会受到 Unmarshal 的影响。

但是，如果您事先不知道 JSON 数据的结构怎么办？

使用接口处理通用 JSON

interface{}（空接口）类型描述了一个拥有零方法的接口。每个 Go 类型都至少实现了零个方法，因此满足空接口的要求。

空接口充当通用容器类型

var i interface{}
i = "a string"
i = 2011
i = 2.777

类型断言访问底层的具体类型

r := i.(float64)
fmt.Println("the circle's area", math.Pi*r*r)

或者，如果底层类型未知，则通过类型开关确定类型

switch v := i.(type) {
case int:
    fmt.Println("twice i is", v*2)
case float64:
    fmt.Println("the reciprocal of i is", 1/v)
case string:
    h := len(v) / 2
    fmt.Println("i swapped by halves is", v[h:]+v[:h])
default:
    // i isn't one of the types above
}

json 包使用 map[string]interface{} 和 []interface{} 值来存储任意 JSON 对象和数组；它会很愉快地将任何有效的 JSON blob 解组到一个普通的 interface{} 值中。默认的具体 Go 类型是

  • bool 对应 JSON 布尔值，

  • float64 对应 JSON 数字，

  • string 对应 JSON 字符串，以及

  • nil 对应 JSON null。

解码任意数据

考虑以下存储在变量 b 中的 JSON 数据

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

在不知道此数据结构的情况下，我们可以使用 Unmarshal 将其解码为一个 interface{} 值

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

此时，f 中的 Go 值将是一个 map，其键是字符串，其值本身存储为空接口值

f = map[string]interface{}{
    "Name": "Wednesday",
    "Age":  6,
    "Parents": []interface{}{
        "Gomez",
        "Morticia",
    },
}

要访问此数据，我们可以使用类型断言来访问 f 的底层 map[string]interface{}

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

然后，我们可以使用 range 语句遍历 map，并使用类型开关以它们的具体类型访问其值

for k, v := range m {
    switch vv := v.(type) {
    case string:
        fmt.Println(k, "is string", vv)
    case float64:
        fmt.Println(k, "is float64", vv)
    case []interface{}:
        fmt.Println(k, "is an array:")
        for i, u := range vv {
            fmt.Println(i, u)
        }
    default:
        fmt.Println(k, "is of a type I don't know how to handle")
    }
}

通过这种方式，您可以处理未知的 JSON 数据，同时仍然享受类型安全的优势。

引用类型

让我们定义一个 Go 类型来包含前一个示例中的数据

type FamilyMember struct {
    Name    string
    Age     int
    Parents []string
}

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

将该数据解组到 FamilyMember 值中按预期工作，但如果我们仔细观察，可以看到一件非凡的事情发生了。通过 var 语句，我们分配了一个 FamilyMember 结构体，然后将指向该值的指针提供给 Unmarshal，但在那时 Parents 字段是 nil 切片值。为了填充 Parents 字段，Unmarshal 在幕后分配了一个新的切片。这是 Unmarshal 处理支持的引用类型（指针、切片和 map）的典型方式。

考虑将数据解组到此数据结构中

type Foo struct {
    Bar *Bar
}

如果 JSON 对象中存在 Bar 字段，Unmarshal 将分配一个新的 Bar 并填充它。如果不存在，Bar 将保留为 nil 指针。

由此产生了一个有用的模式：如果您的应用程序接收几种不同的消息类型，您可以定义一个“接收者”结构体，如下所示

type IncomingMessage struct {
    Cmd *Command
    Msg *Message
}

发送方可以根据他们希望通信的消息类型填充顶级 JSON 对象的 Cmd 字段和/或 Msg 字段。Unmarshal 在将 JSON 解码到 IncomingMessage 结构体时，只会分配 JSON 数据中存在的数据结构。为了知道要处理哪些消息，程序员只需简单地测试 Cmd 或 Msg 是否不为 nil。

流式编码器和解码器

json 包提供了 Decoder 和 Encoder 类型来支持读写 JSON 数据流的常见操作。NewDecoder 和 NewEncoder 函数封装了 io.Reader 和 io.Writer 接口类型。

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

这是一个示例程序，它从标准输入读取一系列 JSON 对象，移除每个对象中除 Name 字段外的所有字段，然后将对象写入标准输出

package main

import (
    "encoding/json"
    "log"
    "os"
)

func main() {
    dec := json.NewDecoder(os.Stdin)
    enc := json.NewEncoder(os.Stdout)
    for {
        var v map[string]interface{}
        if err := dec.Decode(&v); err != nil {
            log.Println(err)
            return
        }
        for k := range v {
            if k != "Name" {
                delete(v, k)
            }
        }
        if err := enc.Encode(&v); err != nil {
            log.Println(err)
        }
    }
}

由于 Reader 和 Writer 的普遍性，这些 Encoder 和 Decoder 类型可用于广泛的场景，例如读写 HTTP 连接、WebSocket 或文件。

参考资料

更多信息请参阅 json 包文档。有关 json 的示例用法，请参阅 jsonrpc 包的源文件。

下一篇文章：Go 变得更加稳定
上一篇文章：Go 切片：用法和内部机制
博客索引

go.dev 使用来自 Google 的 cookie 来提供和改进其服务质量，并分析流量。了解详情。