go json 自定义_你需要知道的那些Go语言json技巧（下）

本文总结了我平时在项目中遇到的那些关于go语言json数据与结构体之间相互转换的问题及解决办法，由于篇幅较长，考虑到公众号上的阅读性所以分成了上下两篇文章，本文是下篇。大家也可以直接点击文末的阅读原文查看我博客上完整版文章。

自定义解析时间字段

Go语言内置的 json 包使用 RFC3339 标准中定义的时间格式，对我们序列化时间字段的时候有很多限制。

type Post struct { CreateTime time.Time `json:"create_time"`}func timeFieldDemo() { p1 := Post{CreateTime: time.Now()} b, err := json.Marshal(p1) if err != nil {  fmt.Printf("json.Marshal p1 failed, err:%v\n", err)  return } fmt.Printf("str:%s\n", b) jsonStr := `{"create_time":"2020-04-05 12:25:42"}` var p2 Post if err := json.Unmarshal([]byte(jsonStr), &p2); err != nil {  fmt.Printf("json.Unmarshal failed, err:%v\n", err)  return } fmt.Printf("p2:%#v\n", p2)}

上面的代码输出结果如下：

str:{"create_time":"2020-04-05T12:28:06.799214+08:00"}json.Unmarshal failed, err:parsing time ""2020-04-05 12:25:42"" as ""2006-01-02T15:04:05Z07:00"": cannot parse " 12:25:42"" as "T"

也就是内置的json包不识别我们常用的字符串时间格式，如2020-04-05 12:25:42。

不过我们通过实现 json.Marshaler/json.Unmarshaler 接口实现自定义的事件格式解析。

type CustomTime struct { time.Time}const ctLayout = "2006-01-02 15:04:05"var nilTime = (time.Time{}).UnixNano()func (ct *CustomTime) UnmarshalJSON(b []byte) (err error) { s := strings.Trim(string(b), "\"") if s == "null" {  ct.Time = time.Time{}  return } ct.Time, err = time.Parse(ctLayout, s) return}func (ct *CustomTime) MarshalJSON() ([]byte, error) { if ct.Time.UnixNano() == nilTime {  return []byte("null"), nil } return []byte(fmt.Sprintf("\"%s\"", ct.Time.Format(ctLayout))), nil}func (ct *CustomTime) IsSet() bool { return ct.UnixNano() != nilTime}type Post struct { CreateTime CustomTime `json:"create_time"`}func timeFieldDemo() { p1 := Post{CreateTime: CustomTime{time.Now()}} b, err := json.Marshal(p1) if err != nil {  fmt.Printf("json.Marshal p1 failed, err:%v\n", err)  return } fmt.Printf("str:%s\n", b) jsonStr := `{"create_time":"2020-04-05 12:25:42"}` var p2 Post if err := json.Unmarshal([]byte(jsonStr), &p2); err != nil {  fmt.Printf("json.Unmarshal failed, err:%v\n", err)  return } fmt.Printf("p2:%#v\n", p2)}

自定义MarshalJSON和UnmarshalJSON方法

上面那种自定义类型的方法稍显啰嗦了一点，下面来看一种相对便捷的方法。

首先你需要知道的是，如果你能够为某个类型实现了MarshalJSON()([]byte, error)和UnmarshalJSON(b []byte) error方法，那么这个类型在序列化(MarshalJSON)/反序列化(UnmarshalJSON)时就会使用你定制的相应方法。

type Order struct { ID          int       `json:"id"` Title       string    `json:"title"` CreatedTime time.Time `json:"created_time"`}const layout = "2006-01-02 15:04:05"// MarshalJSON 为Order类型实现自定义的MarshalJSON方法func (o *Order) MarshalJSON() ([]byte, error) { type TempOrder Order // 定义与Order字段一致的新类型 return json.Marshal(struct {  CreatedTime string `json:"created_time"`  *TempOrder         // 避免直接嵌套Order进入死循环 }{  CreatedTime: o.CreatedTime.Format(layout),  TempOrder:   (*TempOrder)(o), })}// UnmarshalJSON 为Order类型实现自定义的UnmarshalJSON方法func (o *Order) UnmarshalJSON(data []byte) error { type TempOrder Order // 定义与Order字段一致的新类型 ot := struct {  CreatedTime string `json:"created_time"`  *TempOrder         // 避免直接嵌套Order进入死循环 }{  TempOrder: (*TempOrder)(o), } if err := json.Unmarshal(data, &ot); err != nil {  return err } var err error o.CreatedTime, err = time.Parse(layout, ot.CreatedTime) if err != nil {  return err } return nil}// 自定义序列化方法func customMethodDemo() { o1 := Order{  ID:          123456,  Title:       "《七米的Go学习笔记》",  CreatedTime: time.Now(), } // 通过自定义的MarshalJSON方法实现struct -> json string b, err := json.Marshal(&o1) if err != nil {  fmt.Printf("json.Marshal o1 failed, err:%v\n", err)  return } fmt.Printf("str:%s\n", b) // 通过自定义的UnmarshalJSON方法实现json string -> struct jsonStr := `{"created_time":"2020-04-05 10:18:20","id":123456,"title":"《七米的Go学习笔记》"}` var o2 Order if err := json.Unmarshal([]byte(jsonStr), &o2); err != nil {  fmt.Printf("json.Unmarshal failed, err:%v\n", err)  return } fmt.Printf("o2:%#v\n", o2)}

