脚本之家,脚本语言编程技术及教程分享平台!
分类导航

Python|VBS|Ruby|Lua|perl|VBA|Golang|PowerShell|Erlang|autoit|Dos|bat|

服务器之家 - 脚本之家 - Golang - Golang 中的json.Marshal问题总结(推荐)

Golang 中的json.Marshal问题总结(推荐)

2022-10-25 12:05加拉萨假期 Golang

这篇文章主要介绍了Golang中的json.Marshal问题总结,本文通过一个例子给大家详细讲解,本次提出的问题中,我们不难注意到其中的time.Time是一个匿名(Anonymous)字段,而这个就是答案的由来,需要的朋友可以参考下

1.Quiz

有如下一个例子:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package main
 
import (
    "encoding/json"
    "fmt"
    "time"
)
 
type RecordBrief struct {
    time.Time
    ID int
}
 
func main() {
    r := RecordBrief{
        Time: time.Now(),
        ID:   6,
    }
    m, _ := json.MarshalIndent(r, "", "\t")
    fmt.Println(string(m))
}

你期望的结果是像:

{
        "Time": "2022-06-25T10:49:39.597537249+08:00",
        "ID": 6
}

还是:

{
        "ID": 6
}

或者是别的?

2.Answer

其实如果你认为的答案不是:

"2022-06-25T10:52:23.590933959+08:00"

也没能想明白原因,可以继续往下看看。

3.Resolving

诚然,我们在学习json的序列化和反序列化的时候,目的就是把一个Golang struct值序列化为对应的json string罢了。可能我们还知道一些Marshal的规则,比如struct的字段需要定义为可导出的,比如还可通过定义对应的json tag来修改struct field对应的json字段名称等。

但是对于json.Marshal函数的细节可能大家不会去太在意。本次提出的问题中,我们不难注意到其中的time.Time是一个匿名(Anonymous)字段,而这个就是答案的由来。我们先看看json.Marshal的注释文档中的一个解释:

?
1
2
3
4
5
6
7
8
9
10
11
// ...
// Marshal traverses the value v recursively.
// If an encountered value implements the Marshaler interface
// and is not a nil pointer, Marshal calls its MarshalJSON method
// to produce JSON. If no MarshalJSON method is present but the
// value implements encoding.TextMarshaler instead, Marshal calls
// its MarshalText method and encodes the result as a JSON string.
// ...
func Marshal(v interface{}) ([]byte, error) {
    ...
}

Marshal函数递归地遍历传入的序列化对象v(及其成员)。当面对一个实现了json.Marshaler接口的对象(不能是一个空指针)时,Marshal函数就会调用该对象的MarshalJSON方法来生成JSON内容。如果没有实现json.Marshaler,而是实现了encoding.TextMarshaler接口,那么就会调用它的MarshalText方法,然后把该方法返回的结果转编为一个JSON字符串。

然后我们再看看time.Time

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
type Time struct {
    ...
}
 
// MarshalJSON implements the json.Marshaler interface.
// The time is a quoted string in RFC 3339 format, with sub-second precision added if present.
func (t Time) MarshalJSON() ([]byte, error) {
    if y := t.Year(); y < 0 || y >= 10000 {
        // RFC 3339 is clear that years are 4 digits exactly.
        // See golang.org/issue/4556#c15 for more discussion.
        return nil, errors.New("Time.MarshalJSON: year outside of range [0,9999]")
    }
 
    b := make([]byte, 0, len(RFC3339Nano)+2)
    b = append(b, '"')
    b = t.AppendFormat(b, RFC3339Nano)
    b = append(b, '"')
    return b, nil
}

所以time.Time是实现了json.Marshaler接口的。然后观察到它的实现是把时间按照RFC3339Nano格式字符串值返回为json序列化结果,这和我们实际上运行程序看到的结果是一致的。

那么再看看我们的type定义:

?
1
2
3
4
type RecordBrief struct {
    time.Time
    ID int
}

