JavaWebClientmock测试技巧全解析

小伙伴们对文章编程感兴趣吗？是否正在学习相关知识点？如果是，那么本文《Java WebClient 单元测试 mock 方法详解》，就很适合你，本篇文章讲解的知识点主要包括。在之后的文章中也会多多分享相关知识点，希望对大家的知识积累有所帮助！

本文旨在解决 Java WebClient 单元测试中 Mock 不生效的问题。通过分析常见错误原因，提供了一种通过可 Mock 方法构建 WebClient 的解决方案，并指出了 Mockito eq() 方法使用的必要性，帮助开发者编写可靠的 WebClient 单元测试。

在进行 Java WebClient 的单元测试时，Mock WebClient 是一个常见的需求。但有时 Mock 却无法生效，导致测试结果与预期不符。本文将分析可能的原因，并提供解决方案，帮助你正确地 Mock WebClient，编写可靠的单元测试。

问题分析：WebClient 实例未被 Mock 替换

最常见的问题是 getResponse 方法中使用的 WebClient 实例并非测试用例中 Mock 的 webClientMock。 如果你在 getResponse 方法内部直接创建 WebClient 实例，Mock 的 webClientMock 就不会被使用到。

解决方案：通过可 Mock 方法构建 WebClient

为了解决这个问题，可以将 WebClient 的构建过程提取到一个单独的方法中，并使用 Mockito 桩截 (stubbing) 该方法。

1. 创建 WebClient 构建方法：

   在你的 Service 类中，创建一个用于构建 WebClient 实例的方法。建议添加 @VisibleForTesting 注解，明确该方法是为了方便测试而存在。

   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();
       }
   
       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;
       }
   }

2. 在测试用例中 Mock 构建方法：

   使用 Mockito.doReturn() 方法，桩截 someServiceSpy 的 buildWebClient() 方法，使其返回 Mock 的 webClientMock 实例。

   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 reactor.core.publisher.Mono;
   
   import static org.junit.jupiter.api.Assertions.assertEquals;
   import static org.mockito.Mockito.when;
   
   public class SomeServiceTest {
   
       @Test
       public 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);
   
           String requestBody = "your_request_body";
   
           SomeService someService = new SomeService();
           SomeService someServiceSpy = Mockito.spy(someService); // 创建 Spy 对象
   
           // 桩截 buildWebClient() 方法，返回 Mock 的 webClientMock
           Mockito.doReturn(webClientMock).when(someServiceSpy).buildWebClient();
   
           when(webClientMock.post()).thenReturn(requestBodyUriMock);
           when(requestBodyUriMock.body(BodyInserters.fromValue(requestBody))).thenReturn(requestHeadersMock);
           when(requestHeadersMock.retrieve()).thenReturn(responseMock);
           when(responseMock.bodyToMono(String.class)).thenReturn(Mono.just("response"));
   
           String response = someServiceSpy.getResponse(requestBody);
   
           assertEquals("response", response);
       }
   }

注意事项：Mockito eq() 方法的使用

在 Mockito 中，当 Mock 方法的参数是复杂对象时，需要使用 eq() 方法进行精确匹配。否则，即使参数的值相同，Mockito 也可能认为参数不匹配，导致 Mock 失效。

因此，将以下代码：

when(requestBodyUriMock.body(BodyInserters.fromValue(requestBody))).thenReturn(requestHeadersMock);

修改为：

import static org.mockito.ArgumentMatchers.eq;

when(requestBodyUriMock.body(eq(BodyInserters.fromValue(requestBody)))).thenReturn(requestHeadersMock);

总结

通过将 WebClient 的构建过程提取到可 Mock 的方法中，并使用 Mockito.doReturn() 桩截该方法，可以确保在单元测试中使用 Mock 的 WebClient 实例。同时，对于复杂参数的 Mock，务必使用 eq() 方法进行精确匹配，以保证 Mock 的正确性。遵循这些原则，你就能编写出更可靠的 Java WebClient 单元测试。

到这里，我们也就讲完了《JavaWebClientmock测试技巧全解析》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！