使用Jackson @JsonMerge 实现数据深度合并，避免更新时字段被覆盖

本文深入探讨了在使用Jackson `ObjectReader`进行部分数据更新时，现有嵌套对象字段可能被JSON请求中缺失的字段覆盖为`null`的问题。针对此痛点，教程详细介绍了Jackson 2.9及更高版本引入的`@JsonMerge`注解。通过将此注解应用于需要深度合并的字段，可以有效防止在执行更新操作时，原有数据因JSON请求不完整而被意外擦除，从而实现更智能、更健壮的数据合并策略。

Jackson ObjectReader 部分更新的挑战

在使用Jackson库进行数据更新时，一个常见的场景是从数据库加载一个现有对象，然后使用传入的JSON请求对其进行部分更新。Jackson提供了ObjectReader的readerForUpdating()方法来支持这种操作，旨在将JSON数据合并到现有对象中。然而，在处理包含嵌套对象的模型时，如果不加以特殊处理，可能会遇到一个问题：如果JSON请求中某个嵌套对象的字段缺失，ObjectReader可能会将现有对象中对应的字段值覆盖为null，而不是保留原有的值。

让我们通过一个具体的例子来理解这个问题。假设我们有以下数据模型：

data class Model(
  val fieldTypeA: FieldTypeA? = null,
)

data class FieldTypeA(
  val valueA: String? = null,
  val valueB: String? = null,
)

现在，我们从数据库中加载了一个 Model 实例，其中 fieldTypeA.valueA 已经有值：

val existingModel = Model(fieldTypeA = FieldTypeA(valueA = "Test", valueB = "Existing B"))
// 此时 existingModel.fieldTypeA.valueA = "Test", existingModel.fieldTypeA.valueB = "Existing B"

接下来，我们准备一个用于更新的JSON请求，该请求只包含 fieldTypeA 中的 valueB 字段：

{
  "fieldTypeA": {
    "valueB": "I am value B"
  }
}

我们使用 ObjectReader 进行更新操作：

import com.fasterxml.jackson.databind.ObjectMapper

// 假设 CustomMapper 是一个 ObjectMapper 实例
val objectMapper = ObjectMapper()
val readerForUpdating = objectMapper.readerForUpdating(existingModel)

val jsonRequestString = """{"fieldTypeA":{"valueB":"I am value B"}}"""
val updatedModel: Model = readerForUpdating.readValue(jsonRequestString)

在上述代码执行后，updatedModel 的 fieldTypeA.valueA 将会变成 null，而 fieldTypeA.valueB 则被更新为 "I am value B"。这通常不是我们期望的行为，因为我们希望 valueA 能够被保留。

解决方案：使用 @JsonMerge 实现深度合并

为了解决Jackson ObjectReader 在部分更新时覆盖现有嵌套对象字段的问题，Jackson 2.9 版本引入了一个强大的新特性：@JsonMerge 注解。通过在需要深度合并的字段上标记 @JsonMerge，Jackson将不再简单地用JSON中缺失的值覆盖现有字段，而是尝试进行智能的深度合并。

如何使用 @JsonMerge

Tanka

具备AI长期记忆的下一代团队协作沟通工具

110

查看详情

只需将 @JsonMerge 注解添加到数据模型中需要进行深度合并的字段上。在我们的例子中，我们希望 fieldTypeA 对象在更新时能够深度合并，而不是被完全替换或部分覆盖为 null。因此，我们修改 Model 类如下：

import com.fasterxml.jackson.annotation.JsonMerge

data class Model(
  @JsonMerge // 在 fieldTypeA 字段上添加 @JsonMerge 注解
  val fieldTypeA: FieldTypeA? = null,
)

data class FieldTypeA(
  val valueA: String? = null,
  val valueB: String? = null,
)

@JsonMerge 的工作原理

当Jackson处理一个被 @JsonMerge 注解标记的字段时，它会改变默认的合并行为。具体来说：

1. 非空检查： 如果现有对象中被注解字段的值不为 null，并且传入的JSON请求中也包含该字段，Jackson会尝试将JSON数据合并到现有字段的实例中，而不是创建一个新的实例。
2. 保留缺失字段： 如果JSON请求中某个子字段缺失，Jackson将不会将其在现有对象中的对应值设置为 null，而是保留现有对象中该子字段的值。
3. 递归合并： 如果被注解的字段本身是一个复杂对象，并且其内部的字段也需要深度合并，那么该字段的类定义中也可以继续使用 @JsonMerge。

使用 @JsonMerge 后的示例

让我们再次执行之前的更新操作，但这次 Model 类已经包含了 @JsonMerge 注解：

import com.fasterxml.jackson.databind.ObjectMapper
import com.fasterxml.jackson.annotation.JsonMerge

// 更新后的 Model 定义
data class Model(
  @JsonMerge
  val fieldTypeA: FieldTypeA? = null,
)

data class FieldTypeA(
  val valueA: String? = null,
  val valueB: String? = null,
)

// 现有模型
val existingModel = Model(fieldTypeA = FieldTypeA(valueA = "Test", valueB = "Existing B"))
// 此时 existingModel.fieldTypeA.valueA = "Test", existingModel.fieldTypeA.valueB = "Existing B"

// JSON 请求
val jsonRequestString = """{"fieldTypeA":{"valueB":"I am value B"}}"""

// 执行更新
val objectMapper = ObjectMapper()
val readerForUpdating = objectMapper.readerForUpdating(existingModel)
val updatedModel: Model = readerForUpdating.readValue(jsonRequestString)

// 验证结果
println(updatedModel.fieldTypeA?.valueA) // 输出: Test
println(updatedModel.fieldTypeA?.valueB) // 输出: I am value B

可以看到，updatedModel 中的 fieldTypeA.valueA 成功保留了原有值 "Test"，而 fieldTypeA.valueB 也被正确更新为 "I am value B"。这正是我们期望的深度合并行为。

注意事项与总结

1. Jackson 版本要求： @JsonMerge 注解是在 Jackson 2.9 版本中引入的。如果您的项目使用的是旧版Jackson，则需要升级到 2.9 或更高版本才能使用此功能。
2. 适用场景： @JsonMerge 特别适用于需要对嵌套对象进行部分更新，并希望保留现有对象中未在JSON请求中提供的字段值的场景。这在RESTful API中处理PATCH请求时非常有用。
3. 默认行为： 在没有 @JsonMerge 的情况下，Jackson的 readerForUpdating() 对于对象字段的默认行为是替换（如果JSON中存在该字段）或覆盖为 null（如果JSON中该字段存在但其子字段缺失，或者JSON中该字段本身缺失且现有对象中该字段不为 null）。@JsonMerge 改变了这种默认行为，使其更倾向于“合并”而不是“替换”。
4. 谨慎使用： 并非所有字段都适合使用 @JsonMerge。对于那些你确实希望在JSON中缺失时被清除（设置为 null）的字段，则不应使用此注解。

通过合理利用 @JsonMerge 注解，开发者可以更精确地控制Jackson在执行数据更新时的合并行为，从而构建出更加健壮和用户友好的应用程序，避免因数据意外丢失而引发的问题。

以上就是使用Jackson @JsonMerge 实现数据深度合并，避免更新时字段被覆盖的详细内容，更多请关注php中文网其它相关文章！