Spring Resttemplate 异常处理

Spring 把你从一个非常非常庞大的 HTTP状态码列表中抽象出来。这就是例外的概念。查看 org.springframework.web.client。RestClientException 层次结构:

在处理 http 响应时，有许多类可以映射最常见的情况。Http 代码列表非常大，您不会希望编写代码来处理每种情况。但是，例如，查看 HttpClientErrorException 子层次结构。只有一个异常可以映射任何4xx 类型的错误。如果你想深入调查，你可以的。但是只要捕获 HttpClientErrorException，就可以处理向服务提供错误数据的任何情况。

DefaultResponseErrorHandler 非常简单可靠。如果响应状态代码不是来自2xx 系列，那么对于 hasError 方法，它只返回 true。

我的处理方式如下:

try {
response = restTemplate.postForEntity(requestUrl, new HttpEntity<>(requestBody, headers), String.class);
} catch (HttpStatusCodeException ex) {
response = new ResponseEntity<String>(ex.getResponseBodyAsString(), ex.getResponseHeaders(), ex.getStatusCode());
}

一个非常简单的解决方案可以是:

try {
requestEntity = RequestEntity
.get(new URI("user String"));
    

return restTemplate.exchange(requestEntity, String.class);
} catch (RestClientResponseException e) {
return ResponseEntity.status(e.getRawStatusCode()).body(e.getResponseBodyAsString());
}

我通过重写 DefaultResponseErrorHandler 类中的 hasError 方法修复了这个问题:

public class BadRequestSafeRestTemplateErrorHandler extends DefaultResponseErrorHandler
{
@Override
protected boolean hasError(HttpStatus statusCode)
{
if(statusCode == HttpStatus.BAD_REQUEST)
{
return false;
}
return statusCode.isError();
}
}

并且您需要为 restemplate bean 设置这个处理程序:

@Bean
protected RestTemplate restTemplate(RestTemplateBuilder builder)
{
return builder.errorHandler(new BadRequestSafeRestTemplateErrorHandler()).build();
}

把“车牌号”扩大一点回答... 。

考虑到您的响应错误是由 json 消息返回的。例如，API 可以将 204作为状态代码错误返回，将 json 消息作为错误列表返回。在这种情况下，您需要定义应该弹出哪些消息作为错误以及如何使用它们。

作为一个示例，如果出现错误，API 可能会返回类似下面这样的内容:

 { "errorCode":"TSC100" , "errorMessage":"The foo bar error happend" , "requestTime" : "202112827733" .... }

要使用 json 并抛出自定义异常，可以执行以下操作:

首先定义一个用于映射错误对象的类

//just to map the json to object
public class ServiceErrorResponse implements Serializable {


//setter and getters
private Object errorMessage;
private String errorCode;
private String requestTime;
   

}

现在定义错误处理程序:

public class ServiceResponseErrorHandler implements ResponseErrorHandler {


private List<HttpMessageConverter<?>> messageConverters;


@Override
public boolean hasError(ClientHttpResponse response) throws IOException {
        

return (response.getStatusCode().is4xxClientError() ||
response.getStatusCode().is5xxServerError());
}


@Override
public void handleError(ClientHttpResponse response) throws IOException {
        

@SuppressWarnings({ "unchecked", "rawtypes" })
HttpMessageConverterExtractor<ServiceErrorResponse> errorMessageExtractor =
new HttpMessageConverterExtractor(ServiceErrorResponse.class, messageConverters);
        

ServiceErrorResponse errorObject = errorMessageExtractor.extractData(response);
        

throw new ResponseEntityErrorException(
ResponseEntity.status(response.getRawStatusCode())
.headers(response.getHeaders())
.body(errorObject)
);
        

}


public void setMessageConverters(List<HttpMessageConverter<?>> messageConverters) {
this.messageConverters = messageConverters;
}
}

自定义的例外将是:

public class ResponseEntityErrorException extends RuntimeException  {
    

private ResponseEntity<ServiceErrorResponse> serviceErrorResponseResponse;


public ResponseEntityErrorException(ResponseEntity<ServiceErrorResponse> serviceErrorResponseResponse) {
this.serviceErrorResponseResponse = serviceErrorResponseResponse;
}
    

public ResponseEntity<ServiceErrorResponse> getServiceErrorResponseResponse() {
return serviceErrorResponseResponse;
}
}

使用方法:

RestTemplateResponseErrorHandler errorHandler = new
RestTemplateResponseErrorHandler();
//pass the messageConverters to errror handler and let it convert json to object
errorHandler.setMessageConverters(restTemplate.getMessageConverters());
restTemplate.setErrorHandler(errorHandler);

尝试使用 @ControllerAdvice。这使您只能处理一次异常，并在一个地方处理所有“自定义”处理的异常。

Https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/controlleradvice.html

例子

@ControllerAdvice
public class MyExceptionHandler extends ResponseEntityExceptionHandler{


@ExceptionHandler(MyException.class)
protected ResponseEntity<Object> handleMyException(){
MyException exception,
WebRequest webRequest) {
return handleExceptionInternal(
exception,
exception.getMessage(),
exception.getResponseHeaders(),
exception.getStatusCode(),
webRequest);
}

阅读全局异常处理程序中的全局异常处理。添加以下方法。这将工作。

@ExceptionHandler( {HttpClientErrorException.class, HttpStatusCodeException.class, HttpServerErrorException.class})
@ResponseBody
public ResponseEntity<Object> httpClientErrorException(HttpStatusCodeException e) throws IOException {
BodyBuilder bodyBuilder = ResponseEntity.status(e.getRawStatusCode()).header("X-Backend-Status", String.valueOf(e.getRawStatusCode()));
if (e.getResponseHeaders().getContentType() != null) {
bodyBuilder.contentType(e.getResponseHeaders().getContentType());
}
return bodyBuilder.body(e.getResponseBodyAsString());
}

这是如何处理休息模板中的异常

        try {
return restTemplate.exchange("URL", HttpMethod.POST, entity, String.class);
}
catch (HttpStatusCodeException e)
{
return ResponseEntity.status(e.getRawStatusCode()).headers(e.getResponseHeaders())
.body(e.getResponseBodyAsString());
}

还有一个使用 TestRestTemplate的选项。它对于集成和 E2E 测试非常有用，当您需要手动验证所有状态代码时(例如在负面测试用例中)。

TestRestTemplate 是容错的。这意味着4xx 和5xx 不会导致抛出异常，而是可以通过响应实体及其状态代码检测到异常。