Android应用中数据类实例增量更新的Diff实现方案咨询

核心问题分析 #

你需要实现仅传输变更字段来更新Kotlin数据类实例，同时要覆盖两种关键场景：更新字段值（包括将非空字段修改为新值、给可空字段赋值/置空），还要兼顾代码简洁性和维护性，避免重复定义diff类或手动映射的繁琐。

推荐方案：利用Jackson的@JsonMerge与Kotlin数据类特性 #

Jackson对Kotlin有完善的支持，结合它的合并注解可以轻松实现增量更新，无需额外定义diff类，也不用手动处理JSON映射。

步骤1：引入Jackson依赖 #

确保项目中添加Jackson的Kotlin模块：

// Gradle配置示例
implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.15.2")
implementation("com.fasterxml.jackson.core:jackson-databind:2.15.2")

步骤2：给数据类添加合并注解 #

在需要支持增量更新的数据类上标注@JsonMerge，保留原字段的可空性定义：

import com.fasterxml.jackson.annotation.JsonMerge

@JsonMerge
data class Contact(
    val firstName: String,
    val middleName: String?,
    val lastName: String
)

步骤3：实现增量更新逻辑 #

通过Jackson的ObjectMapper将变更JSON合并到现有实例中：

import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
import com.fasterxml.jackson.module.kotlin.readValue

val objectMapper = jacksonObjectMapper()

fun <T> updateInstance(existing: T, updateJson: String): T {
    return objectMapper.readerForUpdating(existing).readValue(updateJson)
}

// 基础场景测试
val originalContact = Contact(firstName = "John", middleName = null, lastName = "Doe")
val updateJson = """{"firstName": "Jane"}"""
val updatedContact = updateInstance(originalContact, updateJson)
// 结果：Contact(firstName=Jane, middleName=null, lastName=Doe)

// 置空可空字段测试
val originalWithMiddle = Contact(firstName = "John", middleName = "Michael", lastName = "Doe")
val nullifyMiddleJson = """{"middleName": null}"""
val updatedNullMiddle = updateInstance(originalWithMiddle, nullifyMiddleJson)
// 结果：Contact(firstName=John, middleName=null, lastName=Doe)

方案优势 #

• 无冗余代码：直接复用原数据类，不用额外定义diff类，减少维护成本
• 自动处理null场景：不管是给可空字段置空，还是更新非空字段值，都能正确执行
• 支持复杂结构：如果数据类包含嵌套data class、集合等复杂类型，Jackson会自动递归合并变更字段
• 序列化/反序列化自动化：无需手动解析JSON或Map，降低出错概率

替代方案：Kotlin原生实现（无第三方依赖） #

如果项目不能引入Jackson依赖，可以用Kotlin密封类区分“未变更”和“需更新”状态，结合copy函数实现：

步骤1：定义更新标记密封类 #

sealed class Update<T> {
    object Unchanged : Update<Nothing>()
    data class Changed<T>(val value: T?) : Update<T>()
}

步骤2：定义数据类的更新DTO #

data class ContactUpdate(
    val firstName: Update<String> = Update.Unchanged,
    val middleName: Update<String?> = Update.Unchanged,
    val lastName: Update<String> = Update.Unchanged
)

步骤3：实现更新扩展函数 #

fun Contact.updateWith(dto: ContactUpdate): Contact {
    return this.copy(
        firstName = if (dto.firstName is Update.Changed) dto.firstName.value!! else this.firstName,
        middleName = if (dto.middleName is Update.Changed) dto.middleName.value else this.middleName,
        lastName = if (dto.lastName is Update.Changed) dto.lastName.value!! else this.lastName
    )
}

步骤4：使用示例 #

val original = Contact("John", null, "Doe")
val updateDto = ContactUpdate(firstName = Update.Changed("Jane"))
val updated = original.updateWith(updateDto)
// 结果：Contact(firstName=Jane, middleName=null, lastName=Doe)

// 置空可空字段测试
val originalWithMiddle = Contact("John", "Michael", "Doe")
val nullifyDto = ContactUpdate(middleName = Update.Changed(null))
val updatedNull = originalWithMiddle.updateWith(nullifyDto)
// 结果：Contact(firstName=John, middleName=null, lastName=Doe)

这个方案完全基于Kotlin特性，无第三方依赖，但需要为每个数据类编写对应的Update DTO和扩展函数，适合小型项目或对依赖有严格限制的场景。

总结 #

• 若项目已使用Jackson，优先选择Jackson合并注解方案，简洁高效，支持复杂场景
• 若不能引入第三方依赖，选择自定义密封类+copy函数方案，可控性强但需要编写更多代码

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