AssertJ 递归比较忽略 id 字段方法

AssertJ 的递归比较功能（`usingRecursiveComparison()`）提供了一种简洁、强大且可维护的解决方案，专为解决多层嵌套 JPA 实体（如 Order → OrderItem → id）断言中普遍存在的 ID 冲突难题：它能自动穿透任意深度的对象图，精准忽略所有层级中指定名称（如 `"id"`）、正则匹配（如 `".*Id"`）或特定类型的字段，彻底告别手动剥离 ID、自定义 Comparator 或易出错的旧式递归断言；配合清晰的 API 和灵活的配置选项（如忽略多余字段、安全处理 null），让复杂对象的深度校验变得直观可靠，是现代 Java 单元测试中提升断言鲁棒性与可读性的必备实践。

AssertJ 提供了强大的递归比较功能，支持通过字段名或正则表达式全局忽略嵌套对象中的特定字段（如 `id`），从而避免手动处理多层 JPA 实体关系时的 ID 冲突问题。

在使用 AssertJ 进行深度对象断言时，若待测对象（如 JPA 实体）包含多层嵌套子实体（例如 Order 包含 List，每个 OrderItem 又含 id），仅调用 isEqualToIgnoringGivenFields 无法穿透到内部对象——它只作用于顶层字段。

此时应使用 AssertJ 3.12.0+ 引入的 递归比较机制（recursivelyCompareTo），它支持声明式地忽略任意层级中指定名称的字段：

assertThat(actualEntity)
    .usingRecursiveComparison()
    .ignoringFields("id") // 忽略所有层级中名为 "id" 的字段（包括嵌套对象、集合元素、数组项）
    .isEqualTo(expectedEntity);

✅ 支持多种忽略方式：

• ignoringFields("id")：精确匹配字段名（区分大小写）；
• ignoringFields("id", "version")：同时忽略多个字段；
• ignoringFieldsMatchingRegexes(".*Id")：用正则忽略如 orderId、itemId 等命名模式；
• ignoringFieldsOfTypes(Long.class, Integer.class)：按类型忽略（慎用，可能误伤业务字段）。

⚠️ 注意事项：

• usingRecursiveComparison() 默认启用严格字段匹配（即实际对象不能有多余字段，除非显式 .ignoringExtraFields()）；
• 若嵌套对象存在 null 值，递归比较默认会校验 null 安全性，无需额外配置；
• 不推荐混用旧式方法（如 isEqualToComparingFieldByFieldRecursively）与新式 usingRecursiveComparison()，后者功能更全、API 更清晰、文档更完善；
• 对于 Lombok 生成的 @Data 或 @Value 类，确保 toString()/equals() 未被意外覆盖，否则可能干扰反射行为（但递归比较基于字段反射，通常不受影响）。

? 小技巧：如需复用忽略规则，可封装为静态工具方法：

public static <T> RecursiveComparisonAssert<T> assertDeepEqualIgnoringId(T actual) {
    return assertThat(actual)
        .usingRecursiveComparison()
        .ignoringFields("id");
}
// 使用：assertDeepEqualIgnoringId(actualOrder).isEqualTo(expectedOrder);

总结：usingRecursiveComparison().ignoringFields("id") 是解决“跨层级忽略 ID”的标准、简洁且可维护的方案，彻底替代了过去需要自定义 Comparator 或手动剥离 ID 的复杂做法。

以上就是《AssertJ 递归比较忽略 id 字段方法》的详细内容，更多关于的资料请关注golang学习网公众号！