SpringWeb 系列教程 RestTemplate 4xx/5xx 异常信息捕获

简介: 近期使用 RestTemplate 访问外部资源时,发现一个有意思的问题。因为权限校验失败,对方返回的 401 的 http code,此外返回数据中也会包含一些异常提示信息;然而在使用 RestTemplate 访问时,却是直接抛了如下提示 401 的异常,并不能拿到提示信息

image.png


近期使用 RestTemplate 访问外部资源时,发现一个有意思的问题。因为权限校验失败,对方返回的 401 的 http code,此外返回数据中也会包含一些异常提示信息;然而在使用 RestTemplate 访问时,却是直接抛了如下提示 401 的异常,并不能拿到提示信息


image.png


那么 RestTemplate 如果希望可以获取到非 200 状态码返回数据时,可以怎么操作呢?


I. 异常捕获



1. 问题分析


RestTemplate 的异常处理,是借助org.springframework.web.client.ResponseErrorHandler来做的,先看一下两个核心方法


  • 下面代码来自 spring-web.5.0.7.RELEASE 版本
public interface ResponseErrorHandler {
  // 判断是否有异常
  boolean hasError(ClientHttpResponse response) throws IOException;
  // 如果有问题,进入这个方法,处理问题
  void handleError(ClientHttpResponse response) throws IOException;
}
复制代码


简单来讲,当 RestTemplate 发出请求,获取到对方相应之后,会交给ResponseErrorHandler来判断一下,返回结果是否 ok


因此接下来将目标瞄准到 RestTemplate 默认的异常处理器:

org.springframework.web.client.DefaultResponseErrorHandler


a. 判定返回结果是否 ok


从源码上看,主要是根据返回的 http code 来判断是否 ok

// 根据返回的http code判断有没有问题
@Override
public boolean hasError(ClientHttpResponse response) throws IOException {
  HttpStatus statusCode = HttpStatus.resolve(response.getRawStatusCode());
  return (statusCode != null && hasError(statusCode));
}
// 具体的判定逻辑,简单来讲,就是返回的http code是标准的4xx, 5xx,那么就认为有问题了
protected boolean hasError(HttpStatus statusCode) {
  return (statusCode.series() == HttpStatus.Series.CLIENT_ERROR ||
      statusCode.series() == HttpStatus.Series.SERVER_ERROR);
}
复制代码


请注意上面的实现,自定义的某些 http code 是不会被认为是异常的,因为无法转换为对应的HttpStatus (后面实例进行说明)


b. 异常处理


当上面的 hasError 返回 ture 的时候,就会进入异常处理逻辑

@Override
public void handleError(ClientHttpResponse response) throws IOException {
  HttpStatus statusCode = HttpStatus.resolve(response.getRawStatusCode());
  if (statusCode == null) {
    throw new UnknownHttpStatusCodeException(response.getRawStatusCode(), response.getStatusText(),
        response.getHeaders(), getResponseBody(response), getCharset(response));
  }
  handleError(response, statusCode);
}
protected void handleError(ClientHttpResponse response, HttpStatus statusCode) throws IOException {
  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 UnknownHttpStatusCodeException(statusCode.value(), response.getStatusText(),
          response.getHeaders(), getResponseBody(response), getCharset(response));
  }
}
复制代码


从上面也可以看到,异常处理逻辑很简单,直接抛异常


2. 异常捕获


定位到生面的问题之后,再想解决问题就相对简单了,自定义一个异常处理类,不管状态码返回是啥,全都认为正常即可


RestTemplate restTemplate = new RestTemplate();
restTemplate.setErrorHandler(new DefaultResponseErrorHandler(){
    @Override
    protected boolean hasError(HttpStatus statusCode) {
        return super.hasError(statusCode);
    }
    @Override
    public void handleError(ClientHttpResponse response) throws IOException {
    }
});
复制代码


3. 实测


首先写两个结果,返回的 http 状态码非 200;针对返回非 200 状态码的 case,有多种写法,下面演示两种常见的


