本文旨在指导开发者如何在 Mockito 单元测试中模拟 RestClientException 异常。通过模拟 RestTemplate 的 exchange 方法抛出异常，并结合 assertThrows 或 assertThatCode 断言，可以有效地测试服务在遇到外部 API 错误时的处理逻辑，保证程序的健壮性。
在进行单元测试时，我们经常需要模拟外部依赖的行为，以便隔离被测代码并专注于其自身的逻辑。当被测代码依赖于 RestTemplate 调用外部 API 时，模拟 API 调用失败的情况，例如抛出 RestClientException，就显得尤为重要。以下介绍如何在 Mockito 中模拟 RestClientException，并验证异常处理逻辑。
模拟 RestTemplate 抛出 RestClientException
可以使用 doThrow 方法来模拟 RestTemplate 的 exchange 方法抛出 RestClientException。以下是一个示例：
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpMethod;
import org.springframework.web.client.RestClientException;
import org.springframework.web.client.RestTemplate;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.*;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.verify;
import org.springframework.http.ResponseEntity;
import org.springframework.http.HttpStatus;
import org.junit.jupiter.api.extension.ExtendWith;
@ExtendWith(MockitoExtension.class)
public class IdpFacadeClientTest {
@Mock
private RestTemplate restTemplate;
@InjectMocks
private IdpFacadeClient idpFacadeClient;
// 假设的 DTO 类，用于更新记录
static class UpdateRecordsDto {
private String firstName;
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
}
private String idpFacadeUpdateUrl = "http://example.com/update";
@Test
void test_update_customer_in_ath0_server_error(){
//given
UpdateRecordsDto updateRecordsDto = new UpdateRecordsDto();
updateRecordsDto.setFirstName("testFirstName");
//when
doThrow(new RestClientException("Idp facade API error"))
.when(restTemplate).exchange(anyString(), eq(HttpMethod.PATCH), any(HttpEntity.class), eq(String.class));
//then
assertThrows(RestClientException.class, () -> idpFacadeClient.updateCustomerFirstNameInIdp(updateRecordsDto));
}
private boolean verifyUpdatedCustomerBody(HttpEntity entity) {
// 实现根据 entity 内容进行验证的逻辑
return true; // 示例，始终返回 true
}
// 模拟的 IdpFacadeClient 类
class IdpFacadeClient {
public String updateCustomerFirstNameInIdp(UpdateRecordsDto customerUpdateRecordsDto) {
String response = null;
try {
ResponseEntity restResponse = restTemplate.exchange(idpFacadeUpdateUrl, HttpMethod.PATCH, new HttpEntity<>(customerUpdateRecordsDto), String.class);
if (restResponse.getStatusCode() == HttpStatus.OK) {
//log.info("customer first name update success {} with status {}", customerUpdateRecordsDto.getFirstName(), response.getStatusCode());
}else {
//log.error("Customer first name update failed in IDP for {} with status {}", customerUpdateRecordsDto.getFirstName(), response.getStatusCode());
}
} catch (RestClientException e) {
throw new RestClientException("Idp facade API error for user first name " + customerUpdateRecordsDto.getFirstName(), e);
}
return response;
}
}
} 代码解释：
- @Mock private RestTemplate restTemplate;: 使用 @Mock 注解创建一个 RestTemplate 的 Mock 对象。
- @InjectMocks private IdpFacadeClient idpFacadeClient;: 使用 @InjectMocks 注解创建 IdpFacadeClient 的实例，并将 Mock 的 restTemplate 注入到该实例中。
- doThrow(new RestClientException("Idp facade API error")) .when(restTemplate).exchange(anyString(), eq(HttpMethod.PATCH), any(HttpEntity.class), eq(String.class));: 使用 doThrow 方法配置 restTemplate 的 exchange 方法，使其在被调用时抛出一个 RestClientException 异常。 anyString()、eq(HttpMethod.PATCH)、any(HttpEntity.class) 和 eq(String.class) 是参数匹配器，用于匹配 exchange 方法的参数。 anyString() 匹配任何字符串类型的 URL。 eq(HttpMethod.PATCH) 匹配 HttpMethod.PATCH 枚举值。 any(HttpEntity.class) 匹配任何 HttpEntity 类型的对象。 eq(String.class) 匹配 String.class 对象。
- assertThrows(RestClientException.class, () -> idpFacadeClient.updateCustomerFirstNameInIdp(updateRecordsDto));: 使用 assertThrows 断言来验证 idpFacadeClient.updateCustomerFirstNameInIdp(updateRecordsDto) 方法是否抛出了预期的 RestClientException 异常。
注意事项：
- 确保在测试类上添加了 @ExtendWith(MockitoExtension.class) 注解，以启用 Mockito 的注解处理器。
- any() 和 eq() 是 Mockito 提供的参数匹配器，用于匹配方法调用的参数。可以根据实际情况选择合适的参数匹配器。
- 可以使用 assertThrows 或 assertThatCode(…).hasMessageContaining(…) 来验证异常的类型和消息内容。
总结
通过使用 Mockito 的 doThrow 方法，可以方便地模拟 RestTemplate 抛出 RestClientException 异常，从而测试服务在遇到外部 API 错误时的处理逻辑。结合 assertThrows 或 assertThatCode 断言，可以有效地验证异常处理的正确性，提高代码的健壮性和可靠性。在实际开发中，应该充分利用 Mockito 提供的各种功能，编写高质量的单元测试，保证代码的质量。
