Gson Advanced — 自定义反序列化基础

原文链接：Gson Advanced — Custom Deserialization Basics
原文出自：Norman Peitek
译者：無名無

本文将介绍使用 Gson 自定义反序列化基础，我们很多情况是客户端不需要完全匹配服务端返回的 JSON 数据。

自定义反序列化

应用中很常见 Server 端返回数据并不是我们想要的结构，这种情况就需要我们自定义解析器，使用原始的 JSON 数据，转换成 Java 常见的数据结构或者自定义 model。

来看个 JSON：

｛       
    "year": 116,
    "month": 5,
    "day": 21,
    "age": 26,
    "email": "norman@futurestud.io",
    "isDeveloper": true,
    "name": "Norman"
}

分析以上 JSON，发现有些字段之间没有任何关系，前三个表示年月日，是一个日期结构，后面四个字段表示一个 model 信息，是完全不同的两种类型，所以我们要分开组装成不同的对象。

更好的办法是在解析的内部就搞定它，来看实例：

public class UserDate {  
    private String name;
    private String email;
    private boolean isDeveloper;
    private int age;
    private Date registerDate;
}

之前已经了解过了序列化的自定义实现，这里使用的方法也是一样的 registerTypeAdapter() 但是实现类变成了 JsonDeserializer ,重写的方法也变成了 deserialize() 就不多介绍方法了。

GsonBuilder gsonBuilder = new GsonBuilder();

JsonDeserializer<UserDate> deserializer = ...; // will implement in a second  
gsonBuilder.registerTypeAdapter(UserDate.class, deserializer);

Gson customGson = gsonBuilder.create();  
UserDate customObject = customGson.fromJson(userJson, UserDate.class);  

关键是 JsonDeserializer 的实现，同样需要重写 deserialize() 方法，并返回值也是 JsonElement，所以这里我们要根据自己需求组装我们的 model，具体过程看代码：

// change serialization for specific types
JsonDeserializer<UserDate> deserializer = new JsonDeserializer<UserDate>() {  
    @Override
    public UserDate deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
        JsonObject jsonObject = json.getAsJsonObject();

        Date date = new Date(
                jsonObject.get("year").getAsInt(),
                jsonObject.get("month").getAsInt(),
                jsonObject.get("day").getAsInt()
        );

        return new UserDate(
                jsonObject.get("name").getAsString(),
                jsonObject.get("email").getAsString(),
                jsonObject.get("isDeveloper").getAsBoolean(),
                jsonObject.get("age").getAsInt(),
                date
        );
    }
};

可以看到这里不在是一个 new JsonObject()，而是 json.getAsJsonObject()，这里我们通过 JsonObject 的 get 方式，来获取单个字段值，同时需要指定字段值的类型，最后组装并返回我们想要的 UserDate 类型数据。

实际中需要注意的是：记得使用 has() 方法来检查字段是否存在，以防出现 NullPointerExceptions 异常。

目标

学习 Gson 自定义反序列化，了解反序列化这个过程。

练习代码已上传 Github https://github.com/whiskeyfei/Gson-Review 可自行查看。

Gson 系列文章翻译回顾

1、Gson - Java-JSON 序列化和反序列化入门
2、Gson - 映射嵌套对象
3、Gson - Arrays 和 Lists 映射对象
4、Gson - Map 结构映射
5、Gson - Set 集合映射
6、Gson - 空值映射
7、Gson Model Annotations - 如何使用 @SerializedName 更改字段的命名
8、Gson Model Annotations - @SerializedName 匹配多个反序列化名称
9、Gson Builder - 基础和命名规则
10、Gson Builder - 序列化空值
11、Gson Builder - 忽略策略
12、Gson Builder - Gson Lenient 属性
13、Gson Builder - 特殊类型 Floats & Doubles
17、Gson Builder - 如何使用 @Expose 忽略字段
19、Gson Advanced - 映射枚举类型
20、Gson Advanced - 映射循环引用
21、Gson Advanced - 泛型
22、Gson Advanced - 简单自定义序列化 (Part 1)
24、Gson Advanced - 自定义反序列化基础
25、Gson Advanced - 自定义对象实例创建
26、Gson Advanced - 通过 @JsonAdapter 自定义(反)序列化过程
32、Practical Gson - 如何解析多态对象