重新认识一个强大的 Gson
点击上方 "程序员小乐" ，关注公众号
8点20分，第一时间与你相约
每日英文
If you don't know what you want, you won't know when you've gotten it.
如果你不知道自己想要的是什么，那么当你拥有了也会茫然不知。
小乐有话说
天空不总是晴朗，阳光也不总是闪耀。很多事情，当经历过，自己知道就好，很多改变，不需要说出来的，自己明白就好。
来自：Mafly | 链接：cnblogs.com/mafly/p/gson.html
责编：乐乐 | 封面来自网络
小乐对你说
大家早上好，今天小乐给大家带来了Gson，相信对大家一定有所帮助！
01 从一个 Bug 说起
不知道你们发现没有，你写完的程序无论当时怎么测试，过一段时间总会出 Bug 。再说一个每天都在发生的例子：在你写完一篇博客后，立即检查的话，总是查不出自己写的错别字。
据说这些都包含有一些大脑对当下事物处理的逻辑在里边，而且还有心理学因素在里边，我也不懂。反正现在就是程序出 Bug 了！出 Bug 了！！Bug ！！！
事情是这样的，客户端请求服务器开放接口时，我们是以 JSON 字符串的形式返回的，这时候本来正常返回形式是这样：
{
"name": "mafly",
"age": "18",
"sex": "男"
}但这个名字叫Mafly的人他不想让你知道他是男是女。就没填性别，程序中默认赋值为 null了，JSON 序列化时就发生了意想不到的事儿。
02 重现一下那个 Bug
用于转换Java对象为 Json 字符串和把 Json 字符串转换为对象的工具类有很多，Gson、Jackson、FastJson等，我们用的是 Gson， 它是 Google 开发的，还据传说它的性能比较强大一些。嗯，对，我们用的就是这个。先看示例代码：
public static void main(String[] args) {
HashMap<String, Object> map = new HashMap<String, Object>();
map.put("name", "mafly");
map.put("age", "18");
map.put("sex", null);
String jsonString = new Gson().toJson(map);
System.err.println(jsonString);
}你猜会输出上面那段我们预期的 Json 串吗？然而并不会。
就是这个当 Sex=null时，用 Gson 的tojson方法会把 null 值忽略，从而序列化之后输出不包含这个属性值的 Json 串。其实我们的预期是输出 {"sex": ""} 或 {"sex": null}， 那怎么做呢？
通过搜索引擎发现，网上大概存在以下三种解决方案：
调用 toJson(Object src, Type typeOfSrc, JsonWriter writer) 方法
注册自定义 TypeAdapter
设置 serializeNulls 属性值（推荐)
前两种方式我没测试，推荐第三种方式，简单方便，源码如下：
GsonBuilder gsonBuilder = new GsonBuilder();
String jsonString1 = gsonBuilder.serializeNulls().create().toJson(map);
System.err.println(jsonString1);输出符合我们的需求了， {"sex": null}，如图：
简单转到源码看了看，除了这一个设置还有很多，真是太方便了。调用serializeNulls()后， Gson 设置 serializeNulls 属性值为 true，默认是false，源码:
public GsonBuilder serializeNulls() {
this.serializeNulls = true;
return this;
}03 重新认识一下 Gson
我看了几行 Gson 的源码后，我发现它可配置及特性多的数不胜数，可以用@SerializedName注解给属性重命名，用@Expose注解标识属性不进行序列化，支持 Map 的 key 为复杂对象的形式，日期类型转化为特定格式，还有区分版本进行显示，这些在日常项目中都极常用到，只不过好像我们之前都是自己实现的。
我简单建立了一个 UserInfo 实体类，里边包含了username、age、sex这三个属性值。试着测试了一下其中一两个：
1.@Expose 想让谁输出谁输出，注解代码如图：
设置excludeFieldsWithoutExposeAnnotation()，看下面第三行是输出：
2.@SerializedName 想怎么显示怎么显示，注解代码如图：
我想把age再 Json序列化时显示maflyAge，现在就可以了，输出如下图：
3.@Since、@Until 不同版本不同数据，注解代码如图：
这里要设置setVersion(3.2)，@Since标注的在 3.2 版本或之后才会输出，@Until标注的只在 3.2 版本前才有。效果输出如下图：
当然，还有好多特性呢，比如字段首字母大写阿、结果格式化阿等等，我这里抛个砖，剩下的有需要的可以试试。
04 总结
这是由于一个 Json 序列化输出后发现的小 Bug ，也可以说不能算 Bug ，因为是我们对于自己使用的工具类并不了解导致的，所以，去试着了解你使用的任何一个开源工具类或项目，对于遇到的问题可以很好的得到解决，从而也可以提升自己吧。
今日话题
请在留言区说说你对Gson的理解，小乐期待你的留言，让我们共同养成好习惯！
猜你还想看
深入剖析二分搜索树的原理与Java源码实现
这里有技术、心得、算法、职场、感悟、面经，做一个有趣的帮助程序员成长的公众号。看完本文有收获？请转发分享给更多人。
PS：如何您想进技术群交流，关注公众号在后台回复 “加群”，或者 “学习” 即可。