如何控制Go编码JSON数据时的行为
今天来聊一下我在Go中对数据进行 JSON 编码时遇到次数最多的三个问题以及解决方法,大家来看看是不是也为这些问题挠掉了不少头发。
自定义JSON键名
这个问题加到文章里我是有所犹豫的,因为基本上大家都会,不过属于同类问题我还是放进来了,对新接触 Go
的同学更友好些。
我们先从最常见的一个问题说,首先在Go 程序中要将数据编码成JSON 格式时通常我们会先定义结构体类型,将数据存放到结构体变量中。
type Address struct {Type stringCity string Country string
}type CreditCard struct {FirstName stringLastName stringAddresses []*AddressRemark string
}home := &Address{"private", "Aartselaar", "Belgium"}
office := &Address{"work", "Boom", "Belgium"}
card := VCard{"Jan", "Kersschot", []*Address{home, office}, "none"}js, err := json.Marshal(card)
fmt.Printf("JSON format: %s", js)
只有导出的结构体成员才会被编码,这也就是我们为什么选择用大写字母开头的字段名称。在编码时,默认使用结构体字段的名字作为JSON对象中的key
,但是一般JSON 是给HTTP接口
返回数据使用的,在接口的规范里针对数据我们一般都要求返回snake case
风格的字段名。解决这个问题的方法是在结构体声明时在结构体字段标签里可以自定义对应的JSON key
所以我们把结构体声明改为如下即可:
type Address struct {Type string `json:"type"`City string `json:"city"`Country string `json:"country"`
}
编码JSON时忽略掉指定字段
并不是所有数据我们都期望编码到JSON
中暴露给外部接口的,所以针对一些敏感的字段我们往往希望将其从编码后的JSON
数据中忽略掉。那么上面也说了只有导出的结构体成员才会被编码,有的同学会问我直接用小写的字段名不行吗?可是未导出字段只能在包内访问,像这种携带内部敏感数据的往往都是应用的基础数据,由项目的公共包来提供的。那么怎么既能维持字段的导出性又能让其在JSON
数据中被忽略掉呢? 还是使用结构体的标签进行注解,比如下面定义的结构体,可以把身份证IdCard
字段在JSON
数据中去掉:
type User struct {Name string `json:"name"`Age Int `json:"int"`IdCard string `json:"-"`
}
encoding/json
的源码中和文档中都列举了通过结构体字段标签控制数据JSON
编码行为的说明:
// Field is ignored by this package.
Field int `json:"-"`// Field appears in JSON as key "myName".
Field int `json:"myName"`// Field appears in JSON as key "myName" and
// the field is omitted from the object if its value is empty,
// as defined above.
Field int `json:"myName,omitempty"`// Field appears in JSON as key "Field" (the default), but
// the field is skipped if empty.
// Note the leading comma.
Field int `json:",omitempty"`
omitempty
这个是字段的数据为空时,在JSON
中省略这个字段。为的是节省数据空间,Protobuf
编译器生成的结构体代码中每个字段标签中都有omitempty
。但是在Api
开发中这个不常用,因为字段不固定对前端很不友好。
对Protobuf
不了解的可以看我之前写的文章《Protobuf语言指南》。
结构体字段标签的json
注解中都不加omitempty
后还遇到一种情况,就是数据类型为切片的字段在数据为空的时候会被JSON
编码为null
而不是[]
。这个前端经常会问我没数据的时候能不能不要返回null
,每回还要多写一个判断。我的说辞都是不能,其实规范点讲是应该返回[]
的知识我是我自己没找到到解决方法。作为一个在写代码上有强迫症的人,这个问题还是想搞明白的,好在有一天在StackOverflow
上看到一个答案,才发现是编码的疏忽导致的。
解决空切片在JSON里被编码成null
因为切片的零值为nil
,无指向内存的地址,所以当以这种形式定义var f []int
初始化slice
后,在JSON中将其编码为null
,如果想在 JSON 中将空 slice 编码为[]
则需用make初始化 slice为其分配内存地址:
运行下面的例子可以看出两点的区别:
package mainimport ("encoding/json""fmt"
)type Person struct {Friends []string
}func main() {var f1 []stringf2 := make([]string, 0)json1, _ := json.Marshal(Person{f1})json2, _ := json.Marshal(Person{f2})fmt.Printf("%s\n", json1)fmt.Printf("%s\n", json2)
}
输出:
{"Friends":null}
{"Friends":[]}
其实导致这个问题的原因是Go的append
函数(甩锅),我们都知道引用类型的变量定义后如果没初始化他们的值是nil
,无指向内存的地址,是无法直接使用的。但是append
函数在给切片追加元素时会判断切片是否已初始化,没有的话会帮其初始化分配底层数组。我的习惯是先声明切片,然后再在下面的循环代码中向切片追加元素。但是如果循环没有执行,比如你从数据库没查出数据,就会导致对应切片字段在无数据时返回的是nil
然后被JSON
编码成了null
。所以这个算是一个经验总结出来的Tip
吧在写代码时大家一定要注意了。
这就是我在开发时把数据编码成JSON
格式时遇到的三个问题和相应的解决方法。加上之前写的解析JSON的文章,两个文章加起来差不多就能汇总日常开发中关于encoding/json
库使用的各种问题了。
扫码下方二维码关注公众号第一时间获取有价值的技术原创文章。
如何控制Go编码JSON数据时的行为相关推荐
- InputStream读JSON数据时乱码
注意:本文案例信息:IDE是eclipse,post请求服务器,返回JSON数据. 先上代码: BufferedReader reader = new BufferedReader(new Input ...
- MVC中利用ViewBag传递Json数据时的前端处理方法
** MVC中利用ViewBag传递Json数据时的前端处理方法 ** 用viewBag传递Json字符串到前端时,json字符串中的"会被转义为& quot,前端处理方法为@Htm ...
- 使用@RequestBody 接收前端传到后端的json数据时,页面出现415,获取不到Cookie
文章目录 1.使用@RequestBody 接收前端传到后端的json数据时,页面出现415 2.获取Cookie时,使用F12,查看Cookie储存时的路径,只有路径一致才可以获取Cookie 3. ...
- Jsoncpp解析中国地区编码JSON数据
一.中国地区编码JSON数据 {"086":["中国","0"],"110000":["北京",&q ...
- string类型比较_redis存json数据时选择string还是hash
我们在缓存json数据到redis时经常会面临是选择string类型还是选择hash类型去存储.接下来我从占用空间和IO两方面来分析这两种类型的优势. 1.占用空间 根据数据结构的共识我们知道hash ...
- js的eval函数解析后台返回的json数据时为什加上圆括号eval((+data+)),而HTML页面定义的数据不用...
一,情况如下,这是成功代码: $(function () {$.ajax({url: "Demo.aspx",type: "post",data: { Id: ...
- springmvc 使用fastjson 处理 json 数据时中文乱码
2019独角兽企业重金招聘Python工程师标准>>> 原因: springmvc在处理请求时,默认采用的是 ISO-8859-1 编码格式,具体原因不了解,个人觉得是还没有来得及 ...
- IE请求json数据时出现下载文件的现象。
当使用IE浏览器请求服务器时,会出现下载json文件的现象,就需要在spring-MVC.xml文件里配置: <bean class="org.springframework.http ...
- javascript eval函数解析json数据时为什加上圆括号eval((+data+))
原因很简单:因为在js中{}表示一个语句块(代码段),所有加上"()"表示表达式 转载于:https://www.cnblogs.com/lihongchen/p/4270334. ...
最新文章
- android 渲染流程
- c语言中time相关函数
- (转帖)开源容器集群管理系统Kubernetes架构及组件介绍
- linux内核定时器使用
- python解析xml+得到pascal voc xml格式用于目标检测+美化xml
- 如何将php改成mp4,PHP 将视频转成 MP4 并获取视频预览图(用到ffmpeg)
- netty 发送 http请求
- 检查xml文件中包含非法xml字符的个数(
- ORA-01795: 列表中的最大表达式数为1000的解决方法
- HDU 3416 Marriage Match IV
- iOS自己定义返回button(不影响返回手势)
- android soundpool 封装,Android 音频播放之SoundPool的使用和封装
- linux中文件颜色代表的含义
- java quicktime_Java Media Development with QuickTime for Java
- WLC5508 HA ( AP SSO)
- GND-VDD-VCC-VSS-VEE-VPP-GND
- Matplotlib画图的复杂颜色设置(包括fig, ax, spines, tick)
- [NOI2017]蔬菜
- 永恒之蓝(MS17-010)漏洞复现及msf常用渗透命令
- [Halcon] WriteImage保存图像崩溃问题