spring学习之restTemplate的异常处理器

旧城等待， 2022-01-25 17:43 899阅读 0赞

### restTemplate学习 ###

*  ResponseErrorHandler
 *  DefaultResponseErrorHandler
 *  ExtractingResponseErrorHandler
 *  NoOpResponseErrorHandler
 *  自定义异常处理器

<table> 
 <thead> 
  <tr> 
   <th align="left">异常处理器</th> 
   <th align="left">功能</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">ResponseErrorHandler</td> 
   <td align="left">异常处理器接口</td> 
  </tr> 
  <tr> 
   <td align="left">DefaultResponseErrorHandler</td> 
   <td align="left">restTemplate默认的异常处理器，处理客户端和服务端异常</td> 
  </tr> 
  <tr> 
   <td align="left">ExtractingResponseErrorHandler</td> 
   <td align="left">根据HttpMessageConverter对象转换器 将HTTP错误响应转换RestClientException 需要指定ResponseErrorHandler</td> 
  </tr> 
  <tr> 
   <td align="left">NoOpResponseErrorHandler</td> 
   <td align="left">对异常不进行处理</td> 
  </tr> 
 </tbody> 
</table>

# ResponseErrorHandler #

> ResponseErrorHandler是restTemplate的异常接口  
> restTemplate中所有的异常处理器都是实现的它

public interface ResponseErrorHandler { 
    
    	/** * 判断请求是否异常 * 返回false表示不管response的status是多少都返回没有错 * 这里可以自己定义那些status code你认为是可以抛Error * 当然也可以根据response的body来判断 */
    	boolean hasError(ClientHttpResponse response) throws IOException;
    
    	/** * 这里面可以实现你自己遇到了Error进行合理的处理 */
    	void handleError(ClientHttpResponse response) throws IOException;
    
    	/** * 默认的异常处理器 * 这里最终调用的还是上面的方法 * 当然可以重写这个方法 */
    	default void handleError(URI url, HttpMethod method, ClientHttpResponse response) throws IOException { 
    		handleError(response);
    	}
    
    }

# DefaultResponseErrorHandler #

> DefaultResponseErrorHandler实现的ResponseErrorHandler  
> 它是restTemplate的默认异常处理器

1.  `hasError`方法—判断是否为异常  
    ![在这里插入图片描述][20190529165452219.png]  
    进入`isError`里可以看到restTemplate默认判断400一类（客户端）和500一类（服务端）为异常  
    ![在这里插入图片描述][20190529165415869.png]
2.  `handleError`—对客户端和服务端错误抛出异常  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1lDSl94aXlhbmc_size_16_color_FFFFFF_t_70]

--------------------

restTemplate是怎么调用的DefaultResponseErrorHandler

> 以下类容都是在RestTemplate类中

1.  restTemplate发送请求之后，调用handleResponse()方法  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1lDSl94aXlhbmc_size_16_color_FFFFFF_t_70 1]
2.  进入handleResponse()方法，调用的`getErrorHandler()`  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1lDSl94aXlhbmc_size_16_color_FFFFFF_t_70 2]
3.  进入`getErrorHandler()`–调用的本类的`errorHandler`  
    ![在这里插入图片描述][20190529170827148.png]
4.  再查看这个参数发现，restTemplate一开始建立后就是直接new 的一个DefaultResponseErrorHandler  
    ![在这里插入图片描述][20190529170922399.png]
5.  扩展  
    由此可以明确的知道restTemplate是怎么使用的DefaultResponseErrorHandler  
    那么我们怎么把自定义异常处理器的设置为默认的异常处理器呢？  
    在RestTemplate中有一个异常处理器的setter方法，可以设置  
    ![在这里插入图片描述][20190529172019209.png]  
    如果你使用的是`RestTemplateBuilder`构建的restTemplate，在RestTemplateBuilder中有一个`errorHandler`可以设置  
    ![在这里插入图片描述][2019052917243233.png]

# ExtractingResponseErrorHandler #

![在这里插入图片描述][20190529180335420.png]

# NoOpResponseErrorHandler #

> 顾名思义：不进行处理  
> 实现类在RestTemplate中

