本文旨在解决在使用 WebClient 进行请求时，对 doOnError 方法进行单元测试时遇到的问题。通常，直接抛出 WebClientResponseException 无法触发 doOnError 中的异常处理逻辑。本文将介绍如何使用 Mono.error 正确地模拟异常，从而确保 doOnError 能够被有效测试。
在使用 Spring WebClient 进行外部服务调用时，doOnError 方法用于处理请求过程中发生的异常。为了保证代码的健壮性，我们需要对 doOnError 逻辑进行单元测试。然而，直接在 Mockito 中 thenThrow 抛出 WebClientResponseException 往往无法触发 doOnError 中的异常处理。这是因为 WebClient 内部使用了 Reactor 响应式编程模型，异常需要通过 Mono.error 传递才能被正确处理。
下面通过一个示例来说明如何正确地测试 doOnError。
示例代码：
假设有如下代码片段，使用 WebClient 发送请求，并在 doOnError 中将 WebClientResponseException 转换为自定义异常 InvalidRequestException：
import org.springframework.web.reactive.function.client.WebClient;
import org.springframework.web.reactive.function.client.WebClientResponseException;
import reactor.core.publisher.Mono;
public class SomeService {
private final WebClient client;
public SomeService(WebClient client) {
this.client = client;
}
public String getResponse(String requestBody) {
return client.post()
.bodyValue(requestBody)
.retrieve()
.bodyToMono(String.class)
.doOnError(
WebClientResponseException.class,
err -> {
// 模拟一些处理逻辑
System.out.println("Error occurred: " + err.getResponseBodyAsString());
throw new InvalidRequestException(err.getResponseBodyAsString());
})
.block();
}
// 自定义异常
public static class InvalidRequestException extends RuntimeException {
public InvalidRequestException(String message) {
super(message);
}
}
}错误的单元测试示例：
以下是一个错误的单元测试示例，直接使用 thenThrow 抛出 WebClientResponseException：
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.web.reactive.function.client.WebClient;
import org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec;
import org.springframework.web.reactive.function.client.WebClient.RequestBodySpec;
import org.springframework.web.reactive.function.client.WebClient.ResponseSpec;
import org.springframework.web.reactive.function.client.WebClientResponseException;
import reactor.core.publisher.Mono;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
@ExtendWith(MockitoExtension.class)
public class SomeServiceTest {
@Mock
private WebClient webClientMock;
@Mock
private RequestBodySpec requestBodyUriMock;
@Mock
private RequestHeadersSpec requestHeadersMock;
@Mock
private ResponseSpec responseMock;
@InjectMocks
private SomeService someService;
@Test
public void testGetResponse_doOnError() {
String requestBody = "test request";
String expectedMessage = "Bad Request";
WebClientResponseException thrownException = new WebClientResponseException(400, expectedMessage, null, null, null);
when(webClientMock.post()).thenReturn(requestBodyUriMock);
when(requestBodyUriMock.bodyValue(any())).thenReturn(requestHeadersMock);
when(requestHeadersMock.retrieve()).thenReturn(responseMock);
// 错误的方式：直接 thenThrow
when(responseMock.bodyToMono(String.class)).thenThrow(thrownException);
InvalidRequestException exception = assertThrows(InvalidRequestException.class, () -> {
someService.getResponse(requestBody);
});
assertEquals(expectedMessage, exception.getMessage());
}
}在这个例子中，尽管我们期望 InvalidRequestException 被抛出，但实际上抛出的是 WebClientResponseException。
正确的单元测试示例：
使用 Mono.error 包装异常：
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.web.reactive.function.client.WebClient;
import org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec;
import org.springframework.web.reactive.function.client.WebClient.RequestBodySpec;
import org.springframework.web.reactive.function.client.WebClient.ResponseSpec;
import org.springframework.web.reactive.function.client.WebClientResponseException;
import reactor.core.publisher.Mono;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
@ExtendWith(MockitoExtension.class)
public class SomeServiceTest {
@Mock
private WebClient webClientMock;
@Mock
private RequestBodySpec requestBodyUriMock;
@Mock
private RequestHeadersSpec requestHeadersMock;
@Mock
private ResponseSpec responseMock;
@InjectMocks
private SomeService someService;
@Test
public void testGetResponse_doOnError() {
String requestBody = "test request";
String expectedMessage = "Bad Request";
WebClientResponseException thrownException = new WebClientResponseException(400, expectedMessage, null, null, null);
when(webClientMock.post()).thenReturn(requestBodyUriMock);
when(requestBodyUriMock.bodyValue(any())).thenReturn(requestHeadersMock);
when(requestHeadersMock.retrieve()).thenReturn(responseMock);
// 正确的方式：使用 Mono.error 包装异常
when(responseMock.bodyToMono(String.class)).thenReturn(Mono.error(thrownException));
InvalidRequestException exception = assertThrows(InvalidRequestException.class, () -> {
someService.getResponse(requestBody);
});
assertEquals(expectedMessage, exception.getMessage());
}
}在这个修正后的例子中，我们使用 Mono.error(thrownException) 包装了 WebClientResponseException。这样，doOnError 方法就能正确捕获异常，并执行相应的处理逻辑，最终抛出 InvalidRequestException。
总结与注意事项：
- 在对 WebClient 的 doOnError 方法进行单元测试时，务必使用 Mono.error 包装异常。
- 确保 Mockito 的 when 方法返回的是 Mono.error，而不是直接 thenThrow 异常。
- 通过这种方式，可以有效地测试 doOnError 中的异常处理逻辑，保证代码的健壮性。
- 实际应用中，可以根据具体的业务逻辑，模拟不同的异常场景，并编写相应的单元测试。
通过本文的介绍，你应该能够正确地对 WebClient 的 doOnError 方法进行单元测试，从而提高代码的质量和可靠性。
