解决RestTemplate 请求接收自定义400+ 或500+错误

目录

• RestTemplate 请求接收自定义400+ 或500+错误
• 场景
• 原因
• 解决办法
• 自定义RestTemplate的ResponseErrorHandler
• Spring框架中的RestTemplate处理ClientHttpResponse的方式
• 并不想让它抛异常
• 无法使用IOC注入的场景下

RestTemplate 请求接收自定义400+ 或500+错误

场景

当服务端自定义400错误返回体时，使用restTemplate 请求接收不到消息体。而我正想根据不同的错误信息做不同的操作。

原因

restTemplate 内置了自己的处理异常的方法ResponseErrorHandler去处理异常

protected void handleResponse(URI url, HttpMethod method, ClientHttpResponse response) throws IOException {
  ResponseErrorHandler errorHandler = getErrorHandler();
  boolean hasError = errorHandler.hasError(response);
  if (logger.isDebugEnabled()) {
   try {
    logger.debug(method.name() + " request for \"" + url + "\" resulted in " +
      response.getRawStatusCode() + " (" + response.getStatusText() + ")" +
      (hasError ? "; invoking error handler" : ""));
   }
   catch (IOException ex) {
    // ignore
   }
  }
  if (hasError) {
   errorHandler.handleError(response);
  }
 }

当接收到CLIENT_ERROR 或 SERVER_ERROR 时，直接抛异常

@Override
 public void handleError(ClientHttpResponse response) throws IOException {
  HttpStatus statusCode = getHttpStatusCode(response);
  switch (statusCode.series()) {
   case CLIENT_ERROR:
    throw new HttpClientErrorException(statusCode, response.getStatusText(),
      response.getHeaders(), getResponseBody(response), getCharset(response));
   case SERVER_ERROR:
    throw new HttpServerErrorException(statusCode, response.getStatusText(),
      response.getHeaders(), getResponseBody(response), getCharset(response));
   default:
    throw new RestClientException("Unknown status code [" + statusCode + "]");
  }
 }

解决办法

自定义异常处理器，对响应的错误信息不进行处理

public class FacePlusThrowErrorHandler implements ResponseErrorHandler {
    @Override
    public boolean hasError(ClientHttpResponse response) throws IOException {
        return false;
    }
    @Override
    public void handleError(ClientHttpResponse response) throws IOException {
    }
}

之后在bean 注入时，设置restTemplate 默认异常处理器为我们自定义的

 @Bean
    public RestTemplate facePlusRestTemplate() {
        HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory();
        requestFactory.setConnectTimeout(300000);
        requestFactory.setReadTimeout(300000);
        RestTemplate restTemplate = new RestTemplate(requestFactory);
        restTemplate.getMessageConverters().set(1, new StringHttpMessageConverter(StandardCharsets.UTF_8));
        restTemplate.getMessageConverters().add(new FormHttpMessageConverter());
        restTemplate.setErrorHandler(new FacePlusThrowErrorHandler());
        return restTemplate;
    }

然后当我们使用restTemplate 时，设置restTemplate bean 名为注入时起的名字

@Resource(name = "facePlusRestTemplate")
private RestTemplate restTemplate;

最后从返回的ResponseEntity 中取body 属性，就可以取得服务端返回的消息体了

自定义RestTemplate的ResponseErrorHandler

Spring框架中的RestTemplate处理ClientHttpResponse的方式

直接看RestTemplate的源码

这里主要判断了是ClientError还是ServerError，即4xx或者是5xx。

如若是这两类状态码，会执行handleError()抛出异常

并不想让它抛异常

在一些业务场景下，或许我们并不想让它抛异常（即便我们可以捕获异常，额外做处理），那么就需要我们ResponseErrorHandler，并且重新定义一个RestTemplate对象使用该ErrorHandler。（简单实现如下）

@Configuration
public class CustomResponseErrorHandler implements ResponseErrorHandler {
    @Override
    public boolean hasError(ClientHttpResponse clientHttpResponse) throws IOException {
        return false;
    }
    @Override
    public void handleError(ClientHttpResponse clientHttpResponse) throws IOException {
    }
    @Bean("customRestTemplate")
    public RestTemplate customRestTemplate() {
        HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory();
        requestFactory.setConnectTimeout(300000);
        requestFactory.setReadTimeout(300000);
        RestTemplate restTemplate = new RestTemplate(requestFactory);
        restTemplate.getMessageConverters().set(1, new StringHttpMessageConverter(StandardCharsets.UTF_8));
        restTemplate.getMessageConverters().add(new FormHttpMessageConverter());
        restTemplate.setErrorHandler(new CustomResponseErrorHandler());
        return restTemplate;
    }
}

还需要加入一个maven依赖（具体原因查看maven依赖图）

<!-- https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient -->
<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.5</version>
</dependency>

在spring 中以IOC方式注入

@Resource(name = "customRestTemplate")
private RestTemplate restTemplate;

到这里已经可以正常使用。

无法使用IOC注入的场景下

还是参照CustomResponseErrorHandler中的customRestTemplate()去new对象吧……

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。