![在这里插入图片描述][20190529173448530.png]  
如何应用  
当使用指定的凭据新建@link testresttemplate实例时，默认设置为这个处理器  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1lDSl94aXlhbmc_size_16_color_FFFFFF_t_70 3]

# 自定义异常处理器 #

public class CustomErrorHandler implements ResponseErrorHandler {
    
        private static final Logger LOGGER = LoggerFactory.getLogger(CustomErrorHandler.class);
    
        /**
         * 返回false表示不管response的status是多少都返回没有错
         * 这里可以自己定义那些status code你认为是可以抛Error
         * Indicate whether the given response has any errors.
         * <p>Implementations will typically inspect the
         * {@link ClientHttpResponse#getStatusCode() HttpStatus} of the response.
         *
         * @param response the response to inspect
         * @return {@code true} if the response indicates an error; {@code false} otherwise
         * @throws IOException in case of I/O errors
         */
        @Override
        public boolean hasError(ClientHttpResponse response) throws IOException {
            return response.getStatusCode().value() != 200 && response.getStatusCode().value() !=302;
        }
    
        /**
         * 这里面可以实现你自己遇到了Error进行合理的处理
         * Handle the error in the given response.
         * <p>This method is only called when {@link #hasError(ClientHttpResponse)}
         * has returned {@code true}.
         *
         * @param response the response with the error
         * @throws IOException in case of I/O errors
         */
        @Override
        public void handleError(ClientHttpResponse response) throws IOException {
    
        }
    
        /**
         * 替代上面的方法
         * Alternative to {@link #handleError(ClientHttpResponse)} with extra
         * information providing access to the request URL and HTTP method.
         *
         * @param url      the request URL
         * @param method   the HTTP method
         * @param response the response with the error
         * @throws IOException in case of I/O errors
         * @since 5.0
         */
        @Override
        public void handleError(URI url, HttpMethod method, ClientHttpResponse response) throws IOException {
            LOGGER.error("=======================ERROR============================");
            LOGGER.error("DateTime：{}", DateUtil.generateTimeFormatter(response.getHeaders().getDate(),"yyyy-MM-dd HH:mm:ss"));
            LOGGER.error("HOST:{},URI：{}", url.getHost(),url.getPath());
            LOGGER.error("Method：{}", method.name());
            LOGGER.error("Exception：{}", response.getStatusCode());
            LOGGER.error("========================================================");
        }
    }

![在这里插入图片描述][20190529180943301.png]  
[ 自定义异常例子源码地址][Link 1]

[20190529165452219.png]: /images/20220126/5ae844c3f89e413db3a3501a4083c6f8.png
[20190529165415869.png]: /images/20220126/36ed2b4047714a27870f518d41e0fe6e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1lDSl94aXlhbmc_size_16_color_FFFFFF_t_70]: /images/20220126/1582575451fd4ba09a24e78bdf464cf1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1lDSl94aXlhbmc_size_16_color_FFFFFF_t_70 1]: /images/20220126/10581e837a2b463183782169bad2a570.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1lDSl94aXlhbmc_size_16_color_FFFFFF_t_70 2]: /images/20220126/69c83ccb906648af97e7e703f5a3bf0b.png
[20190529170827148.png]: /images/20220126/adfb1e10bbe44944bdbe0e3d47117d47.png
[20190529170922399.png]: /images/20220126/bfa545ea2c2c4fffb9e5f4364fa9dfd1.png
[20190529172019209.png]: /images/20220126/2ebd4a730bef498db1946708f4685bf5.png
[2019052917243233.png]: /images/20220126/e3b1230f5c0149f8bd706c709bc37e5a.png
[20190529180335420.png]: /images/20220126/9d035e06b4fb40dd83916aa57353af0c.png
[20190529173448530.png]: /images/20220126/f7f6d76730ec4842a4c2bd8fe2d51718.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1lDSl94aXlhbmc_size_16_color_FFFFFF_t_70 3]: /images/20220126/adfe336652084e509721fc408158d7b2.png
[20190529180943301.png]: /images/20220126/7505f9b2b7df4b629e897e02c19f2ea7.png
[Link 1]: https://m.gitee.com/xiyang_ycj/spring-restTemplate#0-sqq-1-50307-9737f6f9e09dfaf5d3fd14d775bfee85