Retrofit模型类如何配置可选请求键,按需移除指定请求参数
Retrofit 实现请求参数可携带/可完全移除的落地方法
需求核心矛盾:现有序列化规则会在param1为null时输出
"param1": null的键值对,我们需要支持两种灵活复用的场景:
- 业务需要传递param1时,正常输出键和对应参数值
- 业务不需要传递param1时,彻底把这个键从请求JSON结构里删掉,不能残留null值的键对
没必要踩的坑
- 拆成两个Request子类(一个带param1、一个不带):会增加类的冗余,后续字段调整要同步改两个类,维护成本太高
- 靠OkHttp拦截器手动修改请求JSON:很容易出现字符转义错误、格式错乱,还会增加不必要的IO性能开销
- 全局修改Gson规则把所有null字段都过滤掉:会误伤那些明确需要传null值的业务字段(很多接口约定“不传键”和“传null值”属于不同的业务语义,不能一概过滤)
可直接复用的实现方案
方案1:调整全局Gson配置适配通用场景
出现null键值对残留的根本原因,基本都是全局Gson实例开启了serializeNulls()配置。可以先关闭这个全局配置,调整后Gson的默认行为是:所有值为null的字段,序列化时会直接跳过,不会输出对应的键。
这时候你现有的Request类不需要做任何修改,就能满足两种场景需求:
- 需要携带param1时:给
request.param1赋值实际的字符串内容,序列化时会正常输出"param1": "你传入的实际值" - 需要完全移除param1键时:保持
param1 = null的初始状态,序列化时这个字段会被直接跳过,不会出现"param1": null的残留键
注意:如果有其他业务字段确实需要在值为null时输出键值对,可以单独给这些字段配专属的TypeAdapter强制输出null,不需要靠全局配置兜底。
方案2:单字段定制序列化规则(适配历史项目无法改全局配置的情况)
如果项目已经迭代很久,全局serializeNulls = true的配置牵一发动全身改不动,那就给param1字段单独加专属的序列化规则,不跟随全局默认配置走:
- 先写一个专门处理String类型的TypeAdapter,规则是值为null时直接跳过不写对应键:
class SkipNullStringAdapter : TypeAdapter<String>() { override fun write(out: JsonWriter, value: String?) { value?.let { out.value(it) } } override fun read(input: JsonReader): String? = input.nextString() } - 给Request类里的param1字段加上适配器注解:
class Request { @SerializedName("param1") @Expose @JsonAdapter(SkipNullStringAdapter::class) var param1: String? = null @SerializedName("param2") @Expose var param2: String? = null }
配置完成后不管全局Gson的序列化规则是什么,param1的行为都是固定的:有值就正常输出键值,值为null时直接跳过不输出键,完全匹配两种业务场景的要求。
内容的提问来源于stack exchange,提问作者Abdhesh Yadav
相关产品推荐
相关产品推荐

