本文深入探讨了在junit测试中如何有效覆盖java服务层方法内`try-catch`块的异常处理路径。通过使用mockito模拟内部依赖抛出检查型异常，我们能够验证服务方法在特定异常场景下的行为，确保异常处理逻辑的健壮性，避免了直接模拟服务方法本身导致的问题。
在软件开发中，服务层方法经常需要与外部系统或库进行交互，这些交互过程中可能会抛出各种异常。为了确保应用程序的健壮性，我们通常会使用try-catch块来捕获并处理这些潜在的异常。然而，在编写单元测试时，如何有效地覆盖这些catch块的逻辑，尤其是当异常是由内部依赖抛出时，是一个常见的挑战。
待测试的服务方法示例
考虑以下服务方法，它尝试通过snsProducer发送一条消息，并在发送过程中遇到JsonProcessingException时，将其包装成自定义的SnSException抛出：
public class MyService {
private SnsProducer snsProducer; // 假设这是一个被注入的依赖
public MyService(SnsProducer snsProducer) {
this.snsProducer = snsProducer;
}
public void doCreate(Message message) {
try {
snsProducer.send(message);
} catch (JsonProcessingException jpe) {
// 将JsonProcessingException包装成自定义的SnSException抛出
throw new SnSException("Could not parse Message to publish to SNS", jpe);
}
}
}
// 假设SnSException是一个自定义的运行时异常
class SnSException extends RuntimeException {
public SnSException(String message, Throwable cause) {
super(message, cause);
}
}
// 假设SnsProducer接口及其send方法
interface SnsProducer {
void send(Message message) throws JsonProcessingException;
}
// 假设Message是一个简单的POJO
class Message {}我们的目标是编写一个JUnit测试，来验证当snsProducer.send(message)抛出JsonProcessingException时，doCreate方法确实会捕获它并抛出SnSException。
错误的测试尝试及其原因
在尝试覆盖catch块时，开发者可能会遇到一些常见的误区。
误区一：直接模拟服务方法本身抛出检查型异常
@Test
void snsTest_IncorrectAttempt1() {
// 假设service和message已被正确初始化
// MyService service = new MyService(mock(SnsProducer.class));
// Message message = new Message();
// 尝试让service.doCreate(message)直接抛出JsonProcessingException
// 这里的service是真实的实例，不是mock对象
// 如果service是mock对象，且doCreate方法没有声明抛出JsonProcessingException，
// 则会编译错误或运行时异常
// when(service.doCreate(message)).thenThrow(new JsonProcessingException("Json Processing Error"){}); // 编译错误或运行时异常
// assertThrows(SnSException.class, () -> service.doCreate(message));
}问题分析： 如果service是一个真实的MyService实例，when().thenThrow()不能直接作用于它。如果service是一个Mockito的mock对象，那么doCreate方法本身并没有声明会抛出JsonProcessingException（它内部处理了），所以尝试让mock对象直接抛出JsonProcessingException会导致Checked exception is invalid for this method!这样的错误。这是因为Mockito在模拟方法抛出检查型异常时，会检查被模拟方法的签名是否声明了该异常。
误区二：直接模拟服务方法本身抛出预期的运行时异常
@Test
void snsTest_IncorrectAttempt2() {
// 假设service和message已被正确初始化
// MyService service = new MyService(mock(SnsProducer.class));
// Message message = new Message();
// 尝试让service.doCreate(message)直接抛出SnSException
// when(service.doCreate(message)).thenThrow(new SnSException("Exception", new JsonProcessingException(""))); // 假设service是mock对象
// assertThrows(SnSException.class, () -> service.doCreate(message));
}问题分析： 这种方法虽然可以避免编译错误（因为SnSException是运行时异常），但它完全绕过了MyService中doCreate方法的实际逻辑。when(service.doCreate(message)).thenThrow(...)意味着当调用service.doCreate(message)时，直接抛出SnSException，而不会执行try-catch块内部的snsProducer.send(message)调用。因此，我们并没有真正测试到catch块的逻辑，而是测试了mock对象的行为。assertThrows会捕获到我们模拟的SnSException，但这不是我们想要测试的场景。
正确的测试方法：模拟内部依赖的行为
要正确测试catch块，关键在于让try块内部的实际代码路径抛出异常，从而触发catch块的执行。这意味着我们需要模拟MyService的内部依赖snsProducer的行为。
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import com.fasterxml.jackson.core.JsonProcessingException;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.when;
public class MyServiceTest {
@Mock
private SnsProducer snsProducer; // 模拟SnsProducer依赖
@InjectMocks
private MyService myService; // 注入mock的snsProducer到myService中
@BeforeEach
void setUp() {
MockitoAnnotations.openMocks(this); // 初始化mock对象
}
@Test
void doCreate_shouldThrowSnSException_whenJsonProcessingExceptionOccurs() throws JsonProcessingException {
Message testMessage = new Message(); // 创建一个测试消息对象
// 核心：当snsProducer.send(any(Message.class))被调用时，抛出JsonProcessingException
// 这里使用doThrow().when()，或者when().thenThrow()都可以，取决于个人偏好和方法签名
// 因为send方法声明了throws JsonProcessingException，所以可以直接使用when().thenThrow()
when(snsProducer.send(any(Message.class)))
.thenThrow(new JsonProcessingException("模拟的JSON处理错误") {});
// 验证当调用myService.doCreate(testMessage)时，是否抛出了SnSException
assertThrows(SnSException.class, () -> myService.doCreate(testMessage));
}
}解释：
- @Mock private SnsProducer snsProducer;: 我们创建了一个SnsProducer的模拟对象。
- @InjectMocks private MyService myService;: Mockito会将@Mock标记的snsProducer自动注入到myService实例中。
- when(snsProducer.send(any(Message.class))).thenThrow(new JsonProcessingException("模拟的JSON处理错误") {});: 这是关键一步。我们指示Mockito：当myService内部调用其snsProducer的send方法时（无论传入什么Message对象，因为使用了any(Message.class)），都不要执行实际的send逻辑，而是直接抛出一个JsonProcessingException实例。
- assertThrows(SnSException.class, () -> myService.doCreate(testMessage));: 最后，我们断言当调用myService.doCreate(testMessage)时，会抛出SnSException。
通过这种方式，myService.doCreate(testMessage)方法会正常执行到try块内部的snsProducer.send(message)。由于snsProducer已经被模拟成抛出JsonProcessingException，这个异常会被doCreate方法中的catch (JsonProcessingException jpe)块捕获，进而抛出SnSException。assertThrows成功捕获到这个SnSException，从而验证了catch块的逻辑是正确的。
注意事项与最佳实践
- 关注点分离： 单元测试应该专注于测试单个组件（这里是MyService）的逻辑，而不是其依赖项的逻辑。通过模拟依赖项，我们可以隔离测试范围。
- 模拟正确的对象： 异常应该由try块内部实际调用的方法抛出。因此，应该模拟该方法所属的依赖对象，而不是被测试的服务方法本身。
- 匹配异常类型： 确保你模拟抛出的异常类型与catch块声明捕获的异常类型相匹配。如果catch块捕获的是IOException，而你模拟抛出NullPointerException，那么catch块将不会被触发。
- 验证异常内容： 除了验证异常类型，还可以进一步验证异常消息或嵌套异常（cause），以确保异常被正确包装和传递。
- 避免过度模拟： 只模拟那些必要的部分。如果一个方法内部的某个依赖在当前测试场景中不会抛出异常，或者其返回值不影响测试结果，则无需对其进行复杂的模拟。
总结
在JUnit测试中覆盖try-catch块，特别是当异常来源于内部依赖时，需要精确地模拟依赖的行为。通过使用Mockito的when().thenThrow()（或doThrow().when()）机制，我们可以让被测试方法内部的依赖在特定条件下抛出预期的异常，从而激活catch块的逻辑，验证其处理路径的正确性。这种方法确保了测试的准确性和隔离性，是编写健壮单元测试的关键实践之一。
