本文探讨了Jackson `ObjectReader`在执行部分更新时，可能将现有嵌套对象中的数据意外覆盖为`null`的问题。针对这一常见挑战，教程详细介绍了如何利用Jackson 2.9及更高版本引入的`@JsonMerge`注解，实现对嵌套对象的深度合并，从而在JSON更新请求中缺失字段时，有效保留原始数据，避免不必要的覆盖。
在现代应用程序中，使用Jackson库处理JSON数据是常见的操作，尤其是在需要对现有对象进行部分更新的场景。Jackson的ObjectReader配合readerForUpdating()方法，旨在简化这一过程。然而，一个常见的痛点是，当JSON更新请求中缺少某个嵌套对象的字段时，ObjectReader可能会将现有对象中该字段的值意外地覆盖为null，而不是保留其原始值。这可能导致数据丢失或不符合预期的行为。
理解问题场景
假设我们有一个数据模型，其中包含一个嵌套对象：
data class Model( val fieldTypeA: FieldTypeA? = null, ) data class FieldTypeA( val valueA: String? = null, val valueB: String? = null, )
我们的目标是从数据库加载一个现有Model实例，例如existingModel，它可能已经填充了fieldTypeA.valueA的值：
// 假设从数据库获取的现有对象
val existingModel = Model(fieldTypeA = FieldTypeA(valueA = "Test", valueB = "OriginalB"))
println("初始 existingModel: $existingModel")
// 输出: 初始 existingModel: Model(fieldTypeA=FieldTypeA(valueA=Test, valueB=OriginalB))现在，我们收到一个JSON更新请求，该请求只包含fieldTypeA中的valueB字段，而valueA字段在JSON中缺失：
{
"fieldTypeA": {
"valueB": "I am value B"
}
}我们期望的更新行为是：fieldTypeA.valueA应该保持其原始值"Test"，而fieldTypeA.valueB应该更新为"I am value B"。然而，如果直接使用ObjectReader的readValue方法进行更新，可能会出现以下问题：
import com.fasterxml.jackson.databind.ObjectMapper
val mapper = ObjectMapper()
// 使用 readerForUpdating() 将现有数据作为基准
val readerForUpdating = mapper.readerForUpdating(existingModel)
val jsonRequest = """{"fieldTypeA":{"valueB":"I am value B"}}"""
// 执行更新操作
val updatedRequest: Model = readerForUpdating.readValue(jsonRequest)
println("更新后 updatedRequest: $updatedRequest")
// 预期输出 (错误行为): updatedRequest: Model(fieldTypeA=FieldTypeA(valueA=null, valueB=I am value B))
// 这里的 fieldTypeA.valueA 被错误地覆盖为 null正如所示，fieldTypeA.valueA被意外地设置为null，因为在传入的jsonRequest中没有明确提供valueA。这显然不是我们期望的“部分更新”行为，而是部分覆盖。
解决方案：使用 @JsonMerge 注解
Jackson 2.9版本引入了一个强大的特性，允许进行深度合并（deep merging），即在更新过程中保留现有对象中未在JSON请求中指定的字段值。这个功能通过@JsonMerge注解实现。
要解决上述问题，只需在Model类中需要进行深度合并的嵌套对象字段上添加@JsonMerge注解：
import com.fasterxml.jackson.annotation.JsonMerge data class Model( @JsonMerge // 在需要深度合并的嵌套对象字段上添加此注解 val fieldTypeA: FieldTypeA? = null, ) data class FieldTypeA( val valueA: String? = null, val valueB: String? = null, )
通过在fieldTypeA字段上添加@JsonMerge，我们告诉Jackson，当反序列化此字段时，如果目标对象（即existingModel中的fieldTypeA）已经存在且JSON请求中只包含部分字段，则应将JSON中的值与现有值进行合并，而不是直接替换整个嵌套对象或将其未提及的字段设置为null。
现在，重新执行更新操作，结果将符合预期：
import com.fasterxml.jackson.databind.ObjectMapper
import com.fasterxml.jackson.annotation.JsonMerge // 确保导入
// ... (Model 和 FieldTypeA 定义，已添加 @JsonMerge) ...
val mapper = ObjectMapper()
val existingModel = Model(fieldTypeA = FieldTypeA(valueA = "Test", valueB = "OriginalB"))
println("初始 existingModel: $existingModel")
// 输出: 初始 existingModel: Model(fieldTypeA=FieldTypeA(valueA=Test, valueB=OriginalB))
val readerForUpdating = mapper.readerForUpdating(existingModel)
val jsonRequest = """{"fieldTypeA":{"valueB":"I am value B"}}"""
val updatedRequest: Model = readerForUpdating.readValue(jsonRequest)
println("更新后 updatedRequest: $updatedRequest")
// 预期输出 (正确行为): updatedRequest: Model(fieldTypeA=FieldTypeA(valueA=Test, valueB=I am value B))
// 这里的 fieldTypeA.valueA 成功保留了其原始值 "Test"注意事项与总结
- Jackson 版本要求: @JsonMerge注解是Jackson 2.9及更高版本中引入的特性。如果您的项目使用的是旧版Jackson，需要升级才能使用此功能。
- 注解位置: @JsonMerge应应用于需要深度合并的嵌套对象字段上，而不是其内部的原始类型字段。它指示Jackson在处理该字段时，应尝试将传入的JSON数据与现有对象的相应字段进行递归合并。
- 合并行为: 当使用@JsonMerge时，如果JSON中存在某个字段，它会覆盖现有对象中该字段的值。如果JSON中不存在某个字段，但该字段在现有对象中存在，则现有值会被保留。这正是我们进行部分更新时所期望的合并行为。
- 适用场景: @JsonMerge特别适用于RESTful API中处理PATCH请求，其中客户端通常只发送需要修改的字段，而服务器需要将这些修改与现有资源进行合并。
通过合理利用@JsonMerge注解，开发者可以更优雅、更安全地处理Jackson ObjectReader在更新操作中对嵌套对象的深度合并需求，有效避免数据被意外覆盖为null的问题，从而提升数据处理的健壮性和用户体验。
