前言

平时工作当中经常使用json的序列化或者反序列，但是偶尔也会发现你定义的结构体使用json序列化或者反序列化的时候不是你期望的结果，我也经常遇到这种，所以我通过读源码之后总结了一些可能让人诧异的操作，希望能规避一些错误场景，而且也会有源码解释的哦。我的所有的示例代码都是可以点击查看的哦，可以在The Go Playground自己试试哦。(微信公众号文章不能直接点击，可以查看原文，在csdn里面点击跳转)

一、自定义序列化：MarshalJSON

下面代码你觉得结果是多少呢？{"MarshalJSON":"hit func MarshalJSON"}吗？

代码如下：

type User struct {    Name string    Age  int    Sex  bool    ProfileV1    ProfileV2}func (u *User) MarshalJSON() ([]byte, error) {    return json.Marshal(map[string]string{        "MarshalJSON": "hit func MarshalJSON",    })}func main() {    var zhangSan = User{        Name: "Zhang San",        Age:  18,        Sex:  true,    }    bytes, err := json.Marshal(zhangSan)    if err != nil {        fmt.Println("error:", err)    } else {        fmt.Println("result:", string(bytes))    }}

运行得到的结果却是:

{"Name":"Zhang San","Age":18,"Sex":true,"HeadImg":"","SelfIntroduce":""}

如何修正？第9行方法的接受者User不使用指针即可得到正确结果，代码如下:

func (u User) MarshalJSON() ([]byte, error) {    return json.Marshal(map[string]string{        "MarshalJSON": "hit func MarshalJSON",    })}

二、自定义序列化：TextMarshaler

我们对MarshalJSON很熟，但是自定义序列化还有另外一种方式：TextMarshaler接口，把结构体能序列化成文本格式，不一定是json格式的文本。
官方说明：

TextMarshaler is the interface implemented by an object that canmarshal itself into a textual form.MarshalText encodes the receiver into UTF-8-encoded text and returns the result.

其实TextMarshaler也有MarshalJSON的问题，但是我这里想说的是当你的结构体同时实现了MarshalJSON和TextMarshaler之后，序列化的结果是什么呢？代码如下：

type User struct {    Name string    Age  int    Sex  bool}func (u User) MarshalJSON() ([]byte, error) {    return json.Marshal(map[string]string{        "MarshalJSON": "hit func MarshalJSON",    })}func (u User) MarshalText() (text []byte, err error) {    return []byte("MarshalText"), nil}func main() {    var zhangSan = User{        Name: "Zhang San",        Age:  18,        Sex:  true,    }    bytes, err := json.Marshal(zhangSan)    if err != nil {        fmt.Println("error:", err)    } else {        fmt.Println("result:", string(bytes))    }}

结果还是

{"MarshalJSON":"hit func MarshalJSON"}

所以这里就有个先后顺序了，当同时实现了MarshalJSON和TextMarshaler，那么只执行MarshalJSON。去掉MarshalJSON之后，代码执行的结果为：

"MarshalText"

三、编码html标签

我们会遇到编码<a>类似标签的文本，在go中是如何处理的呢？

", ">", "&", U+2028, and U+2029 are escaped to "\u003c","\u003e", "\u0026", "\u2028", and "\u2029".

会把"", "&", U+2028, and U+2029unicode编码。请看如下示例：

type User struct {    Name string    Age  int    Sex  bool}func main() {    var zhangSan = User{        Name: "Zhang San star",        Age:  18,        Sex:  true,    }    bytes, err := json.Marshal(zhangSan)    if err != nil {        fmt.Println("error:", err)    } else {        fmt.Println("result:", string(bytes))    }}

结果为:

{"Name":"Zhang San \u003ca\u003estar\u003c/a\u003e","Age":18,"Sex":true}