@RestController
public class HelloRest {
  @GetMapping("401")
  public ResponseEntity<String> _401(HttpServletResponse response) {
      ResponseEntity<String> ans =
              new ResponseEntity<>("{\"code\": 401, \"msg\": \"some error!\"}", HttpStatus.UNAUTHORIZED);
      return ans;
  }
  @GetMapping("525")
  public String _525(HttpServletResponse response) {
      response.setStatus(525);
      return "{\"code\": 525, \"msg\": \"自定义错误码!\"}";
  }
}
复制代码


首先来看一下自定义的 525 和标准的 401 http code,直接通过RestTemplate访问的 case


@Test
public void testCode() {
    RestTemplate restTemplate = new RestTemplate();
    HttpEntity<String> ans = restTemplate.getForEntity("http://127.0.0.1:8080/525", String.class);
    System.out.println(ans);
    ans = restTemplate.getForEntity("http://127.0.0.1:8080/401", String.class);
    System.out.println(ans);
}
复制代码

image.png


从上面的输出结果也可以看出来,非标准 http code 不会抛异常(原因上面有分析),接下来看一下即便是标准的 http code 也不希望抛异常的 case


@Test
public void testSend() {
    String url = "http://127.0.0.1:8080/401";
    RestTemplate restTemplate = new RestTemplate();
    restTemplate.setErrorHandler(new DefaultResponseErrorHandler(){
        @Override
        protected boolean hasError(HttpStatus statusCode) {
            return super.hasError(statusCode);
        }
        @Override
        public void handleError(ClientHttpResponse response) throws IOException {
        }
    });
    HttpEntity<String> ans = restTemplate.getForEntity(url, String.class);
    System.out.println(ans);
}
复制代码

image.png


相关文章
|
5月前
|
前端开发 算法 Java
JavaEE开发重中之重 异常 捕获并抛出异常 自定义异常 2024详解
JavaEE开发重中之重 异常 捕获并抛出异常 自定义异常 2024详解
27 1
|
6月前
|
前端开发 小程序
异常处理器与拦截器 深入探究 --拦截器状态码无法被识别
异常处理器与拦截器 深入探究 --拦截器状态码无法被识别
|
程序员 PHP
PHP快速入门12-异常处理,自定义异常、抛出异常、断言异常等示例
PHP的异常处理机制可以帮助我们在程序运行时遇到错误或异常情况时,及时发出警告并停止程序继续运行。下面是10个例子,分别展示了PHP异常处理的不同用法。
220 0
|
6月前
|
前端开发
Nestjs(五)异常处理方式(异常过滤器)
Nestjs(五)异常处理方式(异常过滤器)
127 0
|
11月前
|
JSON 前端开发 Java
SpringMVC中异常处理与ControllerAdvice捕捉全局异常
SpringMVC中异常处理与ControllerAdvice捕捉全局异常
91 0
|
数据采集 数据安全/隐私保护
如何使用异常处理机制捕获和处理请求失败的情况
在爬虫开发中,我们经常会遇到请求失败的情况,比如网络超时、连接错误、服务器拒绝等。这些情况会导致我们无法获取目标网页的内容,从而影响爬虫的效果和效率。为了解决这个问题,我们需要使用异常处理机制来捕获和处理请求失败的情况,从而提高爬虫的稳定性和稳定性。
121 0
如何使用异常处理机制捕获和处理请求失败的情况
|
安全 Java 微服务
SpringBoot 中如何优雅地处理异常,包括异常处理机制、全局异常处理器、自定义异常?
SpringBoot 中如何优雅地处理异常,包括异常处理机制、全局异常处理器、自定义异常?
306 0
|
Java
SpringBoot异常统一处理,包括系统异常、自定义异常和参数检验异常
SpringBoot异常统一处理,包括系统异常、自定义异常和参数检验异常
382 0
|
C++
解析一下C++的异常处理
解析一下C++的异常处理
120 0
解析一下C++的异常处理
有关异常的处理、捕获、抛出、自定义
有关异常的处理、捕获、抛出、自定义
104 0