如何让 Gson 在反序列化时将 null 字段自动替换为空集合而非 null

聖光之護

聖光之護

2026-07-11

899人浏览

原创

如何让 Gson 在反序列化时将 null 字段自动替换为空集合而非 null

Gson 默认会将 JSON 中的 null 值直接赋给字段,导致集合类型字段为 null;本文介绍通过自定义 TypeAdapter 实现「null → 空集合」的统一转换策略,避免为每个类重复编写逻辑,同时对比 Jackson 的原生支持方案。

gson 默认会将 json 中的 `null` 值直接赋给字段,导致集合类型字段为 null;本文介绍通过自定义 typeadapter 实现「null → 空集合」的统一转换策略,避免为每个类重复编写逻辑,同时对比 jackson 的原生支持方案。

在使用 Gson 进行 JSON 反序列化时,若目标字段声明为 List 且 JSON 中对应键值为 null(如 "list": null),Gson 默认会将该字段设为 null,而非保留其初始化值(如 new ArrayList())。这与开发者预期不符——尤其当业务代码频繁调用 list.size() 或 list.forEach(...) 时,极易触发 NullPointerException。

根本原因在于:Gson 不会跳过 null 字段的赋值,即使字段已在类中声明了非 null 的默认值(如 private final List list = new ArrayList();)。构造器或字段初始化仅在对象实例化时生效,而 Gson 的反射机制会绕过该初始化,直接对字段进行赋值(包括 null)。

✅ 正确解决方案:注册泛型 Collection TypeAdapter

无需为每个集合类型单独注册适配器,只需一个通用 TypeAdapter 即可覆盖所有 Collection 子类型(List、Set、Queue 等):

import com.google.gson.*;
import com.google.gson.reflect.TypeToken;
import java.lang.reflect.Type;
import java.util.*;

public class EmptyCollectionTypeAdapterFactory implements TypeAdapterFactory {
    @Override
    public <t> TypeAdapter<t> create(Gson gson, TypeToken<t> typeToken) {
        Type type = typeToken.getType();
        if (type instanceof Class && Collection.class.isAssignableFrom((Class>) type)) {
            // 使用原始类型适配器,避免泛型擦除问题
            return (TypeAdapter<t>) new CollectionTypeAdapter(gson);
        }
        return null;
    }

    private static class CollectionTypeAdapter extends TypeAdapter<collection>> {
        private final Gson gson;

        CollectionTypeAdapter(Gson gson) {
            this.gson = gson;
        }

        @Override
        public void write(JsonWriter out, Collection> value) throws IOException {
            if (value == null) {
                out.nullValue();
            } else {
                gson.getAdapter(Collection.class).write(out, value);
            }
        }

        @Override
        public Collection> read(JsonReader in) throws IOException {
            JsonElement element = JsonParser.parseReader(in);
            if (element.isJsonNull()) {
                return new ArrayList(); // 统一返回空 ArrayList,也可按需返回 LinkedHashSet 等
            }
            // 非 null 时委托给默认适配器解析
            return gson.fromJson(element, Collection.class);
        }
    }
}</collection></t></t></t></t>

使用方式(全局生效):

Claude
Claude

Anthropic发布的与ChatGPT竞争的聊天机器人

下载
Gson gson = new GsonBuilder()
    .registerTypeAdapterFactory(new EmptyCollectionTypeAdapterFactory())
    .create();

String json = "{\"userName\":\"test\",\"eMailAddress\":\"test@example.com\",\"list\":null}";
User user = gson.fromJson(json, User.class);
System.out.println(user.getList()); // 输出: []

⚠️ 注意事项:

  • 该适配器仅作用于 Collection 接口及其子类型(List/Set/Deque),不适用于数组或 Map;
  • 若需支持 Map,需额外注册 Map 专用适配器;
  • final 字段仍需确保 Gson 有写入权限(推荐使用 @SerializedName + 无参构造器,或启用 GsonBuilder().excludeFieldsWithoutExposeAnnotation() 配合 @Expose 控制);
  • 不建议在 deserialize() 中递归调用 new Gson().fromJson(...)(如原问题中的错误示例),会导致无限递归或类型丢失。

? 替代方案:改用 Jackson(更简洁)

Jackson 原生支持此行为:只要字段已初始化(如 private List list = new ArrayList();),且未显式传入 null,则自动保留初始化值;即使传入 "list": null,配合 @JsonSetter(nulls = Nulls.SKIP) 也可跳过赋值:

import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.Nulls;

public class User {
    private String userName;
    private String email;
    private List<object> list = new ArrayList();

    @JsonSetter(nulls = Nulls.SKIP)
    public void setList(List<object> list) {
        this.list = list != null ? list : new ArrayList();
    }
}</object></object>

但若坚持使用 Gson,上述 TypeAdapterFactory 是最健壮、可复用的工程级解法——它集中处理所有集合类型,零侵入原有模型类,且兼容泛型。

总结:Gson 的 null 集合问题本质是设计取舍,而非缺陷。通过 TypeAdapterFactory 统一拦截并转换,既能保持代码简洁性,又能彻底规避 NPE 风险,是微服务、DTO 层 JSON 解析场景下的推荐实践。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

3838

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

2838

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

2853

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

637

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

602

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

705

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1314

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

18844

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

646

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.4万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 131.8万人学习