详解go语言json的使用技巧

更新时间：2021年03月30日 09:08:08 作者：王中阳Go

这篇文章主要介绍了详解go语言json的使用技巧，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

本文整理了一部分我们平时在项目中经常遇到的关于go语言JSON数据与结构体之间相互转换的问题及解决办法。

基本的序列化

首先我们来看一下Go语言中json.Marshal()（系列化）与json.Unmarshal（反序列化）的基本用法。

type Person struct {
 Name  string
 Age  int64
 Weight float64
}

func main() {
 p1 := Person{
 Name:  "小明",
 Age:  18,
 Weight: 71.5,
 }
 // struct -> json string
 b, err := json.Marshal(p1)
 if err != nil {
 fmt.Printf("json.Marshal failed, err:%v\n", err)
 return
 }
 fmt.Printf("str:%s\n", b)
 // json string -> struct
 var p2 Person
 err = json.Unmarshal(b, &p2)
 if err != nil {
 fmt.Printf("json.Unmarshal failed, err:%v\n", err)
 return
 }
 fmt.Printf("p2:%#v\n", p2)
}

输出：
str:{"Name":"小明","Age":18,"Weight":71.5}
p2:main.Person{Name:"小明", Age:18, Weight:71.5}

结构体tag介绍

Tag是结构体的元信息，可以在运行的时候通过反射的机制读取出来。 Tag在结构体字段的后方定义，由一对反引号包裹起来，具体的格式如下：

`key1:"value1" key2:"value2"`

结构体tag由一个或多个键值对组成。键与值使用冒号分隔，值用双引号括起来。
同一个结构体字段可以设置多个键值对tag，不同的键值对之间使用空格分隔。

使用json tag指定字段名

序列化与反序列化默认情况下使用结构体的字段名，我们可以通过给结构体字段添加tag来指定json序列化生成的字段名。

// 使用json tag指定序列化与反序列化时的行为
type Person struct {
 Name  string `json:"name"` // 指定json序列化/反序列化时使用小写name
 Age  int64
 Weight float64
}

忽略某个字段

如果你想在json序列化/反序列化的时候忽略掉结构体中的某个字段，可以按如下方式在tag中添加-。

// 使用json tag指定json序列化与反序列化时的行为
type Person struct {
 Name  string `json:"name"` // 指定json序列化/反序列化时使用小写name
 Age  int64
 Weight float64 `json:"-"` // 指定json序列化/反序列化时忽略此字段
}

忽略空值字段

当 struct 中的字段没有值时， json.Marshal() 序列化的时候不会忽略这些字段，而是默认输出字段的类型零值（例如int和float类型零值是 0，string类型零值是""，对象类型零值是 nil）。如果想要在序列序列化时忽略这些没有值的字段时，可以在对应字段添加omitempty tag。

举个例子：

type User struct {
 Name string  `json:"name"`
 Email string  `json:"email"`
 Hobby []string `json:"hobby"`
}

func omitemptyDemo() {
 u1 := User{
 Name: "小明",
 }
 // struct -> json string
 b, err := json.Marshal(u1)
 if err != nil {
 fmt.Printf("json.Marshal failed, err:%v\n", err)
 return
 }
 fmt.Printf("str:%s\n", b)
}

输出结果：
str:{"name":"小明","email":"","hobby":null}

如果想要在最终的序列化结果中去掉空值字段，可以像下面这样定义结构体：

// 在tag中添加omitempty忽略空值
// 注意这里 hobby,omitempty 合起来是json tag值，中间用英文逗号分隔
type User struct {
 Name string  `json:"name"`
 Email string  `json:"email,omitempty"`
 Hobby []string `json:"hobby,omitempty"`
}

此时，再执行上述的omitemptyDemo，输出结果如下：

str:{"name":"小明"} // 序列化结果中没有email和hobby字段

说句题外话，我们使用gorm操作数据库的话，经常会遇到想忽略指定字段修改的问题，比如结构体中的关联实体，只想json展示，form提交时忽略实体，这种问题我会单独整理一篇出来。

忽略嵌套结构体空值字段

首先来看几种结构体嵌套的示例：

type User struct {
 Name string  `json:"name"`
 Email string  `json:"email,omitempty"`
 Hobby []string `json:"hobby,omitempty"`
 Profile
}

type Profile struct {
 Website string `json:"site"`
 Slogan string `json:"slogan"`
}

func nestedStructDemo() {
 u1 := User{
 Name: "小明",
 Hobby: []string{"足球", "篮球"},
 }
 b, err := json.Marshal(u1)
 if err != nil {
 fmt.Printf("json.Marshal failed, err:%v\n", err)
 return
 }
 fmt.Printf("str:%s\n", b)
}

匿名嵌套Profile时序列化后的json串为单层的：

str:{"name":"小明","hobby":["足球","蓝球"],"site":"","slogan":""}

想要变成嵌套的json串，需要改为具名嵌套或定义字段tag：

