
理解异常测试的挑战
在软件开发中,我们经常需要验证当输入不符合预期条件时,方法是否会按设计抛出特定的异常。例如,一个处理金额输入的方法,如果接收到的金额不符合特定规则(如必须是某个基数的倍数),就应该抛出illegalargumentexception。
考虑以下Java方法:
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.util.Scanner; // 假设Console.readLine()基于Scanner
public class Application {
public static int enterTheAmount() {
final int LOTTO_PRICE = 1000;
// 模拟Console.readLine(),实际项目中可能来自其他IO源
Scanner scanner = new Scanner(System.in);
int amount = Integer.parseInt(scanner.nextLine()); // 从System.in读取一行
if (amount % LOTTO_PRICE != 0) {
throw new IllegalArgumentException("金额必须是" + LOTTO_PRICE + "的倍数。");
}
return amount / LOTTO_PRICE;
}
}这个enterTheAmount方法旨在接收用户输入的金额,并验证其是否为LOTTO_PRICE(1000)的倍数。如果不是,则抛出IllegalArgumentException。
当尝试测试这种异常行为时,一个常见的错误做法是尝试直接对方法的“返回值”进行assertThat断言,并期望它是一个异常实例,如下所示:
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat; // 导入AssertJ的assertThat
import java.io.ByteArrayInputStream;
import java.io.InputStream;
public class ApplicationTest {
// 错误的测试方法示例
@Test
void validateTheEnteredAmount_IncorrectApproach() {
final String INVALID_NUMBER = "1234";
InputStream originalIn = System.in; // 保存原始System.in
try {
// 模拟用户输入
InputStream in = new ByteArrayInputStream(INVALID_NUMBER.getBytes());
System.setIn(in);
// 这种断言方式是错误的,会导致测试失败
// 因为enterTheAmount()在执行过程中就已经抛出异常,
// 导致assertThat根本无法接收到任何“值”来断言
assertThat(Application.enterTheAmount()).isInstanceOf(IllegalArgumentException.class);
} finally {
System.setIn(originalIn); // 恢复原始System.in
}
}
}上述validateTheEnteredAmount_IncorrectApproach测试方法会失败。原因在于,当Application.enterTheAmount()方法被调用时,如果输入是"1234",它会立即抛出IllegalArgumentException。这个异常不会被assertThat方法捕获并作为其参数进行处理,而是直接由JUnit测试框架捕获。JUnit会识别到测试方法中发生了未被处理的异常,并立即将该测试标记为失败,而不是等待assertThat完成其断言。因此,这种方式无法正确验证异常的抛出。
使用 assertThrows 进行正确断言
为了正确测试方法是否抛出特定异常,我们应该使用JUnit 5提供的assertThrows方法。assertThrows专门设计用于验证一个给定的可执行代码块(通常是一个lambda表达式)是否抛出了指定类型的异常。
assertThrows方法的基本语法如下:
assertThrows(ExpectedExceptionType.class, () -> { /* code that is expected to throw an exception */ });它接收两个参数:
- 期望的异常类型(例如IllegalArgumentException.class)。
- 一个Executable函数式接口的实例,通常以lambda表达式的形式提供,其中包含你希望执行并观察其异常行为的代码。
下面是使用assertThrows正确测试Application.enterTheAmount()方法抛出异常的示例:
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertThrows; // 导入JUnit 5的assertThrows
import static org.assertj.core.api.Assertions.assertThat; // 导入AssertJ用于进一步断言
import java.io.ByteArrayInputStream;
import java.io.InputStream;
public class ApplicationTest {
@Test
void enterTheAmount_ThrowsIllegalArgumentException_WhenInvalidInput() {
final String INVALID_NUMBER = "1234";
InputStream originalIn = System.in; // 保存原始System.in
try {
// 模拟用户输入
InputStream in = new ByteArrayInputStream(INVALID_NUMBER.getBytes());
System.setIn(in);
// 使用assertThrows验证异常
IllegalArgumentException thrown = assertThrows(
IllegalArgumentException.class,
() -> Application.enterTheAmount(), // 这里是期望抛出异常的代码
"当输入非法金额时,应该抛出IllegalArgumentException" // 失败时的消息
);
// 进一步断言异常消息(可选,但推荐)
assertThat(thrown.getMessage()).contains("金额必须是1000的倍数");
} finally {
System.setIn(originalIn); // 恢复原始System.in
}
}
@Test
void enterTheAmount_ReturnsCorrectValue_WhenValidInput() {
final String VALID_NUMBER = "3000";
InputStream originalIn = System.in;
try {
InputStream in = new ByteArrayInputStream(VALID_NUMBER.getBytes());
System.setIn(in);
int result = Application.enterTheAmount();
assertThat(result).isEqualTo(3); // 3000 / 1000 = 3
} finally {
System.setIn(originalIn);
}
}
}在这个正确的测试方法中:
- assertThrows(IllegalArgumentException.class, () -> Application.enterTheAmount()) 会执行lambda表达式() -> Application.enterTheAmount()。
- 如果Application.enterTheAmount()方法在执行过程中抛出了IllegalArgumentException,那么assertThrows会捕获这个异常,并将它作为返回值。此时,测试通过。
- 如果抛出了其他类型的异常,或者根本没有抛出异常,assertThrows会使测试失败,并给出相应的错误信息。
- assertThrows返回的异常实例可以被进一步用于断言异常的详细信息,例如异常消息 (thrown.getMessage()),这增加了测试的健壮性。
注意事项与最佳实践
- 精确指定异常类型: 尽量指定最具体的异常类型,而不是像Exception.class这样宽泛的类型。这有助于确保你的代码抛出的是预期的特定异常,而不是其他不相关的运行时错误。
- 断言异常消息: 在捕获到异常后,通过thrown.getMessage()来断言异常消息是否包含特定的文本,这能进一步验证异常抛出的原因是否正确。
- 模拟输入/环境: 如果你的方法依赖于外部输入(如System.in)或特定的系统环境,请确保在测试中正确地模拟这些依赖,并在测试结束后恢复原始状态,以避免对其他测试造成影响。例如,通过System.setIn()和System.setOut()重定向标准输入输出流。
- 一个测试只验证一个行为: 遵循单一职责原则,一个测试方法应该只验证一个特定的行为或场景。例如,一个测试验证非法输入抛出异常,另一个测试验证合法输入返回正确结果。
- 结合其他断言库: assertThrows是JUnit 5的一部分,但它与AssertJ等断言库可以很好地结合使用。assertThrows负责验证异常的类型和抛出,而AssertJ可以用于对捕获到的异常实例进行更丰富的链式断言。
总结
正确地测试方法抛出异常是编写健壮单元测试的关键部分。通过使用JUnit 5的assertThrows方法,开发者可以清晰、准确地验证代码在异常条件下的行为。避免直接对抛出异常的方法返回值进行断言的常见陷阱,并结合对异常消息的进一步断言,将大大提高测试的质量和可靠性。掌握这一技巧,能帮助我们构建更稳定、更易维护的应用程序。










