Kotlin序列化出错时如何回退到默认值（如null）？

核心思路 #

为Kotlin原生可空类型（T?）提供通用兜底反序列化逻辑：目标字段解析失败时自动返回null，保留其他已成功解析的字段内容；非可空字段维持原有强校验规则，解析失败直接抛出异常。

实现步骤 #

1. 定义通用可空字段兜底序列化器 #

创建复用原类型序列化器的通用处理类，捕获解析异常后返回null：

import kotlinx.serialization.KSerializer
import kotlinx.serialization.descriptors.SerialDescriptor
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder

class NullableSafeSerializer<T>(private val originalSerializer: KSerializer<T>) : KSerializer<T?> {
    override val descriptor: SerialDescriptor = originalSerializer.descriptor

    override fun serialize(encoder: Encoder, value: T?) {
        value?.let { originalSerializer.serialize(encoder, it) }
    }

    override fun deserialize(decoder: Decoder): T? {
        return try {
            originalSerializer.deserialize(decoder)
        } catch (e: Exception) {
            // 捕获所有解析异常，返回null实现优雅降级
            null
        }
    }
}

2. 配置Json实例并注册序列化器 #

通过辅助函数简化可空类型的序列化器注册流程，配置全局Json实例：

import kotlinx.serialization.json.Json
import kotlinx.serialization.modules.SerializersModule
import kotlinx.serialization.modules.contextual

// 辅助函数：快速为指定类型的可空版本注册兜底序列化器
inline fun <reified T> SerializersModuleBuilder.safeNullable() {
    contextual(NullableSafeSerializer(T::class.serializer()))
}

// 全局Json实例配置
val json = Json {
    serializersModule = SerializersModule {
        // 为需要优雅降级的可空类型注册，新增类型直接添加该行即可
        safeNullable<NonImportantInfo>()
    }
    // 忽略JSON中的未知字段，避免无关字段导致解析失败
    ignoreUnknownKeys = true
    // 禁用自动将无效值转为默认值，确保null仅来自解析失败
    coerceInputValues = false
}

3. 保持原有数据类定义不变 #

无需修改数据类结构，原生可空类型会自动应用兜底逻辑：

@Serializable
data class User(
    val important: ImportantInfo, // 非可空字段，解析失败直接抛异常
    val nonImportant: NonImportantInfo? = null, // 可空字段，解析失败回退为null
)

@Serializable
data class ImportantInfo(
    val userId: Int,
)

@Serializable
data class NonImportantInfo(
    val errorProneField: Boolean? = null,
)

验证预期效果 #

按照示例JSON测试：

• 有效JSON：完整解析User对象，nonImportant字段值正确
• 部分无效JSON：nonImportant解析失败时自动设为null，important字段保留正确值
• 重要字段无效：important解析失败直接抛出异常，符合强校验需求

注意事项 #

• 该方案仅对声明为T?的字段生效，非可空字段维持严格校验
• 若嵌套对象内部的可空字段（如NonImportantInfo的errorProneField）需要单独兜底，可注册safeNullable<Boolean>()
• 建议在异常捕获逻辑中添加日志记录，便于排查解析失败原因

内容的提问来源于stack exchange，提问作者David Ferrand