3步搞定复杂JSON！Gson自定义反序列化器实战指南-优快云博客

3步搞定复杂JSON！Gson自定义反序列化器实战指南

【免费下载链接】gson A Java serialization/deserialization library to convert Java Objects into JSON and back 项目地址: https://gitcode.com/gh_mirrors/gs/gson

你是否还在为嵌套JSON结构解析头痛？当API返回的JSON格式与Java对象不匹配时，手动映射字段既繁琐又易错。本文将通过3个简单步骤，教你使用Gson自定义反序列化器轻松处理复杂JSON，让数据解析效率提升10倍！读完你将掌握：自定义反序列化器的创建方法、注册流程以及实战案例解析。

为什么需要自定义反序列化器？

默认情况下，Gson通过反射机制将JSON字段与Java对象字段直接映射。但在实际开发中，我们经常遇到以下场景：

JSON结构嵌套过深或字段命名不规则
需要根据JSON内容动态创建不同类型对象
解析时需进行数据转换或验证

这时就需要自定义反序列化逻辑。Gson提供了JsonDeserializer接口，允许开发者完全控制JSON到Java对象的转换过程。核心接口定义如下：

public interface JsonDeserializer<T> {
  T deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context)
      throws JsonParseException;
}

源码路径：gson/src/main/java/com/google/gson/JsonDeserializer.java

步骤1：创建自定义反序列化器

假设我们需要解析以下复杂JSON：

{
  "data": {
    "id": "123",
    "user_info": {
      "name": "张三",
      "register_date": "2023-10-26"
    },
    "tags": ["VIP", "new"]
  }
}

我们希望将其映射到一个扁平化的User对象。首先创建反序列化器：

public class UserDeserializer implements JsonDeserializer<User> {
  @Override
  public User deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) 
      throws JsonParseException {
    
    JsonObject root = json.getAsJsonObject();
    JsonObject data = root.getAsJsonObject("data");
    JsonObject userInfo = data.getAsJsonObject("user_info");
    
    User user = new User();
    user.setId(data.get("id").getAsString());
    user.setName(userInfo.get("name").getAsString());
    
    // 日期格式转换
    String dateStr = userInfo.get("register_date").getAsString();
    try {
      user.setRegisterDate(new SimpleDateFormat("yyyy-MM-dd").parse(dateStr));
    } catch (ParseException e) {
      throw new JsonParseException("日期格式错误", e);
    }
    
    // 处理数组
    JsonArray tagsArray = data.getAsJsonArray("tags");
    List<String> tags = new ArrayList<>();
    for (JsonElement element : tagsArray) {
      tags.add(element.getAsString());
    }
    user.setTags(tags);
    
    return user;
  }
}

步骤2：注册反序列化器

创建好反序列化器后，需要通过GsonBuilder将其注册到Gson实例中：

Gson gson = new GsonBuilder()
    .registerTypeAdapter(User.class, new UserDeserializer())
    .setDateFormat("yyyy-MM-dd") // 全局日期格式
    .create();

注册方法源码：gson/src/main/java/com/google/gson/GsonBuilder.java

GsonBuilder还支持更多高级配置，如设置字段命名策略、日期格式、空值处理等。完整配置选项可参考官方文档。

步骤3：使用自定义反序列化器

注册完成后，就可以像使用普通Gson实例一样进行反序列化：

String json = "{...}"; // API返回的JSON字符串
User user = gson.fromJson(json, User.class);
System.out.println(user.getName()); // 输出：张三

实战案例：多类型对象解析

更复杂的场景是根据JSON中的某个字段动态返回不同类型的对象。例如，API返回不同类型的消息：

{
  "type": "text",
  "content": "Hello World"
}

{
  "type": "image",
  "url": "https://example.com/image.jpg",
  "width": 800,
  "height": 600
}

我们可以创建一个Message基类和两个子类TextMessage、ImageMessage，然后通过反序列化器动态选择类型：

public class MessageDeserializer implements JsonDeserializer<Message> {
  @Override
  public Message deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) 
      throws JsonParseException {
    
    JsonObject jsonObject = json.getAsJsonObject();
    String type = jsonObject.get("type").getAsString();
    
    switch (type) {
      case "text":
        return context.deserialize(json, TextMessage.class);
      case "image":
        return context.deserialize(json, ImageMessage.class);
      default:
        throw new JsonParseException("未知消息类型: " + type);
    }
  }
}

类似实现可参考测试用例：gson/src/test/java/com/google/gson/functional/CustomDeserializerTest.java