AssertJ递归比较中忽略字段检查的技术解析

引言

在Java单元测试中，AssertJ是一个非常流行的断言库，它提供了丰富的API来简化测试代码的编写。其中递归字段比较功能是AssertJ的一个强大特性，但在处理多态对象时会遇到一些特殊情况。本文将深入分析AssertJ 3.25.0版本引入的字段存在性检查机制及其对多态对象比较的影响。

问题背景

在AssertJ 3.25.0版本之前，使用usingRecursiveFieldByFieldElementComparatorOnFields方法进行递归比较时，即使指定的比较字段在某些子类中不存在，也不会报错。但在3.25.0版本后，AssertJ增加了严格的字段存在性检查，当指定的比较字段在对象中不存在时，会抛出IllegalArgumentException。

这一变化在多态对象比较场景下尤为明显。例如，当比较一个包含不同子类对象的集合时，某些字段可能只在部分子类中存在，而在其他子类中不存在。

技术细节分析

多态对象比较场景

考虑以下类层次结构：

public abstract class AppliedExemptionResponse {
    String exemptionCode;
    String description;
    String chargeItemCode;
}

public class AppliedTotalExemptionResponse extends AppliedExemptionResponse {
    // 不包含value字段
}

public class AppliedPartialExemptionResponse extends AppliedExemptionResponse {
    BigDecimal value;  // 特有字段
    String type;
}

当使用usingRecursiveFieldByFieldElementComparatorOnFields方法指定比较字段包含"value"时，AssertJ会检查所有被比较对象的类是否都包含该字段。对于AppliedTotalExemptionResponse实例，由于它没有"value"字段，比较会失败。

版本行为差异

• 3.24.2及之前版本：忽略不存在的字段，只比较存在的字段
• 3.25.0及之后版本：严格检查所有指定字段是否存在，若任一字段不存在则抛出异常

解决方案

1. 使用全字段比较

如果不指定特定字段，AssertJ会比较所有存在的字段：

assertThat(appliedExemptions)
    .usingRecursiveFieldByFieldElementComparator()
    .containsExactlyInAnyOrderElementsOf(expectedAppliedExemptions);

2. 忽略不需要比较的字段

使用ignoringFields方法显式忽略某些字段：

assertThat(appliedExemptions)
    .usingRecursiveFieldByFieldElementComparator()
    .ignoringFields("type")  // 忽略type字段
    .containsExactlyInAnyOrderElementsOf(expectedAppliedExemptions);

3. 等待AssertJ提供新选项

AssertJ团队正在考虑添加一个选项来控制字段存在性检查的行为，未来版本可能会提供类似如下的API：

assertThat(appliedExemptions)
    .usingRecursiveFieldByFieldElementComparatorOnFields("exemptionCode", "value")
    .ignoringNonExistingFields()  // 忽略不存在的字段
    .containsExactlyInAnyOrderElementsOf(expectedAppliedExemptions);

最佳实践建议

1. 明确比较意图：在编写测试时，明确知道你要比较哪些字段，避免过度比较
2. 保持测试稳定性：对于多态对象，考虑使用最具体的字段进行比较
3. 版本升级注意：升级AssertJ版本时，注意检查递归比较相关的测试用例
4. 文档参考：仔细阅读AssertJ的版本变更说明，了解行为变化

结论

AssertJ 3.25.0引入的字段存在性检查机制虽然增加了严格性，但在处理多态对象时可能会带来一些不便。开发者需要根据实际情况选择合适的比较策略，或者等待AssertJ提供更灵活的字段检查控制选项。理解这一变化背后的设计意图有助于编写更健壮的测试代码。