掌握 JUnit assertEquals：正确断言异常消息的实践

JUnit 异常测试概述

在 java 开发中，测试异常行为是确保代码健壮性的重要环节。junit 5 提供了 assertthrows 方法，用于方便地验证代码是否抛出了预期的异常。assertthrows 的基本用法是传入预期的异常类型和执行可能抛出异常的 lambda 表达式，它会捕获并返回抛出的异常实例，以便我们进一步断言异常的属性，例如异常消息。

以下是被测试的 multiply 方法示例，它在乘数为零时抛出 IllegalArgumentException：

public class MyCalculator {
    public int multiply(int i, int j) {
        if (i == 0 || j == 0) {
            throw new IllegalArgumentException("* by zero");
        }
        return i * j;
    }
}

为了测试这个方法在特定条件下抛出异常的行为，我们会编写如下的 JUnit 测试：

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;

public class MyCalculatorTest {

    private MyCalculator tm = new MyCalculator(); // 假设tm是MyCalculator的实例

    @Test
    void testMultiply_WhenFourIsMultipiedByZero_ShouldThrowException() {
        int i = 0;
        int j = 4;
        String expectedMsg = "* by zero";

        // 使用 assertThrows 捕获异常
        IllegalArgumentException e = assertThrows(
                IllegalArgumentException.class,
                () -> tm.multiply(i, j),
                "Expected multiply() to throw IllegalArgumentException when multiplying by zero"
        );

        // 接下来是对捕获到的异常进行断言
        // ...
    }
}

理解 assertEquals 的工作原理与常见误区

在上述 assertThrows 捕获到异常 e 之后，下一步通常是断言异常的消息是否符合预期。然而，许多开发者在这一步容易陷入一个常见的陷阱：

// 错误的断言方式
assertEquals("Error", expectedMsg, e);

这段代码尝试比较一个 String 类型的 expectedMsg 和一个 IllegalArgumentException 类型的 e 对象。当执行这段代码时，JUnit 会抛出 java.lang.AssertionError，提示 expected: java.lang.IllegalArgumentException<java.lang.IllegalArgumentException: * by zero> but was: java.lang.IllegalArgumentException<java.lang.IllegalArgumentException: * by zero>，或者更直接地指出类型不匹配。

深入分析原因：assertEquals 方法有多个重载形式，但其核心功能是比较两个对象的“相等性”。

• assertEquals(Object expected, Object actual)：此方法会调用 expected.equals(actual) 进行比较。
• assertEquals(String message, Object expected, Object actual)：此方法在比较失败时会显示 message，同样调用 expected.equals(actual)。

在上述错误示例中：

• expectedMsg 是一个 String 实例，其内容是 "* by zero"。
• e 是一个 IllegalArgumentException 实例，它包含一个消息 "* by zero"。

当 assertEquals 尝试比较 expectedMsg (String) 和 e (IllegalArgumentException) 时，它本质上是在比较一个 String 对象和一个 Exception 对象。即使这两个对象内部都包含相同的字符串内容，它们仍然是不同类型的对象。String 类的 equals 方法设计为只与另一个 String 对象进行比较，如果传入的不是 String 类型，通常会返回 false。因此，这种直接比较是无效的，导致断言失败。

正确断言异常消息的实践

要正确地断言异常的消息，我们需要获取异常对象中存储的消息字符串，而不是直接比较异常对象本身。java.lang.Throwable 类（所有异常和错误的基类）提供了 getMessage() 方法，用于获取异常的详细消息字符串。

Clipfly

一站式AI视频生成和编辑平台，提供多种AI视频处理、AI图像处理工具。

98

查看详情

正确的断言方式应该如下：

// 正确的断言方式
assertEquals("Error: Exception message mismatch", expectedMsg, e.getMessage());

代码解析：

1. e.getMessage()：这会从捕获到的 IllegalArgumentException 对象 e 中提取出其内部的消息字符串，即 "* by zero"。
2. assertEquals("Error: Exception message mismatch", expectedMsg, e.getMessage())：现在，assertEquals 比较的是两个 String 对象：expectedMsg (预期消息字符串) 和 e.getMessage() (实际异常消息字符串)。这两个对象都是 String 类型，且内容相同，因此断言会成功。

其他断言方式与最佳实践

除了使用 assertEquals(expectedString, actualString) 之外，您也可以使用 assertTrue 结合 equals 方法进行断言，例如：

// 另一种断言方式
assertTrue(e.getMessage().equals(expectedMsg), "Error: Exception message mismatch");

这种方式同样有效，因为它也是在比较两个 String 对象的 equals 方法。然而，从语义清晰度上讲，assertEquals 更直接地表达了“预期值与实际值相等”的意图，因此在比较两个值时通常更推荐使用 assertEquals。

注意事项：

1. 区分对象与属性： 在 JUnit 断言中，务必区分要比较的是对象本身还是对象的某个属性（如消息、ID、状态等）。当需要比较属性时，应先通过 Getter 方法获取到该属性的值。
2. String 比较： 之前有开发者误解为“assertEquals 不能比较 String 对象”。这是不正确的。assertEquals 完全可以比较 String 对象，只要两个参数都是 String 类型且内容相等即可。问题出在将 String 与 Exception 对象混淆比较。
3. 提供清晰的断言失败信息： assertEquals 的第一个参数是一个可选的 String 消息，当断言失败时，这个消息会显示在测试报告中。提供有意义的失败消息（如 "Error: Exception message mismatch"）可以帮助快速定位问题。
4. 断言异常类型： 在使用 assertThrows 时，已经指定了预期的异常类型（例如 IllegalArgumentException.class）。这本身就是一次重要的断言，确保抛出的异常是正确的类型。

结论

在 JUnit 测试中，正确断言异常消息是保证测试质量的关键。核心在于理解 assertEquals 的工作原理，并明确区分要比较的是异常对象本身还是其包含的消息字符串。通过使用 Exception.getMessage() 方法提取异常消息，我们可以确保 assertEquals 比较的是两个同类型的字符串，从而实现准确、可靠的异常行为测试。遵循这些最佳实践，将有助于编写出更健壮、更易于维护的测试代码。

以上就是掌握 JUnit assertEquals：正确断言异常消息的实践的详细内容，更多请关注php中文网其它相关文章！