为什么ID字段不见了?正是因为匿名字段的原因,Golang中的这种用法有点类似于继承,所以RecordBrief类型也自动具有了time.Time的所有方法,当然也包括了MarshalJSON,从而也就实现了json.Marshaler接口。如此一来,当一个RecordBrief被Marshal的时候,它的序列化结果就被time.Time的序列化结果给覆盖了。

Conclusion

如果你和我一样,没能一下知道原因,那多半是对一些常见的知识了解的深度和广度不够。我之前确实不知道time.Time居然也实现了json.Marshaler接口,也不清楚json.Marshal到底在做什么,所以不知道答案也就理所当然了,后来经过阅读文档注释,才终于对该问题有了一些认知(后续应该总结一篇json.Marshal的源码解析)。

至此,如果我们想要这种样子的结果:

{
        "Time": "2022-06-25T10:49:39.597537249+08:00",
        "ID": 6
}

最简单的方式是修改struct,将time.Time作为一个非匿名的导出字段:

?
1
2
3
4
type RecordBrief struct {
    Time time.Time
    ID int
}

另一种方法是给我们的RecordBrief实现json.Marshaler接口:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
type RecordBrief struct {
    time.Time
    ID int
}
func (r RecordBrief) MarshalJSON() ([]byte, error) {
    //非常简单的一种方式就是创建中间类型
    t := struct {
        Time time.Time
        ID   int
    }{
        r.Time,
        r.ID,
    }
    return json.Marshal(t)
}

到此这篇关于Golang 中的json.Marshal问题总结的文章就介绍到这了,更多相关Golang json.Marshal内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家!

原文链接:https://blog.csdn.net/m0_38059938/article/details/125456612

延伸 · 阅读

精彩推荐
  • GolangGo语言学习技巧之命名规范

    Go语言学习技巧之命名规范

    最近在学习go语言,发现了不少需要整理的知识点,所以整理下分享出来,下面这篇文章主要给大家介绍了关于Go语言学习技巧之命名规范的相关资料,文中...

    Zachary Marv4762020-05-12
  • Golang从源码的角度看Go语言Flag库如何解析命令行参数!

    从源码的角度看Go语言Flag库如何解析命令行参数!

    Parse的代码里用到了一个,CommandLine共享变量,这就是内部库维护的FlagSet,所有的参数都会插到里面的变量地址向地址的指向赋值绑定。...

    机智的程序员小熊10682021-08-11
  • Golang解决golang时间字符串转time.Time的坑

    解决golang时间字符串转time.Time的坑

    这篇文章主要介绍了解决golang时间字符串转time.Time的坑,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...

    fwhezfwhez6552021-05-28
  • GolangGolang读写Excel的方法教程

    Golang读写Excel的方法教程

    这篇文章主要给大家介绍了关于Golang读写Excel的方法教程,golang操作excel利用的是Excelize,Excelize是Golang编写的一个用来操作 Office Excel 文档类库,基于微软的...

    续日23902020-05-06
  • Golang基于go interface{}==nil 的几种坑及原理分析

    基于go interface{}==nil 的几种坑及原理分析

    这篇文章主要介绍了基于go interface{}==nil 的几种坑及原理分析,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...

    mukebb7092021-05-27
  • Golanggolang程序进度条实现示例详解

    golang程序进度条实现示例详解

    这篇文章主要为大家介绍了golang程序实现进度条示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪...

    jonylee11202022-08-29
  • Golanggo语言实现AES加密的方法

    go语言实现AES加密的方法

    这篇文章主要介绍了go语言实现AES加密的方法,实例分析了Go语言的加密技巧,需要的朋友可以参考下 ...

    dingding8002020-04-20
  • Golanglinux下通过go语言获得系统进程cpu使用情况的方法

    linux下通过go语言获得系统进程cpu使用情况的方法

    这篇文章主要介绍了linux下通过go语言获得系统进程cpu使用情况的方法,实例分析了Go语言使用linux的系统命令ps来分析cpu使用情况的技巧,需要的朋友可以参考...

    两把刷子7362020-04-20