Gson Advanced — 通过 @JsonAdapter 自定义(反)序列化过程

原文链接：Gson Advanced — Customizing (De)Serialization via @JsonAdapter
原文出自：Norman Peitek
译者：無名無

之前几篇文章我们介绍了如何使用 Gson 来自定义(反)序列化和自定义实例创建。使用这些都需要依赖 GsonBuilder 的创建过程，还是有些复杂的，在 Gson 2.7 以后引入一个注解来有效的减少代码即 @JsonAdapter，本文就来介绍下 @JsonAdapter 使用。

@JsonAdapter 注解

注意 @JsonAdapter 是在 Gson 2.7 及以后版本才有。

我们已经了解了来自定义(反)序列化的一些流程，就像下面的代码，一样必须遵循这样的规则才可以：

GsonBuilder gsonBuilder = new GsonBuilder();

Type merchantListType = new TypeToken<List<Merchant>>() {}.getType();  
JsonSerializer<List<Merchant>> serializer = ...; // implementation detail  
gsonBuilder.registerTypeAdapter(merchantListType, serializer);

Gson customGson = gsonBuilder.create();  
String customJSON = customGson.toJson(subscription);  

就差一个 JsonSerializer 接口的实现类就齐全了。

自定义序列化

来尝试另一种方式，创建一个 JsonSerializer 的实现类 MerchantListSerializer，注意是类。

public class MerchantListSerializer implements JsonSerializer<List<Merchant>> {  
    @Override
    public JsonElement serialize(List<Merchant> src, Type typeOfSrc, JsonSerializationContext context) {
        JsonArray jsonMerchant = new JsonArray();

        for (Merchant merchant : src) {
            jsonMerchant.add("" + merchant.getId());
        }

        return jsonMerchant;
    }
}

只有是类的形式，我们才能使用注解 @JsonAdapter 来添加 MerchantListSerializer。就像之前的一些注解用法一样，并添加到你需要序列化的 Java model 中。

public class UserSubscriptionAnnotation {  
    String name;
    String email;
    int age;
    boolean isDeveloper;

    // new!
    @JsonAdapter(MerchantListSerializer.class)
    List<Merchant> merchantList;
}

可以看到 merchantList 被添加了 @JsonAdapter(MerchantListSerializer.class) 注解，而 MerchantListSerializer 正是我们序列化过程的实现类，这样我们就不用使用 GsonBuilder 它来创建的 Gson 对象，而是使用默认创建对象就可以，也不需要那些复杂的设置。

UserSubscriptionAnnotation subscription = new UserSubscriptionAnnotation(  
                "Norman",
                "norman@fs.io",
                26,
                true,
                subscribedMerchants);

Gson gson = new Gson();  
String fullJSON = gson.toJson(subscription);  

这里使用 new Gson() 即可。

自定义反序列化

下面是之前反序列化的例子：

GsonBuilder gsonBuilder = new GsonBuilder();

JsonDeserializer<UserDate> deserializer = ...; // implementation detail  
gsonBuilder.registerTypeAdapter(UserDate.class, deserializer);

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

和序列化类似，我们创建一个 JsonDeserializer 的实现类 UserDateDeserializer，这里也是单独的类。

public class UserDateDeserializer implements 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
        );
    }
}

和序列化不同的是，@JsonAdapter(UserDateDeserializer.class) 注解是要添加在类级别上面，这是一点不同。

多个自定义情况

我们刚才的例子只是注解在一个变量，或者一个类，唯一的缺点是只能实现我们一种功能，如果你需要多个自定义，那就的使用之前的方法，通过 GsonBuilder 来创建。

目标

学习使用 @JsonAdapter 注解，也要明白 @JsonAdapter 的局限性。

练习代码已上传 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 - 如何解析多态对象