为什么这么操作呢？官方解释是web浏览器的历史原因，会导致注入攻击。但是我们的场景不一定是返回给浏览器的，而go的json是必须这么序列化的，那么如何不这样返回呢？办法是自定义序列化了。

四、数字如何序列化成字符串：{"age":18} => {"age":"18"}

有这种场景吗？例如前端要给年龄拼接成“18岁”。
在go的json中如何使用呢？代码如下：

type User struct {    Name string    Age  int `json:",string"`    Sex  bool}func main() {    var zhangSan = User{        Name: "Zhang San",        Age:  18,        Sex:  true,    }    bytes, err := json.Marshal(zhangSan)    if err != nil {        fmt.Println("error:", err)    } else {        fmt.Println("result:", string(bytes))    }}

只需要在json的tag中申明string即可。

四、匿名结构体的花花肠子

1.加了json的tag的匿名结构体和没加tag的匿名结构体

加和不加序列化结果的json层级不一样，代码如下：

type User struct {    Name      string    Age       int    Sex       bool    ProfileV1 `json:"profile_v1"`    ProfileV2}func main() {    var zhangSan = User{        Name: "Zhang San",        Age:  18,        Sex:  true,        ProfileV1: ProfileV1{            NickName: "Zhang Si(renamed)",            HeadImg:  "http://head.jpg",        },        ProfileV2: ProfileV2{            NickName:      "Zhang Wu(renamed)",            SelfIntroduce: "I am a gopher!",        },    }    bytes, err := json.MarshalIndent(zhangSan, "", "\t")    if err != nil {        fmt.Println("error:", err)    } else {        fmt.Println(string(bytes))    }}type ProfileV1 struct {    NickName string    HeadImg  string}type ProfileV2 struct {    NickName      string    SelfIntroduce string}

打印出来结果如下：

{    "Name": "Zhang San",    "Age": 18,    "Sex": true,    "profile_v1": {        "NickName": "Zhang Si(renamed)",        "HeadImg": "http://head.jpg"    },    "NickName": "Zhang Wu(renamed)",    "SelfIntroduce": "I am a gopher!"}

可以看到我给ProfileV1这个匿名结构体加了tag，就多了一个层级，而不加就和go的匿名意思一样了，当做同级处理。这个还算正常吧？

2. "-"和"-,"

"-"我们很清楚是忽略这个结构体的字段不让序列化，那么"-,"呢？我相信如果不看源码的话，这个还真的很坑啊，且看官方文档的说明：As a special case, if the field tag is "-", the field is always omitted.Note that a field with name "-" can still be generated using the tag "-,"，好的，下面示例代码奉上：

type User struct {    Name      string `json:"-,"`    Age       int    Sex       bool}func main() {    var zhangSan = User{        Name: "Zhang San",        Age:  18,        Sex:  true,    }    bytes, err := json.MarshalIndent(zhangSan, "", "\t")    if err != nil {        fmt.Println("error:", err)    } else {        fmt.Println(string(bytes))    }}

猜猜结果是多少：

{    "-": "Zhang San",    "Age": 18,    "Sex": true}

是不是贼坑啊，要是不小心多打了个逗号，估计就是黑头搔更短，浑欲不胜簪了。或者你会说：是谁这么手残啊？我是绝对不会的。

3.2个嵌套的匿名结构体有相同的字段

当同级有2个嵌套的匿名结构体有相同的字段的时候，序列化程啥样呢？当然如果有tag，我们就一tag的名作比较。
下面的代码结果是什么呢？

type User struct {    Name string `json:"-,"`    Age  int    Sex  bool    ProfileV1    ProfileV2}func main() {    var zhangSan = User{        Name: "Zhang San",        Age:  18,        Sex:  true,        ProfileV1: ProfileV1{            NickName: "Zhang Si(renamed)",            HeadImg:  "http://head.jpg",        },        ProfileV2: ProfileV2{            NickName:      "Zhang Wu(renamed)",            SelfIntroduce: "I am a gopher!",        },    }    bytes, err := json.MarshalIndent(zhangSan, "", "\t")    if err != nil {        fmt.Println("error:", err)    } else {        fmt.Println(string(bytes))    }}type ProfileV1 struct {    NickName string    HeadImg  string}type ProfileV2 struct {    NickName      string    SelfIntroduce string}

