Gson 优雅实现多个枚举的自定义（反）序列化过程

最新推荐文章于 2025-11-07 12:43:30 发布

原创

最新推荐文章于 2025-11-07 12:43:30 发布 · 置顶 · 8.2k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#gson

本文介绍了如何使用Gson优雅地实现多个枚举的自定义序列化和反序列化。通过实现JsonSerializer和JsonDeserializer接口，避免了大量重复代码。文章展示了具体步骤，包括定义接口、实现接口的枚举类，以及创建自定义序列化器。测试结果显示了预期效果，强调了泛型、接口和枚举特性的综合运用。

`JDK`版本

JDK版本.jpg

`Gson`版本

    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.7</version>
    </dependency>

　　Gson是实现对象序列化和反序列化的利器，但是Gson在（反）序列化枚举时默认是根据枚举值的名称来实现的，如果你想要在（反）序列化枚举时输出自己定义的枚举属性，那么此时至少有两种选择：

继承TypeAdapter抽象类并实现其中的抽象方法
实现JsonSerializer 和/或JsonDeserializer 接口

我通常是选择第二种方式，即实现接口的方式来自定义（反）序列化过程。比如下面这个实例：
针对JDK1.8新的时间API中的LocalDate进行自定义（反）序列化过程：

import com.google.gson.*;
import java.lang.reflect.Type;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;

public class LocalDateTypeAdapter implements JsonSerializer<LocalDate>, JsonDeserializer<LocalDate> {
   
   

    private final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd");

    @Override
    public JsonElement serialize(LocalDate src, Type typeOfSrc, JsonSerializationContext context) {
        return null == src ? null : new JsonPrimitive(formatter.format(src));
    }

    @Override
    public LocalDate deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
        return null == json ? null : LocalDate.parse(json.getAsString(), formatter);
    }

}

　　当注册了该TypeAdapter的Gson在序列化LocalDate类型时，会调用其中的serialize方法，此时如果LocalDate实例非空的话，我们将调用formatter.format(src)方法将LocalDate实例格式化成指定形式的字符串，然后封装成JsonPrimitive实例并返回Gs

最低0.47元/天解锁文章