本文旨在解决在使用 WebClient 发送请求时，如何在单元测试中使用 Mockito 进行模拟，以获得预期的响应。文章将分析常见错误，并提供可行的解决方案，包括如何正确地 mock WebClient 对象以及如何处理 BodyInserters.fromValue() 方法的参数匹配问题。
在使用 spring WebClient 进行外部服务调用时，编写单元测试并模拟 WebClient 的行为至关重要。 然而，不正确的模拟方式会导致测试结果与预期不符，例如返回 html 文件而不是期望的 json 响应。 本文将探讨一个常见的 WebClient 模拟问题，并提供清晰的解决方案。
问题分析
问题在于 getResponse 方法中使用的 client 对象，很可能并非测试用例中创建的 mock 对象 (webClientMock)。 如果 client 对象在 getResponse 方法内部创建，那么即使 mock 了 WebClientBuilder，也无法影响到实际使用的 WebClient 实例。
解决方案：可 Mock 的 WebClient 构建方法
为了解决这个问题，建议创建一个可 mock 的方法来构建 WebClient 实例。 这样，在单元测试中就可以通过 Mockito 来 stub 这个方法，从而确保 getResponse 方法中使用的是 mock 过的 WebClient 对象。
步骤 1：创建 WebClient 构建方法
在你的 service 类中，创建一个专门用于构建 WebClient 实例的方法，例如 buildWebClient()：
import org.springframework.web.reactive.function.client.WebClient; import com.google.common.annotations.VisibleForTesting; public class SomeService { @VisibleForTesting WebClient buildWebClient() { // 使用 WebClientBuilder 构建 WebClient 实例 return WebClient.builder().baseUrl("your_base_url").build(); // 替换为你的实际 base URL } public String getResponse(String requestBody){ // 使用 buildWebClient() 方法获取 WebClient 实例 WebClient client = buildWebClient(); WebClient.RequestHeadersSpec<?> request = client.post().body(BodyInserters.fromValue(requestBody)); String resp = request.retrieve().bodyToMono(String.class) .doOnError( WebClientResponseException.class, err -> { // do something }) .block(); return resp; } }
- @VisibleForTesting 注解：这是一个来自 Google guava 库的注解，用于表明该方法是为了方便测试而存在的。 这样可以避免在生产代码中随意调用该方法。 需要添加Guava依赖，例如maven：
<dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>31.1-jre</version> </dependency>
步骤 2：在单元测试中 Stub 构建方法
在你的单元测试中，使用 Mockito.doReturn() 方法来 stub buildWebClient() 方法，使其返回 mock 过的 WebClient 对象：
import org.junit.jupiter.api.Test; import org.mockito.Mockito; import org.springframework.web.reactive.function.BodyInserters; import org.springframework.web.reactive.function.client.WebClient; import org.springframework.web.reactive.function.client.WebClientResponseException; import reactor.core.publisher.Mono; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.when; public class SomeServiceTest { @Test void testGetResponse() { // 创建 mock 对象 WebClient webClientMock = Mockito.mock(WebClient.class); WebClient.RequestBodyUriSpec requestBodyUriMock = Mockito.mock(WebClient.RequestBodyUriSpec.class); WebClient.RequestHeadersSpec requestHeadersMock = Mockito.mock(WebClient.RequestHeadersSpec.class); WebClient.ResponseSpec responseMock = Mockito.mock(WebClient.ResponseSpec.class); SomeService someService = new SomeService(); SomeService someServiceSpy = Mockito.spy(someService); String requestBody = "test_request_body"; // Stub buildWebClient() 方法 Mockito.doReturn(webClientMock).when(someServiceSpy).buildWebClient(); // 设置 mock 对象的行为 when(webClientMock.post()).thenReturn(requestBodyUriMock); when(requestBodyUriMock.body(eq(BodyInserters.fromValue(requestBody)))).thenReturn(requestHeadersMock); when(requestHeadersMock.retrieve()).thenReturn(responseMock); when(responseMock.bodyToMono(String.class)).thenReturn(Mono.just("response")); // 调用 getResponse 方法 String response = someServiceSpy.getResponse(requestBody); // 断言结果 assertEquals("response", response); } }
步骤 3：处理 BodyInserters.fromValue() 的参数匹配
Mockito 默认使用 equals() 方法进行参数匹配。 对于 BodyInserters.fromValue() 方法，直接使用 equals() 可能会失败，因为 BodyInserters.fromValue() 返回的对象可能没有正确实现 equals() 方法。
为了解决这个问题，可以使用 ArgumentMatchers.eq() 方法来确保参数匹配的准确性：
when(requestBodyUriMock.body(eq(BodyInserters.fromValue(requestBody)))).thenReturn(requestHeadersMock);
总结
通过将 WebClient 的构建过程提取到一个可 mock 的方法中，并使用 ArgumentMatchers.eq() 方法进行参数匹配，可以有效地模拟 WebClient 的行为，从而编写可靠的单元测试。 这种方法不仅解决了模拟 WebClient 的问题，还提高了代码的可测试性和可维护性。
