Go:使用json时的陷阱

本文是关于使用Go的encoding/json包时需要注意的一些会让人迷惑的内容。如果您仔细地阅读官方包文档,就会发现其中有许多内容都提到了,所以从理论上讲,这些内容应该不会让您感到惊讶。但其中有一些根本没有在文档中提到,或者至少没有明确指出-值得注意!

1、json序列化map的内容是按照字母排序的

当将一个map编码为json,其内容将根据键值以字母顺序排列,例如:

func main() {
    m := map[string]int{
        "z": 123,
        "0": 123,
        "a": 123,
        "_": 123,
    }
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

结果:

{"0":123,"_":123,"a":123,"z":123}

2、byte切片将编码为base64字符串

当将任何[]byte切片编码为JSON时,它们将被转换为base64编码的字符串。base64字符串使用填充和标准编码字符,如RFC4648中定义的那样。例如,下面的map:

func main() {
    m := map[string][]byte{
        "foo": []byte("bar baz"),
    }
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

结果为:

{"foo":"YmFyIGJheg=="}

3、Nil和空切片编码结果不一样

Go中的空切片将被编码为null JSON值。相反,空的(但不是nil的)切片将被编码为空JSON数组。例如:

func main() {
    var nilSlice []string
    emptySlice := []string{}

    m := map[string][]string{
        "nilSlice":   nilSlice,
        "emptySlice": emptySlice,
    }
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

编码结果:

{"emptySlice":[],"nilSlice":null}

4、整数、time.Time和net.IP值可以作为map的key

map以整数值为key可以被序列化为json。这些整数将被自动转换为JSON中的字符串(因为JSON对象中的键必须总是字符串)。例如:

func main() {
    m := map[int]string{
        123: "foo",
        456_000: "bar",
    }
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

输出结果:

{"123":"foo","456000":"bar"}

此外,Go还允许实现了encoding.TextMarshaler接口的键对map序列化。这意味着你可以直接使用time.Time和net.IP值作为map的key。例如:

func main() {
    t1 := time.Now()
    t2 := t1.Add(24 * time.Hour)

    m := map[time.Time]string{
        t1: "foo",
        t2: "bar",
    }
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

输出结果:

{"2021-09-19T07:26:03.938939+08:00":"foo","2021-09-20T07:26:03.938939+08:00":"bar"}

注意,如果使用其他类型作为map的键进行编码将会得到一个json.UnsupportedTypeError错误。

5、字符串中的尖括号和&符号被转义

如果一个字符串包含尖括号<>,在JSON中将转义为\u003c和\u003e。同样,&字符将转义为\u0026。这是为了防止某些web浏览器不小心将JSON解释为HTML。例如:

func main() {
    m := []string{
        "<foo>",
        "bar & baz",
    }
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

输出结果:

["\u003cfoo\u003e","bar \u0026 baz"]

如果你需要将特殊符号保持原来格式编码,可以使用json.Encoder对象并调用setEscapeHTML(false)即可。

6、浮点数末尾零被删除

当编码一个以0结尾的小数部分的浮点数时,JSON中不会出现任何尾随的0。例如:

func main() {
    m := []float64{
        123.0,
        456.100,
        789.990,
    }
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

输出结果:

[123,456.1,789.99]

6、使用omitempty在结构体类型时会失效。

omitempty指令从不认为struct类型是空的-即使所有的struct字段都有零值,并且在这些字段上使用了omitempty。它将始终以JSON中的对象形式出现。例如:

func main() {
    m := struct {
        Foo struct {
            Bar string `json:",omitempty"`
        } `json:",omitempty"`
    }{}
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

结果:

{"Foo":{}}

如果要实现结构体输出空,可以使用指针来定义,omitempty对nil会生效。

func main() {
    m := struct {
        Foo *struct {
            Bar string `json:",omitempty"`
        } `json:",omitempty"`
    }{}
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

输出结果为:

{}

7、使用omitempty在time.Time的零值也会失效

在零值时间上使用omitempty。time.Time字段不会在编码的JSON中隐藏。这是因为时间time.Time是一个struct类型,如上所述,omitempty从不将一个结构类型视为空。因此,字符串"0001-01-01 t00:00:00 - 00z "将出现在JSON中(这是在零值time.Time上调用MarshalJSON()方法返回的值。例如:

func main() {
    m := struct {
        Foo time.Time `json:",omitempty"`
    }{}
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

输出结果:

{"Foo":"0001-01-01T00:00:00Z"}

8、string标签

Go提供了一个字符串结构标记,它强制将单个字段中的数据编码为JSON中的字符串。例如,如果你想强制将一个整数表示为字符串而不是JSON数字,你可以使用string指令,如下所示:

func main() {
    m := struct {
        Foo int `json:",string"`
    }{
        Foo: 123,
    }
    marshal, _ := json.Marshal(m)
    fmt.Println(string(marshal))
}

输出结果:

{"Foo":"123"}

注意,string标记只对包含float、integer或bool类型的字段有效。对于任何其他类型都没有效果。

9、将json的number反序列化到interface{}会转为float64类型

当将JSON数字解码为interface{}类型时,该值将被转为float64类型,即使原始JSON中是整数。如果要保持整数输出可以使用json.Decoder实例并调用UseNumber函数如下所示:

func main() {

    js := `{"foo": 123, "bar": true}`

    var m map[string]interface{}

    dec := json.NewDecoder(strings.NewReader(js))
    dec.UseNumber()

    err := dec.Decode(&m)
    if err != nil {
        log.Fatal(err)
    }

    i, err := m["foo"].(json.Number).Int64()
    if err != nil {
        log.Fatal(err)
    }

    fmt.Printf("foo: %d", i)
}

输出结果:

foo: 123

10、自定义MarshalJSON()方法返回的字符串值必须加引号

如果您正在创建一个返回字符串值的自定义MarshalJSON()方法,则必须在返回字符串之前用双引号包装该字符串,否则它将不会被解释为JSON字符串,并将导致运行时错误。例如:

type Age int

func (age Age) MarshalJSON() ([]byte, error) {
    encodedAge := fmt.Sprintf("%d years", age)
    encodedAge = strconv.Quote(encodedAge) //  返回之前用引号将字符串括起来
    return []byte(encodedAge), nil
}

func main() {
    users := map[string]Age{
        "alice": 21,
        "bob":   84,
    }

    js, err := json.Marshal(users)
    if err != nil {
        log.Fatal(err)
    }

    fmt.Printf("%s", js)
}

输出结果:

{"alice":"21 years","bob":"84 years"}

如果,在上面的代码中,MarshalJSON()的返回值没有使用strconv.Quote,你会得到错误:

2021/09/19 08:04:25 json: error calling MarshalJSON for type main.Age: invalid character 'y' after top-level value
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Go中的标准库encoding/json提供JSON格式的序列化和反序列化功能. 序列化struct为JSON P...
    asdzxc阅读 2,642评论 0 0
  • 标准库中的encoding/xml包提供了XML格式的序列化功能. 将XML解析为struct 解析XML与解析J...
    asdzxc阅读 1,748评论 0 0
  • 以下内容是我在学习和研究Go时,对Go的特性、重点和注意事项的提取、精练和总结,还有一些学习笔记(注:部分笔记是摘...
    科研者阅读 3,746评论 0 1
  • 很多程序都需要处理或者发布数据,不管这个程序是要使用数据库,进行网络调用,还是与分布式系统打交道。如果程序需要处理...
    Go语言由浅入深阅读 5,077评论 0 1
  • 原文地址:https://www.liwenzhou.com/posts/Go/json_tricks_in_go...
    李小斌_2018阅读 2,187评论 0 2