ProfileV1和ProfileV22个结构体都有NickName这个字段，序列化的结构是啥样的呢？

{    "-": "Zhang San",    "Age": 18,    "Sex": true,    "HeadImg": "http://head.jpg",    "SelfIntroduce": "I am a gopher!"}

发现它直接把NickName忽略了，这我实在没想到竟然如此操作，而且我冲突了你至少报个错给我吧，但是go的json直接给你忽略了。。。。所以这里我觉得可以这么处理，给其中一个NickName打个标签重命名下。

4.匿名结构体的字段和匿名结构体所在结构体的字段相同

这里比较符合常理了，会使用匿名结构体所在结构体的字段，忽略匿名结构体的字段，代码如下：

type User struct {    Name     string    NickName string    Age      int    Sex      bool    ProfileV1    ProfileV2}func main() {    var zhangSan = User{        Name:     "Zhang San",        NickName: "Bro San",        Age:      18,        Sex:      true,        ProfileV1: ProfileV1{            //NickName: "Zhang Si(renamed)",            HeadImg:  "http://head.jpg",        },        ProfileV2: ProfileV2{            NickName:      "Zhang Wu(renamed)",            SelfIntroduce: "I am a gopher!",        },    }    bytes, err := json.MarshalIndent(zhangSan, "", "\t")    if err != nil {        fmt.Println("error:", err)    } else {        fmt.Println(string(bytes))    }}type ProfileV1 struct {    //NickName string    HeadImg  string}type ProfileV2 struct {    NickName      string    SelfIntroduce string}

结果如下：

{    "Name": "Zhang San",    "NickName": "Bro San",    "Age": 18,    "Sex": true,    "HeadImg": "http://head.jpg",    "SelfIntroduce": "I am a gopher!"}

能看出来直接忽略了匿名结构体的NickeName字段。

五、map的序列化支持的key类型

官方文档的解说：

The map's key type must either be a string, an integer type, or implement encoding.TextMarshaler. The map keys are sorted and used as JSON object keys by applying the following rules,subject to the UTF-8 coercion described for string values above:   - keys of any string type are used directly   - encoding.TextMarshalers are marshaled   - integer keys are converted to strings

也就是说只支持string、integer(因为能直接转为string)、或者实现了接口encoding.TextMarshalers，如果是其他类型会报错，示例代码：

func main() {    bytes, err := json.MarshalIndent(map[bool]string{        true: "OK",    }, "", "\t")    if err != nil {        fmt.Println("error:", err)    } else {        fmt.Println(string(bytes))    }}

结果为：

error: json: unsupported type: map[bool]string

六、循环的结构体会报错

假如有如下一样的User结构体需要被编码：

type User struct {    Name     string    NickName string    Age      int    Sex      bool    Child    *User}func main() {    var zhangSan = &User{        Name:     "Zhang San",        NickName: "Bro San",        Age:      18,        Sex:      true,    }    zhangSan.Child = zhangSan    bytes, err := json.MarshalIndent(zhangSan, "", "\t")    if err != nil {        fmt.Println("error:", err)    } else {        fmt.Println(string(bytes))    }}

会导致什么错误呢？

error: json: unsupported value: encountered a cycle via *main.User

这种结构体在算法中还容易碰到，所以序列化要小心了。

七、最后说明下一些不被支持的结构体

通道、复合数据和方法都不能被序列化。

总结

现在大概就这么总结下，后面我会对源码分析，如果碰到一些其他的坑，会再开一篇文章细细说说。

如果觉得有用，请关注我的公众号，会持续输出原创云原生相关文章