JUnit断言异常的艺术：ExpectedException注解与Assert.assertThrows方法指南

2024-03-22 15:42:34

JUnit 中断言异常的艺术：ExpectedException 注解与 Assert.assertThrows 方法

在单元测试中，验证代码是否按预期抛出异常至关重要。JUnit 提供了简洁且符合其精神的注解和方法来实现这一目的，帮助我们避免笨拙的异常处理方式。本文将深入探讨使用 ExpectedException 注解和 Assert.assertThrows 方法在 JUnit 中断言异常的最佳实践。

ExpectedException 注解：简洁与优雅

ExpectedException 注解让你能够在测试方法中指定预期的异常类型。如果该异常确实被抛出，则测试成功；否则，测试失败。这种方法简洁而优雅，非常适合需要断言单个预期的异常类型的情况。

@Test(expected = IndexOutOfBoundsException.class)
public void testFooThrowsIndexOutOfBoundsException() {
    foo.doStuff();
}

Assert.assertThrows 方法：灵活与强大

Assert.assertThrows 方法在 Java 8 中引入，为断言异常提供了更多灵活性。它允许你指定多个预期的异常类型，并执行包含要测试代码的代码块。如果代码块抛出了指定的异常，则断言成功；否则，断言失败。

@Test
public void testFooThrowsIndexOutOfBoundsException() {
    assertThrows(IndexOutOfBoundsException.class, () -> foo.doStuff());
}

选择哪种方法？

ExpectedException 注解和 Assert.assertThrows 方法各有优缺点。ExpectedException 注解更简洁，但仅适用于需要断言单个预期的异常类型的情况。Assert.assertThrows 方法则更灵活，允许你指定多个预期的异常类型并执行额外的断言。

在大多数情况下，推荐使用 ExpectedException 注解，因为它简洁且满足大多数需要断言异常的需求。如果你需要指定多个预期的异常类型或执行额外的断言，则可以使用 Assert.assertThrows 方法。

常见的 FAQ

1. 如何在断言中包含预期异常的消息？

@Test(expected = IndexOutOfBoundsException.class)
public void testFooThrowsIndexOutOfBoundsException() {
    foo.doStuff();
}

2. 如何断言异常抛出后代码未继续执行？

使用 Throwable::addSuppressed：

assertThrows(IllegalArgumentException.class, () -> {
    try {
        foo.doStuff();
    } catch (Throwable t) {
        t.addSuppressed(new RuntimeException("Expected to be unreachable"));
    }
});

3. 如何在一个断言中同时验证异常类型和消息？

使用 Assert.assertThatException：

assertThatExceptionOfType(IndexOutOfBoundsException.class)
    .isThrownBy(() -> foo.doStuff())
    .withMessageContaining("Index out of bounds");

4. 如何使用 Hamcrest 进一步自定义断言？

Hamcrest 提供了更丰富的匹配器，可以自定义异常断言：

assertThatThrownBy(() -> foo.doStuff())
    .hasMessageMatching("Index out of bounds");

5. 如何在 IntelliJ IDEA 中配置 JUnit 的异常断言？

在 IntelliJ IDEA 中，转到 "Settings" -> "Build, Execution, Deployment" -> "JUnit" -> "Expectations" 并选择 "Use @Test(expected=...) annotation" 或 "Use assertThrows() statement"。