Java 单元测试中正确模拟 void 方法的 Mockito 用法

在使用 mockito 对返回 void 的 aws s3 客户端方法(如 `deleteobject`)进行单元测试时,需使用 `donothing()` 而非 `when()`,因为后者仅适用于有返回值的方法。

在 Java 单元测试中,当被测类(如 MyClass)内部直接调用第三方 SDK 的 void 方法(例如 AmazonS3.deleteObject(DeleteObjectRequest)),而你又不希望该操作真实执行(如触发网络请求或删除真实对象),就必须对依赖对象(s3Client)进行行为模拟。但此处有一个关键陷阱:Mockito 的 when(...).thenReturn(...) 语法仅适用于返回非 void 类型的方法;对于 void 方法,编译器会报错:

when

(T) cannot be applied to void. reason: no instances of type variable T exist so that void conforms to T.

这是因为 when() 是基于“调用并获取返回值”设计的,而 void 方法没有返回值可捕获。

✅ 正确解法是使用 doNothing() 配合 when() 的替代语法——即 doNothing().when(mock).method()

// 正确:模拟 void 方法,跳过实际执行
doNothing()
    .when(s3Client)
    .deleteObject(any(DeleteObjectRequest.class));

该语句明确告诉 Mockito:当 s3Client.deleteObject(...) 被任意参数调用时,什么也不做(no-op),从而安全跳过该行逻辑,不影响后续测试流程。

⚠️ 注意事项:

  • 必须确保 s3Client 字段已在测试类中正确注入或赋值(例如通过构造函数、setter 或 @InjectMocks + @Mock 组合);
  • 若 s3Client 是私有 final 字段且未提供注入点,需考虑重构为可测试设计(如依赖抽象接口 S3ClientService 并注入 mock);
  • 避免混用 when().thenReturn() 和 doNothing() 处理同一 mock 对象的 void 方法,否则可能引发 UnfinishedStu*gException;
  • 如需验证该方法是否被调用,可用 verify(s3Client).deleteObject(...) 进行行为断言。

? 总结:对 void 方法模拟,请始终优先选用 doAnswer() / doThrow() / doNothing() 系列 API;when() 仅用于有返回值的场景。这是 Mockito 行为模拟的核心约定,也是编写健壮、可维护单元测试的基础规范。