重新认识一个强大的 Gson ，从一个线上 BUG 说起

程序员文章站 2024-01-10 23:50:09

...

点击上方“Java基基”，选择“设为星标”

做积极的人，而不是积极废人！

源码精品专栏

来源：cnblogs.com/mafly/p/gson.html

从一个 Bug 说起
重现一下那个 Bug
重新认识一下 Gson
总结一下

从一个 Bug 说起

不知道你们发现没有，你写完的程序无论当时怎么测试，过一段时间总会出 Bug 。再说一个每天都在发生的例子：在你写完一篇博客后，立即检查的话，总是查不出自己写的错别字。

据说这些都包含有一些大脑对当下事物处理的逻辑在里边，而且还有心理学因素在里边，我也不懂。反正现在就是程序出 Bug 了！出 Bug 了！！Bug ！！！

事情是这样的，客户端请求服务器开放接口时，我们是以 JSON 字符串的形式返回的，这时候本来正常返回形式是这样：

{
   "name": "mafly",
   "age": "18",
   "sex": "男"
}

但这个名字叫Mafly的人他不想让你知道他是男是女。就没填性别，程序中默认赋值为 null了，JSON 序列化时就发生了意想不到的事儿。

重现一下那个 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;
}

重新认识一下 Gson

我看了几行 Gson 的源码后，我发现它可配置及特性多的数不胜数，可以用@SerializedName注解给属性重命名，用@Expose注解标识属性不进行序列化，支持 Map 的 key 为复杂对象的形式，日期类型转化为特定格式，还有区分版本进行显示，这些在日常项目中都极常用到，只不过好像我们之前都是自己实现的。

我简单建立了一个 UserInfo 实体类，里边包含了username、age、sex这三个属性值。试着测试了一下其中一两个：

aaa@qq.com 想让谁输出谁输出，注解代码如图：