如何在@Service中模拟Spring@Autowired-WebClient响应？

Question

我想测试使用自动连线网络客户端的服务类检索不同响应JSON时的程序行为。为此，我希望在测试中能够用从文件读取的JSON替换从api url检索的响应体JSON。

具体来说，我想测试DTO中使用@NotNull和@Size注释（当JSON无效时）进行的验证，以及使用方法检索从JSON映射的不同（有效）模型时使用@Autowired ModelService的类的行为。getModel（）。

我的服务是这样的：

@Service
public class ModelServiceImpl implements ModelService {

   @Autowired
   ApiPropertiesConfig apiProperties;

   @Autowired
   private WebClient webClient;

   private static final ModelMapper modelMapper = Mappers.getMapper(ModelMapper.class);

   public Mono<Model> getModel() throws ConfigurationException {
   
       String apiUrl = apiProperties.getApiUrl();

       return webClient.get()
               .uri(apiUrl)
               .accept(MediaType.APPLICATION_JSON)
               .retrieve()
               .bodyToMono(ModelDTO.class)
               .map(modelMapper::modelDTOtoModel);
   }
}

我的网络客户端定义为：

@Configuration
@EnableWebFlux
public class WebFluxConfig implements WebFluxConfigurer {

   @Bean
   public WebClient getWebClient() {
       HttpClient httpClient = HttpClient.create()
               .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 10000)
               .doOnConnected(conn -> conn
                       .addHandlerLast(new ReadTimeoutHandler(10))
                       .addHandlerLast(new WriteTimeoutHandler(10)));

       ClientHttpConnector connector = new ReactorClientHttpConnector(httpClient.wiretap(true));

       return WebClient.builder()
               .clientConnector(connector)
               .defaultHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
               .build();
   }
}

ApiPropertiesConfig是：

@Configuration
@ConfigurationProperties(prefix = "api")
@Data
@Primary
public class ApiPropertiesConfig {
   private String apiUrl;
}

我将测试类设置为：

@SpringBootTest
@TestPropertySource(properties = {
       "api.apiUrl=https://url.to.production.model/model.json"
})
@ExtendWith(MockitoExtension.class)
class ApplicationTests {

}

正如你们所见，当我调用modelSerice时。getModel（）webclient从api url检索json，将其转换为DTO，然后使用Mapstruct接口将其映射到POJO。

我已经阅读了这里建议的选项：如何模拟Spring WebFlux WebClient？，但在测试过程中，我无法理解如何在服务中用模拟的WebClient“替换”自动连接的WebClient。




Answer 1

您的问题源于您使用的是字段注入而不是使用基于构造函数的注入的最佳实践。除了前者产生的——正如您所注意到的——代码难以测试之外，它还有其他缺点。例如：

1. 它不允许创建不可变组件（即字段不是final）
2. 这可能会导致html" target="_blank">代码违反单一责任原则（因为您可能很容易注入大量的依赖项，这些依赖项可能会被忽略）
3. 它将您的代码直接耦合到DI容器（即，您不能在DI容器之外轻松使用代码）
4. 它可能隐藏注入的依赖项（即可选依赖项和必需依赖项之间没有明确的区别）

基于所有这些，如果您使用构造函数注入来完成您的工作会更好。有了这一点，向服务中注入模拟可以像这样简单地完成：

@Mock // The mock we need to inject
private MyMockedService mockedService;

@InjectMocks // The unit we need to test and inject mocks to
private MyUnitToTestServiceImpl unitToTestService;

或者，您可以直接使用实例化要测试的单元，只需通过其公共构造函数传入模拟实例。

因此，经验法则是在这种情况下始终使用构造函数注入。

Answer 2

由于您使用了SpringBootTest注释，该注释通过SpringExtension增强了您的测试，因此您可以使用MockBean将模拟bean注入到应用程序上下文中，并替换现有的：

@SpringBootTest
@TestPropertySource(properties = {
       "api.apiUrl=https://url.to.production.model/model.json"
})
class ApplicationTests {
    @Mock
    private WebClient.RequestHeadersUriSpec<?> requestHeadersUriMock;
    @Mock
    private WebClient.RequestHeadersSpec<?> requestHeadersMock;
    @Mock
    private WebClient.ResponseSpec responseMock;
    @MockBean
    private WebClient webClientMock;
    private final ModelDTO mockModelDTO = new ModelDTO(.....);

    @Autowired
    private ModelService modelService;


    @Test
    void testModelServiceGetModel() {
        prepareWebClientMock();

        final Model model = modelService.getModel().block();
        assertThat(model).isNotNull();
    }

    private void prepareWebClientMock() {
        doReturn(requestHeadersUriMock).when(webClientMock).get();
        doReturn(requestHeadersMock).when(requestHeadersUriMock).uri(anyString());
        doReturn(requestHeadersMock).when(requestHeadersMock).accept(any());
        doReturn(responseMock).when(requestHeadersMock).retrieve();
        doReturn(Mono.just(mockModelDTO))
                .when(responseMock).bodyToMono(eq(ModelDTO.class));
    }
}