本文旨在解决在使用 Mockito 模拟 WebClient 请求时，遇到的模拟失效问题。通过分析问题根源，提供可行的解决方案，包括如何正确地 mock WebClient 以及如何避免常见的错误。同时，本文还提供代码示例，帮助读者更好地理解和应用这些技巧，从而编写出高质量的单元测试。
在使用 WebClient 进行外部 HTTP 请求时，编写单元测试通常需要 mock WebClient 以避免实际的网络调用。然而，不正确的 mock 方式可能导致测试失败，返回意料之外的结果，例如 HTML 文件而不是预期的 JSON 响应。以下将介绍一种正确的 mock WebClient 的方法，并解释常见错误的原因。
问题分析
常见的错误在于，测试代码中创建的 mock WebClient 实例并没有真正被 getResponse 方法使用。这意味着 getResponse 方法可能创建了一个新的 WebClient 实例，而不是使用 mock 实例，因此 mock 设置无效。
解决方案
解决此问题的关键在于确保 getResponse 方法使用的是 mock WebClient 实例。一种常用的方法是将 WebClient 的创建过程提取到一个可 mock 的方法中。
示例代码
-
提取 WebClient 创建方法：
public class SomeService { private WebClient client; public SomeService(WebClient client) { this.client = client; } // 将 WebClient 的创建提取到单独的方法中 WebClient buildWebClient() { // build your webclient using the WebClientBuilder return WebClient.builder().baseUrl("your_base_url").build(); // 示例，实际配置根据需要修改 } public String getResponse(String requestBody){ WebClient client = buildWebClient(); // 使用提取的方法创建 WebClient 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; } } -
在单元测试中 mock buildWebClient() 方法：
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.mockito.InjectMocks; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.junit.jupiter.MockitoExtension; import org.springframework.web.reactive.function.BodyInserters; import org.springframework.web.reactive.function.client.ClientResponse; import org.springframework.web.reactive.function.client.WebClient; 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; @ExtendWith(MockitoExtension.class) public class SomeServiceTest { @Mock private WebClient webClientMock; @Mock private WebClient.RequestBodyUriSpec requestBodyUriMock; @Mock private WebClient.RequestHeadersSpec requestHeadersMock; @Mock private WebClient.ResponseSpec responseMock; @InjectMocks private SomeService someService; // 使用 @InjectMocks, Mockito 会尝试自动注入依赖 @Test public void testGetResponse() { String requestBody = "test_request_body"; // Stub buildWebClient 方法，返回 mock 的 WebClient Mockito.doReturn(webClientMock).when(someService).buildWebClient(); 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")); String response = someService.getResponse(requestBody); assertEquals("response", response); } }
注意事项
- Mockito.doReturn().when(): 使用 Mockito.doReturn().when() 来 stub 方法，尤其是当方法是 void 类型或者需要 stub protected/private 方法时。
- ArgumentMatchers.eq(): 确保使用 ArgumentMatchers.eq() 来精确匹配参数，避免因参数类型不匹配导致的 mock 失效。
- 依赖注入: 使用 @InjectMocks 注解，让 Mockito 自动将 mock 对象注入到目标类中，简化测试代码。
- WebClient 构建器: 如果 WebClient 的构建过程比较复杂，可以考虑 mock WebClient.Builder，然后使用 build() 方法来创建 mock 的 WebClient 实例。
总结
通过将 WebClient 的创建过程提取到一个可 mock 的方法中，并在单元测试中使用 Mockito.doReturn().when() 来 stub 该方法，可以有效地 mock WebClient 请求，从而编写出可靠的单元测试。同时，注意使用 ArgumentMatchers.eq() 来精确匹配参数，并使用 @InjectMocks 进行依赖注入，可以进一步简化测试代码，提高测试效率。
