Spring RestTemplate 错误处理：优雅处理远程 API HTTP 错误

2023-09-15 16:04:54

前言

Spring RestTemplate 是一个广泛使用的 Java 库，用于简化与远程 HTTP API 的交互。然而，在实际应用中，我们经常会遇到各种 HTTP 错误，例如 404 未找到、401 未经授权、500 内部服务器错误等。这些错误可能会导致应用程序崩溃或返回不友好的错误信息，影响用户体验。因此，正确处理 RestTemplate 中的错误至关重要。

认识 ResponseErrorHandler 接口

Spring 提供了 ResponseErrorHandler 接口，允许我们自定义 RestTemplate 的错误处理行为。通过实现此接口，我们可以灵活地处理不同的 HTTP 错误代码，并返回更友好的错误信息或采取相应的补救措施。

实现 ResponseErrorHandler 接口

为了实现 ResponseErrorHandler 接口，我们需要创建一个类并覆盖 handleError 方法。该方法接收两个参数：ClientHttpResponse 和 HttpHeaders。ClientHttpResponse 对象包含有关 HTTP 响应的详细信息，例如状态代码、响应头和响应正文。HttpHeaders 对象包含 HTTP 请求的标头信息。

public class CustomResponseErrorHandler implements ResponseErrorHandler {

    @Override
    public boolean hasError(ClientHttpResponse response) throws IOException {
        return response.getRawStatusCode() >= 400;
    }

    @Override
    public void handleError(ClientHttpResponse response, HttpHeaders headers) throws IOException {
        int statusCode = response.getRawStatusCode();
        String statusText = response.getStatusText();
        String body = IOUtils.toString(response.getBody(), StandardCharsets.UTF_8);

        // 根据不同的状态码，进行相应的处理
        switch (statusCode) {
            case 404:
                // 处理 404 Not Found 错误
                break;
            case 401:
                // 处理 401 Unauthorized 错误
                break;
            case 500:
                // 处理 500 Internal Server Error 错误
                break;
            default:
                // 处理其他错误
        }
    }
}

注入 ResponseErrorHandler

实现 ResponseErrorHandler 接口后，我们需要将其注入到 RestTemplate 实例中。可以通过在 RestTemplate Bean 的配置中指定 ResponseErrorHandler Bean 来实现。

@Bean
public RestTemplate restTemplate(CustomResponseErrorHandler errorHandler) {
    RestTemplate restTemplate = new RestTemplate();
    restTemplate.setErrorHandler(errorHandler);
    return restTemplate;
}