type User struct {
 Name  string  `json:"name"`
 Email  string  `json:"email,omitempty"`
 Hobby  []string `json:"hobby,omitempty"`
 Profile `json:"profile"`
}
// str:{"name":"小明","hobby":["足球","篮球"],"profile":{"site":"","slogan":""}}

想要在嵌套的结构体为空值时，忽略该字段，仅添加omitempty是不够的：

type User struct {
 Name   string  `json:"name"`
 Email  string  `json:"email,omitempty"`
 Hobby  []string `json:"hobby,omitempty"`
 Profile `json:"profile,omitempty"`
}
// str:{"name":"小明","hobby":["足球","篮球"],"profile":{"site":"","slogan":""}}

还需要使用嵌套的结构体指针：

type User struct {
 Name   string  `json:"name"`
 Email  string  `json:"email,omitempty"`
 Hobby  []string `json:"hobby,omitempty"`
 *Profile `json:"profile,omitempty"` //这里是重点
}
// str:{"name":"小明","hobby":["足球","篮球"]}

不修改原结构体忽略空值字段

我们需要json序列化User，但是不想把密码也序列化，又不想修改User结构体，这个时候我们就可以使用创建另外一个结构体PublicUser匿名嵌套原User，同时指定Password字段为匿名结构体指针类型，并添加omitemptytag，示例代码如下：

type User struct {
 Name   string `json:"name"`
 Password string `json:"password"`
}

type PublicUser struct {
 *User       // 匿名嵌套
 Password *struct{} `json:"password,omitempty"`
}

func omitPasswordDemo() {
 u1 := User{
 Name:   "小明",
 Password: "123456",
 }
 b, err := json.Marshal(PublicUser{User: &u1})
 if err != nil {
 fmt.Printf("json.Marshal u1 failed, err:%v\n", err)
 return
 }
 fmt.Printf("str:%s\n", b) // str:{"name":"小明"}
}

优雅处理字符串格式的数字

有时候，前端在传递来的json数据中可能会使用字符串类型的数字，这个时候可以在结构体tag中添加string来告诉json包从字符串中解析相应字段的数据：

type Card struct {
 ID  int64  `json:"id,string"`  // 添加string tag
 Score float64 `json:"score,string"` // 添加string tag
}

func intAndStringDemo() {
 jsonStr1 := `{"id": "1234567","score": "88.50"}`
 var c1 Card
 if err := json.Unmarshal([]byte(jsonStr1), &c1); err != nil {
 fmt.Printf("json.Unmarsha jsonStr1 failed, err:%v\n", err)
 return
 }
 fmt.Printf("c1:%#v\n", c1) // c1:main.Card{ID:1234567, Score:88.5}
}

总结

今天只是整理了一部分json的使用技巧，在实际项目中json是不可缺少的一个组成部分，今天立个flag，下一篇会整理gorm相关的使用技巧。

到此这篇关于详解go语言json的使用技巧的文章就介绍到这了,更多相关go语言json使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

重学Go语言之如何使用Context
Context，中文也叫做上下文，Go语言在1.7版本中新增的context包中定义了Context，下面我们就来一起看看如何在Go语言中使用Context吧
2023-07-07
一文初探Go语言中的reflect反射包
这篇文章主要和大家分享一下Go语言中的reflect反射包，文中的示例代码讲解详细，对我们学习Go语言有一定的帮助，需要的小伙伴可以参考一下
2022-12-12
Gin框架自带参数校验的使用详解
这篇文章主要为大家详细介绍了如何使用Gin框架自带的参数校验,文中的示例代码讲解详细,具有一定的学习价值,感兴趣的小伙伴可以了解下
2023-09-09
Go语言之Goroutine与信道异常处理
这篇文章主要给大家介绍得是Go语言Goroutine与信道异常处理，Goroutine 之间通信是通过 channel 通信的，想详细了解得小伙伴跟小编一起来学习下面文章内容吧
2021-10-10
golang使用sync.Once实现懒加载的用法和坑点详解
这篇文章主要为大家详细介绍了golang使用sync.Once实现懒加载的用法和坑点,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
2023-11-11
GO语言实现简单TCP服务的方法
这篇文章主要介绍了GO语言实现简单TCP服务的方法,实例分析了Go语言实现TCP服务的技巧,需要的朋友可以参考下
2015-03-03
go protobuf 详解
Protobuf是Protocol Buffers的简称，它是Google公司开发的一种数据描述语言，是一种轻便高效的结构化数据存储格式，可以用于结构化数据串行化，或者说序列化，这篇文章主要介绍了protobuf 详解,需要的朋友可以参考下
2024-01-01
GPT回答 go语言和C语言数组操作对比
这篇文章主要为大家介绍了GPT回答的go语言和C语言数组操作方法对比,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-10-10
jenkins构建go及java项目的方法
这篇文章主要介绍了jenkins构建go及java项目,本文通过图文实例相结合给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值了，需要的朋友可以参考下
2021-04-04
golang chan传递数据的性能开销详解
这篇文章主要为大家详细介绍了Golang中chan在接收和发送数据时因为“复制”而产生的开销,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下
2024-01-01