Error Prone 检查器 JUnit3FloatingPointComparisonWithoutDelta：无误差容限浮点断言的迁移指南

静态分析代码质量开发工具【免费下载链接】error-proneCatch common Java mistakes as compile-time errors项目地址https://gitcode.com/gh_mirrors/er/error-prone点击查看免费下载JUnit 4 对assertEquals(expected, actual)的浮点重载一律直接抛异常部分浮点调用甚至无法通过编译。本指南围绕 Error Prone 内置检查器JUnit3FloatingPointComparisonWithoutDelta讲解它如何识别这些在 JUnit 4 下必然失败的 JUnit 3 风格浮点断言并给出可一键落地的两种修复路径——改用 Truth 的isEqualTo保持Double.equals语义或引入 delta 参数切换到容差比较。阅读完本文你将掌握该检查器的匹配规则、修复生成逻辑、默认启用状态以及在实际代码迁移中的取舍要点。背景为什么无 delta 的浮点assertEquals是定时炸弹JUnit 3 时代junit.framework.TestCase.assertEquals(double expected, double actual)这类断言会静默使用Double.equals语义进行比较代码能正常编译、正常运行。但从 JUnit 4 起org.junit.Assert对浮点类型的assertEquals(expected, actual)重载被设计为一律抛出异常——官方文档明确此 API 已被弃用任何不带容差delta的浮点断言都会在运行时失败更严重的是某些浮点类型的调用组合例如assertEquals(1.0, (Double) 1.0)之类的混型调用在 JUnit 4 下连编译都通不过。这就是 Error Prone 内置检查器JUnit3FloatingPointComparisonWithoutDelta摘要为 Floating-point comparison without error tolerance严重级别 WARNING存在的原因在编译期提前拦截这类必然在 JUnit 4 下出问题的调用并给出自动修复方案。其完整实现见 JUnit3FloatingPointComparisonWithoutDelta.java。检查器如何定位问题断言从源码看该检查器实现了MethodInvocationTreeMatcher核心匹配器为private static final MatcherExpressionTree ASSERT_EQUALS_MATCHER MethodMatchers.staticMethod().onClass(junit.framework.TestCase).named(assertEquals);即只匹配静态方法assertEquals且接收方必须是junit.framework.TestCase。这意味着普通业务类里自己声明的assertEquals(double, double)方法不会被误报测试noMatch_notTestCase验证了这一点assertSame等其他 JUnit 断言方法不会触发本检查测试noMatch_notAssertEquals验证了这一点。拿到候选调用后检查器会取出实参类型列表若带消息参数则先剔除字符串开头的消息实参见getArgumentTypesWithoutMessage与removeMessageArgumentIfPresent再用canBeConvertedToJUnit4判断该调用能否被安全地迁移到 JUnit 4。判定逻辑如下调用形态是否报告原因已带 delta 参数实参多于 2 个不报告JUnit 4 支持assertEquals(expected, actual, delta)两个实参都不是浮点类型不报告如assertEquals(1, 1)JUnit 4 有整数/对象重载可用任一实参不是数值类型不报告如assertEquals(1.0, abc)属于装箱对象比较两个实参都是引用类型如(Double) 1.0, (Double) 1.0不报告走 JUnit 4 的Object, Object重载可正常编译至少一个实参为浮点double/float含可拆箱的引用类型且至少一个为原始类型报告在 JUnit 4 下必然抛异常或无法编译判断浮点类型时使用Types.unboxedTypeOrType先拆箱再检查TypeKind.DOUBLE/TypeKind.FLOAT因此Double、Float这类装箱类型也会被正确识别。测试用例match_primitiveAndReferenceDouble、match_primitiveFloatAndReferenceDouble、match_primitiveDoubleAndReferenceInteger等一一印证了这些边界情形。修复方案一保持Double.equals语义如果你希望迁移后比较行为完全不变依然使用Double.equals的位级相等语义原文档给出了两条路将其中一个实参转型为Object强制走 JUnit 4 的assertEquals(Object expected, Object actual)重载assertEquals(1.0, (Object) 2.0); // 或 assertEquals((Object) 1.0, 2.0)改用 Truth 断言库的assertThat(...).isEqualTo(...)其内部同样基于Double.equals语义import static com.google.common.truth.Truth.assertThat; import static com.google.common.truth.Truth.assertWithMessage; assertThat(2.0).isEqualTo(1.0); assertWithMessage(msg).that(2.0).isEqualTo(1.0);这正是检查器在运行时自动生成的 Truth 修复源码useTruth方法通过SuggestedFix添加com.google.common.truth.Truth.assertThat或assertWithMessage的静态导入并将调用整体替换为上表写法。对应重构测试 JUnit3FloatingPointComparisonWithoutDeltaTest.java 完整展示了这一转换过程。需要注意的是Truth 修复仅在编译环境中能找到com.google.common.truth.Truth时才会附加源码中通过memoize的TRUTHSupplier 探测类型是否存在并规避了state.getTypeFromString(...) ! null在部分场景下的误判。修复方案二切换到容差比较另一种思路是接受行为变化改用基于误差容限delta的浮点比较。文档明确指出这会带来语义差异负零negative zero在 JUnit 和 Truth 中容差比较会认为-0.0与0.0相等而Double.equals认为它们不相等无穷大与 NaN在 Truth 中isWithin(...).of(...)对无穷大和 NaN 的处理也与Double.equals不同。若接受上述语义变化可选用// JUnit 的带 delta 重载 assertEquals(expected, actual, delta); // 或 Truth 的 within 写法容差可为零 assertThat(actual).isWithin(0.0).of(expected);Error Prone 为这类修复自动补出的 delta 参数取值由getDeltaArgument决定只要任一实参是double含可拆箱的Double就插入, 0.0否则纯float场景插入, 0.0f。也就是说容差为零的assertEquals(1.0, 2.0, 0.0)是默认推荐它与无 delta的旧写法在普通有限数值上的结果一致只是对负零、无穷大、NaN 的处理按 IEEE 754 容差语义变化。测试testMultipleFixes也验证了修复文本中必然包含0.0。默认启用状态与抑制方式该检查器已被登记进 Error Prone 的默认内置检查集合见 BuiltInCheckerSuppliers.java位于ENABLED_WARNINGS列表即默认开启、以 WARNING 级别报告无需额外配置。其元数据定义如下BugPattern(summary Floating-point comparison without error tolerance, severity WARNING)根据 BugPattern.java 注解的定义该检查器可通过SuppressWarnings(JUnit3FloatingPointComparisonWithoutDelta)在局部抑制默认抑制注解为SuppressWarnings也支持通过命令行 flag 全局关闭。迁移实战要点小结先分类再看修复混用原始类型与装箱类型的浮点assertEquals是重点排查对象纯引用类型如两个Double参数和已带 delta 的调用不会触发本检查可放心跳过。语义不变选 Truth 或强转 Object对位级相等有强依赖如测试-0.0与0.0的区分的用例优先采用 Truth 的assertThat(...).isEqualTo(...)避免测试意图被悄悄改变。接受容差语义则补 deltaError Prone 自动生成的0.0/0.0f即可通过编译但请确认 NaN、无穷大、负零相关断言在容差语义下仍符合预期。关注编译期拦截的价值该检查器与 JUnit 4 的禁律同样严格不多不少源码注释语让你在 JUnit 3 迁移到 JUnit 4 的过程中把运行时炸雷提前到编译期拆除。如需查看更多相关断言检查可在 core/src/main/java/com/google/errorprone/bugpatterns 目录中查找FloatingPointAssertionWithinEpsilon、AssertEqualsArgumentOrderChecker等同属 JUnit 断言家族的检查器以及 docs/bugpattern 下对应的文档说明。赞分享静态分析代码质量开发工具【免费下载链接】error-proneCatch common Java mistakes as compile-time errors项目地址https://gitcode.com/gh_mirrors/er/error-prone点击查看免费下载相关推荐Error Prone FloatingPointAssertionWithinEpsilon 检查当浮点容差断言悄悄变成精确相等比较Error Prone FloatingPointAssertionWithinEpsilon 检查当浮点容差断言悄悄变成精确相等比较 导读 本文讲解 Err静态分析代码质量开发工具Error Prone 实战用 FloatingPointLiteralPrecision 检查无法精确保表示的浮点字面量Error Prone 实战用 FloatingPointLiteralPrecision 检查无法精确保表示的浮点字面量 浮点数的二进制表示天然无法精确表示静态分析代码质量开发工具理解 Error Prone 的 AttemptedNegativeZero 检查为什么 -0 不是浮点负零理解 Error Prone 的 AttemptedNegativeZero 检查为什么 0 不是浮点负零 在 Java 中写 0 时得到的其实是整数 0静态分析代码质量开发工具上一篇YOLOX与YOLOv3深度对比anchor-free为何能超越经典YOLO系列下一篇Bypass革命性跨平台Markdown渲染库如何在Android与iOS上直接呈现优雅文本创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考