Gson反序列化可空可选属性时null字段未触发自定义反序列化器问题
问题根因
Gson 内置反序列化流程存在默认短路规则:当解析到对象字段对应的 JSON 节点为 JsonNull 类型时,会直接跳过注册的自定义反序列化器调用,将目标字段赋值为 null 后直接返回,完全不会把 JsonNull 作为入参传递给自定义逻辑。这就是测试中遇到的「JSON显式给fieldTwo传null时,自定义反序列化器无日志输出、字段直接变成null」的本质原因。
此外当前实现还有一个隐形缺陷:仅注册无泛型感知能力的JsonDeserializer做类型层级适配,无法稳定处理带泛型参数的OptionalProperty<String?>这类嵌套类型,本身的拦截边界也被Gson的null短路逻辑完全覆盖。
修复方案
目前Gson生态没有开箱即用的「区分字段缺失/显式null」的Optional适配方案,通用实现思路是通过完整TypeAdapter覆盖null值的短路逻辑,具体步骤如下:
1. 实现可感知null值的TypeAdapter
纯JsonDeserializer的拦截范围不覆盖null值分支,需要实现完整TypeAdapter,显式区分「JSON值为null」和「字段缺失」两类场景:
// 处理单类OptionalProperty的TypeAdapter class OptionalPropertyTypeAdapter<T>(private val valueType: Type) : TypeAdapter<OptionalProperty<T>>() { override fun write(out: JsonWriter, value: OptionalProperty<T>?) { when (value) { // 存在值的场景按实际类型序列化 is OptionalProperty.Present -> { val valueAdapter = Gson().getAdapter(TypeToken.get(valueType)) valueAdapter.write(out, value.value) } // 字段不存在的场景不输出对应JSON键 OptionalProperty.NotPresent -> out.nullValue() null -> out.nullValue() } } override fun read(input: JsonReader): OptionalProperty<T> { // *核心拦截*:读取JSON时先判断当前token是不是null if (input.peek() == JsonToken.NULL) { input.nextNull() // 显式null值 语义为Present且内部值为null return OptionalProperty.Present(null) } // 非null值按原有逻辑反序列化 val jsonElement = JsonParser.parseReader(input) val parsedValue = Gson().fromJson<T>(jsonElement, valueType) return OptionalProperty.Present(parsedValue) } }
2. 配套实现TypeAdapterFactory解决泛型解析
需要通过工厂类动态获取每个OptionalProperty字段对应的内部泛型参数,避免强转类型带来的运行时异常:
class OptionalPropertyAdapterFactory : TypeAdapterFactory { override fun <T> create(gson: Gson, type: TypeToken<T>): TypeAdapter<T>? { // 仅对OptionalProperty类型生效 if (!OptionalProperty::class.java.isAssignableFrom(type.rawType)) return null // 提取OptionalProperty<X>中的实际值类型X val valueType = (type.type as ParameterizedType).actualTypeArguments[0] return OptionalPropertyTypeAdapter<Any>(valueType) as TypeAdapter<T> } }
3. 调整Gson初始化配置
替换原有注册逻辑,关闭null值的短路跳过:
val gson = GsonBuilder() .registerTypeAdapterFactory(OptionalPropertyAdapterFactory()) .serializeNulls() // *关键配置*:不跳过null值的自定义适配器流程 .create()
修复后的语义匹配校验
按上述实现跑通原有三个测试用例,可完全符合部分更新API的语义要求:
- JSON中完全缺失对应字段:沿用data class的默认值
OptionalProperty.NotPresent,表示字段无需更新 - JSON中对应字段为非null值:返回
OptionalProperty.Present(对应解析值),表示需更新为该值 - JSON中对应字段显式为
null:返回OptionalProperty.Present(null),表示需将字段更新为null
内容的提问来源于stack exchange,提问作者amp
相关产品推荐
相关产品推荐

