小编给大家分享一下怎样控制去编码JSON数据时的行为,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获、下面让我们一起去了解一下吧!
<>强自定义JSON键名强>
这个问题加到文章里我是有所犹豫的,因为基本上大家都会,不过属于同类问题我还是放进来了,对新接触<代码> 代码>去的同学更友好些。
我们先从最常见的一个问题说,首先在去程序中要将数据编码成JSON格式时通常我们会先定义结构体类型,将数据存放到结构体变量中。
type Address struct { Type 字符串 ,City string Country 字符串 } type CreditCard  struct { FirstName 字符串 LastName 字符串 Addresses [] *地址 Remark 字符串 } home :=,,地址{“private",,“Aartselaar",,“Belgium"} office :=,,地址{“已经做完,,“Boom",,“Belgium"} card :=,名片{“Jan",,“Kersschot",,[] *地址办公室{,,},,“none"} js, err :=, json.Marshal(卡) fmt.Printf (“JSON 格式:% s",, js)
只有导出的结构体成员才会被编码,这也就是我们为什么选择用大写字母开头的字段名称。在编码时,默认使用结构体字段的名字作为JSON对象中的<代码>键> 代码,但是一般JSON是给HTTP接<代码>口代码>返回数据使用的,在接口的规范里针对数据我们一般都要求返回<代码>蛇情况下代码>风格的字段名。解决这个问题的方法是在结构体声明时在结构体字段标签里可以自定义对应的JSON关键<代码> 代码>
所以我们把结构体声明改为如下即可:
type Address struct { ,Type string “json:“type"” ,City string “json:“city"” ,Country string “json:“country"” }
<强>编码JSON时忽略掉指定字段强>
并不是所有数据我们都期望编码到JSON <代码> 代码>中暴露给外部接口的,所以针对一些敏感的字段我们往往希望将其从编码后的<代码> JSON> 代码数据中忽略掉。那么上面也说了只有导出的结构体成员才会被编码,有的同学会问我直接用小写的字段名不行吗?可是未导出字段只能在包内访问,像这种携带内部敏感数据的往往都是应用的基础数据,由项目的公共包来提供的。那么怎么既能维持字段的导出性又能让其在<代码> JSON> 代码数据中被忽略掉呢?还是使用结构体的标签进行注解,比如下面定义的结构体,可以把身份证<代码>经办人身份证> 代码字段在<代码> JSON> 代码数据中去掉:
type User struct { ,Name string “json:“name"” ,Age Int ,“json:“int"” ,IdCard string “json:“产生绯闻” }
编码/json的源码中和文档中都列举了通过结构体字段标签控制数据json编码行为的说明:
//,Field is ignored by 却;能够包。 Field int “json:“产生绯闻”//,Field appears 拷贝JSON as key “myName"。 Field int “json:“myName"”//,Field appears 拷贝JSON as key “myName"和//,,field is  omitted 得到,object if its value is 空,//,as defined 以上。 Field int “json:“名字,omitempty"”//,Field appears 拷贝JSON as key “Field",(从而违约),但是//,,field is  skipped if 空的。//,Note 从而,leading 逗号。 Field int “omitempty" json:“,”
omitempty这个是字段的数据为空时,在json中省略这个字段。为的是节省数据空间,Protobuf编译器生成的结构体代码中每个字段标签中都有omitempty。但是在Api开发中这个不常用,因为字段不固定对前端很不友好。
对Protobuf不了解的可以看我之前写的文章《Protobuf语言指南》。
结构体字段标签的json注解中都不加omitempty后还遇到一种情况,就是数据类型为切片的字段在数据为空的时候会被json编码为零而不是[]。这个前端经常会问我没数据的时候能不能不要返回零,每回还要多写一个判断。我的说辞都是不能,其实规范点讲是应该返回[]的知识我是我自己没找到到解决方法。作为一个在写代码上有强迫症的人,这个问题还是想搞明白的,好在有一天在StackOverflow上看到一个答案,才发现是编码的疏忽导致的。