输出结果：

str:{"created_time":"2020-04-05 10:32:20","id":123456,"title":"《七米的Go学习笔记》"}o2:main.Order{ID:123456, Title:"《七米的Go学习笔记》", CreatedTime:time.Time{wall:0x0, ext:63721678700, loc:(*time.Location)(nil)}}

使用匿名结构体添加字段

使用内嵌结构体能够扩展结构体的字段，但有时候我们没有必要单独定义新的结构体，可以使用匿名结构体简化操作：

type UserInfo struct { ID   int    `json:"id"` Name string `json:"name"`}func anonymousStructDemo() { u1 := UserInfo{  ID:   123456,  Name: "七米", } // 使用匿名结构体内嵌User并添加额外字段Token b, err := json.Marshal(struct {  *UserInfo  Token string `json:"token"` }{  &u1,  "91je3a4s72d1da96h", }) if err != nil {  fmt.Printf("json.Marsha failed, err:%v\n", err)  return } fmt.Printf("str:%s\n", b) // str:{"id":123456,"name":"七米","token":"91je3a4s72d1da96h"}}

使用匿名结构体组合多个结构体

同理，也可以使用匿名结构体来组合多个结构体来序列化与反序列化数据：

type Comment struct { Content string}type Image struct { Title string `json:"title"` URL   string `json:"url"`}func anonymousStructDemo2() { c1 := Comment{  Content: "永远不要高估自己", } i1 := Image{  Title: "赞赏码",  URL:   "https://www.liwenzhou.com/images/zanshang_qr.jpg", } // struct -> json string b, err := json.Marshal(struct {  *Comment  *Image }{&c1, &i1}) if err != nil {  fmt.Printf("json.Marshal failed, err:%v\n", err)  return } fmt.Printf("str:%s\n", b) // json string -> struct jsonStr := `{"Content":"永远不要高估自己","title":"赞赏码","url":"https://www.liwenzhou.com/images/zanshang_qr.jpg"}` var (  c2 Comment  i2 Image ) if err := json.Unmarshal([]byte(jsonStr), &struct {  *Comment  *Image }{&c2, &i2}); err != nil {  fmt.Printf("json.Unmarshal failed, err:%v\n", err)  return } fmt.Printf("c2:%#v i2:%#v\n", c2, i2)}

输出：

str:{"Content":"永远不要高估自己","title":"赞赏码","url":"https://www.liwenzhou.com/images/zanshang_qr.jpg"}c2:main.Comment{Content:"永远不要高估自己"} i2:main.Image{Title:"赞赏码", URL:"https://www.liwenzhou.com/images/zanshang_qr.jpg"}

处理不确定层级的json

如果json串没有固定的格式导致不好定义与其相对应的结构体时，我们可以使用json.RawMessage原始字节数据保存下来。

type sendMsg struct { User string `json:"user"` Msg  string `json:"msg"`}func rawMessageDemo() { jsonStr := `{"sendMsg":{"user":"q1mi","msg":"永远不要高估自己"},"say":"Hello"}` // 定义一个map，value类型为json.RawMessage，方便后续更灵活地处理 var data map[string]json.RawMessage if err := json.Unmarshal([]byte(jsonStr), &data); err != nil {  fmt.Printf("json.Unmarshal jsonStr failed, err:%v\n", err)  return } var msg sendMsg if err := json.Unmarshal(data["sendMsg"], &msg); err != nil {  fmt.Printf("json.Unmarshal failed, err:%v\n", err)  return } fmt.Printf("msg:%#v\n", msg) // msg:main.sendMsg{User:"q1mi", Msg:"永远不要高估自己"}}

参考链接：

https://stackoverflow.com/questions/25087960/json-unmarshal-time-that-isnt-in-rfc-3339-format

https://colobu.com/2017/06/21/json-tricks-in-Go/

https://stackoverflow.com/questions/11066946/partly-json-unmarshal-into-a-map-in-go

http://choly.ca/post/go-json-marshalling/

推荐阅读