Gson反序列化时如何检测字段不匹配或缺失并抛出异常？

默认情况下Gson会忽略JSON中目标类不存在的字段，导致你遇到的“静默失败”——字段不匹配时仅初始化默认值，无异常抛出。以下是两种可靠的解决方法：

方法一：启用严格模式（推荐） #

通过GsonBuilder配置禁用未知字段，让Gson在遇到类中不存在的JSON字段时直接抛出异常，及时感知问题：

private static class A {
    int x;
}

public static void main(String[] args) {
    // 构建启用未知字段检测的Gson实例
    Gson gson = new GsonBuilder()
            .disableUnknownFields()
            .create();
    A a;
    try {
        Reader reader = new StringReader("{\"y\":10}");
        a = gson.getAdapter(A.class).fromJson(reader);
    } catch (IOException | JsonSyntaxException e) {
        System.out.println("JSON格式异常：" + e.getMessage());
        return;
    }
}

运行这段代码时，JSON中的y字段会触发JsonSyntaxException，提示Unknown field "y" (class com.example.A), not marked as ignorable，直接暴露字段不匹配的问题。

方法二：自定义TypeAdapter实现灵活校验 #

如果需要更精细的控制（比如记录未知字段而非直接抛出异常），可以自定义TypeAdapter手动校验字段：

private static class A {
    int x;
}

private static class ATypeAdapter extends TypeAdapter<A> {
    private final Gson gson = new Gson();
    // 定义目标类的预期字段集合
    private final Set<String> EXPECTED_FIELDS = new HashSet<>(Arrays.asList("x"));

    @Override
    public void write(JsonWriter out, A value) throws IOException {
        gson.getAdapter(A.class).write(out, value);
    }

    @Override
    public A read(JsonReader in) throws IOException {
        JsonObject jsonObject = gson.getAdapter(JsonObject.class).read(in);
        // 遍历JSON字段，检查是否全部匹配预期
        for (Map.Entry<String, JsonElement> entry : jsonObject.entrySet()) {
            String fieldName = entry.getKey();
            if (!EXPECTED_FIELDS.contains(fieldName)) {
                throw new JsonSyntaxException("发现未定义字段：" + fieldName);
                // 若不需要抛出异常，也可改为日志记录：
                // System.out.println("警告：发现未定义字段" + fieldName);
            }
        }
        // 完成校验后反序列化目标对象
        return gson.fromJson(jsonObject, A.class);
    }
}

public static void main(String[] args) {
    Gson gson = new GsonBuilder()
            .registerTypeAdapter(A.class, new ATypeAdapter())
            .create();
    A a;
    try {
        Reader reader = new StringReader("{\"y\":10}");
        a = gson.fromJson(reader, A.class);
    } catch (IOException | JsonSyntaxException e) {
        System.out.println("JSON校验异常：" + e.getMessage());
        return;
    }
}

额外说明 #

• 对于int这类基本数据类型，Gson默认会在未匹配到对应字段时初始化默认值（如0），启用未知字段检测后可彻底避免这种无感知的错误。
• 若目标类存在继承关系，disableUnknownFields()会递归检查父类和子类的所有字段，确保JSON字段完全匹配。

内容的提问来源于stack exchange，提问作者Timofey X