Spring-Boot RestClientTest 由于未绑定 RestTemplate 而无法正确自动配置 MockRestServiceServer

rest java spring spring-boot

2022-09-03 07:13:53

编辑：这个问题特别与spring-boot 1.4.0中引入的@RestClientTest注释有关，该注释旨在取代工厂方法。

问题：

根据文档，@RestClientTest应正确配置在测试 REST 客户端时要使用的 MockRestServiceServer。但是，在运行测试时，我收到一个 IllegalStateException，说 MockServerRestTemplateCustomizer 尚未绑定到 RestTemplate。

值得注意的是，我使用Gson进行反序列化，而不是Jackson，因此被排除在外。

有谁知道如何正确使用此新注释？我还没有找到任何需要更多配置的例子，而我已经这样做了。

配置：

@SpringBootConfiguration
@ComponentScan
@EnableAutoConfiguration(exclude = {JacksonAutoConfiguration.class})
public class ClientConfiguration {

...

   @Bean
   public RestTemplateBuilder restTemplateBuilder() {
       return new RestTemplateBuilder()
            .rootUri(rootUri)
            .basicAuthorization(username, password);
   }
}

客户：

@Service
public class ComponentsClientImpl implements ComponentsClient {

    private RestTemplate restTemplate;

    @Autowired
    public ComponentsClientImpl(RestTemplateBuilder builder) {
        this.restTemplate = builder.build();
    }

    public ResponseDTO getComponentDetails(RequestDTO requestDTO) {
        HttpEntity<RequestDTO> entity = new HttpEntity<>(requestDTO);
        ResponseEntity<ResponseDTO> response = 
              restTemplate.postForEntity("/api", entity, ResponseDTO.class);
        return response.getBody();
    }
}

测试

@RunWith(SpringRunner.class)
@RestClientTest(ComponentsClientImpl.class)
public class ComponentsClientTest {

    @Autowired
    private ComponentsClient client;

    @Autowired
    private MockRestServiceServer server;

    @Test
    public void getComponentDetailsWhenResultIsSuccessShouldReturnComponentDetails() throws Exception {
        server.expect(requestTo("/api"))
            .andRespond(withSuccess(getResponseJson(), APPLICATION_JSON));

        ResponseDTO response = client.getComponentDetails(requestDto);
        ResponseDTO expected = responseFromJson(getResponseJson());

        assertThat(response, is(expectedResponse));
    }
}

例外：

java.lang.IllegalStateException: Unable to use auto-configured MockRestServiceServer since MockServerRestTemplateCustomizer has not been bound to a RestTemplate

答：

根据下面的答案，没有必要将 RestTemplateBuilder bean 声明到上下文中，因为它已经由 spring-boot 自动配置提供。

如果项目是一个弹簧启动应用程序（它有@SpringBootApplication注释），这将按预期工作。然而，在上述情况下，该项目是一个客户端库，因此没有主要应用程序。

为了确保在主应用程序上下文中正确注入 RestTemplateBuilder（Bean 已被删除），组件扫描需要一个 CUSTOM 过滤器（@SpringBootApplication使用的过滤器）

@ComponentScan(excludeFilters = {
        @ComponentScan.Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class)
})

答案 1

应使用从静态工厂构造实例。有关测试过程的详细说明，请参阅此文章。MockRestServiceServerRestTemplate

在您的示例中，您可以执行以下操作：

@RunWith(SpringRunner.class)
@RestClientTest(ComponentsClientImpl.class)
public class ComponentsClientTest {

    @Autowired
    private ComponentsClient client;

    @Autowired
    private RestTemplate template;

    private MockRestServiceServer server;

    @Before
    public void setUp() {
        server= MockRestServiceServer.createServer(restTemplate);
    }

    /*Do your test*/
}

答案 2

你在两个地方有RestTemplateBuilder。在 ClientConfiguration 类和 ComponentsClientImpl 类。Spring boot 1.4.0 自动配置 RestTemplateBuilder，该生成器可用于在需要时创建 RestTemplate 实例。从客户端配置类中删除以下代码并运行测试。

 @Bean
 public RestTemplateBuilder restTemplateBuilder() {
   return new RestTemplateBuilder()
        .rootUri(rootUri)
        .basicAuthorization(username, password);
  }