springboot中RestTemplate远程调用：设置连接超时、自定义异常处理

已于 2024-01-19 14:08:54 修改
阅读量2.6k 收藏 24
点赞数 18
分类专栏： SpringBoot|Web后端|Web前端 文章标签： java spring 开发语言
于 2023-06-27 16:45:01 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43542296/article/details/131419219
版权

目录

设置连接超时

调用示例--get请求

调用示例--post请求（接口使用@RequestParam注解即以表单方式提交）

调用示例--post请求（接口使用@RequestBody注解即以json方式提交）

自定义异常处理

1、异常现象

2、源码解析-默认实现

2.1、从HttpResponse解析出Http StatusCode，如果状态码StatusCode为null，就抛出UnknownHttpStatusCodeException异常。

2.2、如果StatusCode存在，则解析出StatusCode的series，也就是状态码段（除了2xx段，其他全是异常状态码）,解析规则是StatusCode/100取整。

2.3、进一步针对客户端异常和服务端异常进行处理，处理的方法是抛出HttpClientErrorException。也就是第一小节截图中出现的异常的原因，下面三个异常都是RestClientException的子类

3、RestTemplate自定义异常处理

参考文章

设置连接超时

SimpleClientHttpRequestFactory.class中默认无限制

private int connectTimeout = -1;

private int readTimeout = -1;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.client.SimpleClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;

@Configuration
public class RestTemplateConfig {
  @Bean
  public RestTemplate restTemplate(ClientHttpRequestFactory factory) {
    RestTemplate restTemplate = new RestTemplate(factory);
    return restTemplate;
  }

  @Bean
  public ClientHttpRequestFactory simpleClientHttpRequestFactory() {
    SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
    factory.setReadTimeout(5000);
    factory.setConnectTimeout(10000);
    return factory;
  }
}

调用示例--get请求

@Autowired
private RestTemplate restTemplate;
Map paramMap = new HashMap<String, String>(1);
paramMap.put("userId", "system");
try {
ResponseEntity<JSONArray> forEntity = restTemplate.getForEntity("http://192.168.3.213:32410/queryUserRoles?userId={userId}", JSONArray.class, paramMap);
JSONArray routeDTOs = forEntity.getBody();
System.out.println("========================="+routeDTOs.toJSONString());
} catch (RestClientException e) {
  //RestClientException是HttpClientErrorException、HttpServerErrorException等的父类
  e.printStackTrace();
}

调用示例--post请求（接口使用@RequestParam注解即以表单方式提交）

调用示例--post请求（接口使用@RequestBody注解即以json方式提交）

//发送Post数据并解析数据
String casServiceUrl = casClientProperties.getCasServiceUrl();
String url = casServiceUrl + "/addClient";
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> request = new HttpEntity<String>(serviceInfo.toJSONString(), headers);
try {
  ResponseEntity<JSONObject> responseEntity = restTemplate.postForEntity(url, request, JSONObject.class);
  JSONObject body = responseEntity.getBody();
  if (!body.isEmpty() && body.getInteger("code") != null) {
    int code = body.getInteger("code").intValue();
    if (code == 200) {
      log.info("CAS client added successfully, serviceInfo:\n{}",serviceInfo.toJSONString());   
    } else if (code == 201) {
      ......
    }

自定义异常处理

1、异常现象

在使用RestTemplate进行远程接口服务调用的时候，当请求的服务出现异常：超时、服务不存在等情况的时候（响应状态非200、而是400、500等HTTP状态码），就会抛出如下异常：

2、源码解析-默认实现

RestTemplate请求结果异常是可以自定义处理的。在开始进行自定义的异常处理逻辑之前，我们有必要看一下异常处理的默认实现。

ResponseErrorHandler是RestTemplate请求结果的异常处理器接口
接口的第一个方法hasError用于判断HttpResponse是否是异常响应（通过状态码）
接口的第二个方法handleError用于处理异常响应结果（非2xx状态码段）
DefaultResponseErrorHandler是ResponseErrorHandler的默认实现，所以我们就来看看DefaultResponseErrorHandler是如何来处理异常响应的？

2.1、从HttpResponse解析出Http StatusCode，如果状态码StatusCode为null，就抛出UnknownHttpStatusCodeException异常。

2.2、如果StatusCode存在，则解析出StatusCode的series，也就是状态码段（除了2xx段，其他全是异常状态码）,解析规则是StatusCode/100取整。

public enum Series {

   INFORMATIONAL(1),  // 1xx/100
   SUCCESSFUL(2),  // 2xx/100
   REDIRECTION(3), // 3xx/100
   CLIENT_ERROR(4), // 4xx/100   ,客户端异常
   SERVER_ERROR(5); // 5xx/100 ，服务端异常

   ......
   ............
}

2.3、进一步针对客户端异常和服务端异常进行处理，处理的方法是抛出HttpClientErrorException。也就是第一小节截图中出现的异常的原因，下面三个异常都是RestClientException的子类

3、RestTemplate自定义异常处理

所以我们要实现自定义异常，实现ResponseErrorHandler接口 [仿照DefaultResponseErrorHandler实现]就可以。

import com.genertech.plm.aia.login.cas.customerAuthentication.exception.MyFailedLoginException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.util.FileCopyUtils;
import org.springframework.web.client.HttpClientErrorException;
import org.springframework.web.client.HttpServerErrorException;
import org.springframework.web.client.ResponseErrorHandler;
import org.springframework.web.client.UnknownHttpStatusCodeException;

import java.io.IOException;
import java.nio.charset.Charset;

/**
 * @author: huo.qw
 * @createTime: 2023/06/27 下午 07:27
 * @description: 自定义RestTemplate抛出的异常为CAS的异常，
 * 解决RestTemplate抛出的异常提前被CAS源码PolicyBasedAuthenticationManager捕获的问题
 * @version: v1.0
 */
@Slf4j
public class CustomerRestTemplateResponseErrorHandler implements ResponseErrorHandler {
  public CustomerRestTemplateResponseErrorHandler() {
  }

  /**
   * 判断返回结果response是否是异常结果
   * 主要是去检查response 的HTTP Status
   * [仿照DefaultResponseErrorHandler实现即可]
   */
  public boolean hasError(ClientHttpResponse response) throws IOException {
    int rawStatusCode = response.getRawStatusCode();
    // 模拟失败
    //rawStatusCode = 400;
    HttpStatus[] var3 = HttpStatus.values();
    int var4 = var3.length;

    for (int var5 = 0; var5 < var4; ++var5) {
      HttpStatus statusCode = var3[var5];
      if (statusCode.value() == rawStatusCode) {
        return this.hasError(statusCode);
      }
    }

    return this.hasError(rawStatusCode);
  }

  protected boolean hasError(HttpStatus statusCode) {
    return statusCode.is4xxClientError() || statusCode.is5xxServerError();
  }

  protected boolean hasError(int unknownStatusCode) {
    int seriesCode = unknownStatusCode / 100;
    return seriesCode == HttpStatus.Series.CLIENT_ERROR.value() || seriesCode == HttpStatus.Series.SERVER_ERROR.value();
  }

  /*//默认的
  @Override
  public void handleError(ClientHttpResponse response) throws IOException {
    HttpStatus statusCode = this.getHttpStatusCode(response);
    switch(statusCode.series()) {
      case CLIENT_ERROR:
        throw new HttpClientErrorException(statusCode, response.getStatusText(), response.getHeaders(), this.getResponseBody(response), this.getCharset(response));
      case SERVER_ERROR:
        throw new HttpServerErrorException(statusCode, response.getStatusText(), response.getHeaders(), this.getResponseBody(response), this.getCharset(response));
      default:
        throw new UnknownHttpStatusCodeException(statusCode.value(), response.getStatusText(), response.getHeaders(), this.getResponseBody(response), this.getCharset(response));
    }
  }*/

  //改造的
  @Override
  public void handleError(ClientHttpResponse response) throws IOException {
    HttpStatus statusCode = this.getHttpStatusCode(response);
    switch (statusCode.series()) {//HttpStatus.Series.CLIENT_ERROR
      case CLIENT_ERROR:
        HttpClientErrorException httpClientErrorException = new HttpClientErrorException(statusCode, response.getStatusText(), response.getHeaders(), this.getResponseBody(response), this.getCharset(response));
        log.error("RestTemplate RPC CLIENT_ERROR:\n", httpClientErrorException);
        // 抛出自定义的可以返回给前端信息的异常
        throw new MyFailedLoginException("RPC CLIENT_ERROR");
      case SERVER_ERROR:
        HttpServerErrorException httpServerErrorException = new HttpServerErrorException(statusCode, response.getStatusText(), response.getHeaders(), this.getResponseBody(response), this.getCharset(response));
        log.error("RestTemplate RPC SERVER_ERROR:\n", httpServerErrorException);
        // 抛出自定义的可以返回给前端信息的异常
        throw new MyFailedLoginException("RPC SERVER_ERROR");
      default:
        UnknownHttpStatusCodeException e = new UnknownHttpStatusCodeException(statusCode.value(), response.getStatusText(), response.getHeaders(), this.getResponseBody(response), this.getCharset(response));
        log.error("RestTemplate RPC UnknownHttpStatusCodeException:\n", e);
        // 抛出自定义的可以返回给前端信息的异常
        throw new MyFailedLoginException("RPC UnknownHttpStatusCode");
    }
  }

  protected HttpStatus getHttpStatusCode(ClientHttpResponse response) throws IOException {
    try {
      return response.getStatusCode();
    } catch (IllegalArgumentException var3) {
      throw new UnknownHttpStatusCodeException(response.getRawStatusCode(), response.getStatusText(), response.getHeaders(), this.getResponseBody(response), this.getCharset(response));
    }
  }

  protected byte[] getResponseBody(ClientHttpResponse response) {
    try {
      return FileCopyUtils.copyToByteArray(response.getBody());
    } catch (IOException var3) {
      return new byte[0];
    }
  }

  protected Charset getCharset(ClientHttpResponse response) {
    HttpHeaders headers = response.getHeaders();
    MediaType contentType = headers.getContentType();
    return contentType != null ? contentType.getCharset() : null;
  }
}

将MyRestErrorHandler 在RestTemplate实例化的时候进行注册即可

参考文章

精讲RestTemplate第7篇-自定义请求失败异常处理_51CTO博客_resttemplate请求超时处理

springboot中RestTemplate的用法_springboot resttemplate用法-CSDN博客

非情剑
关注
  • 18
    点赞
  • 踩
  • 24
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Springboot2.0处理自定义异常并返回json
10-15
然后，为了确保Spring Boot能够正确地处理异常并将其包含在响应中，我们需要在`application.yml`配置文件中添加相应的设置。启用`include-exception`属性，使得Spring Boot在发生异常时不会直接返回500状态码，而是...
SpringBoot2.0 整合 Dubbo框架实现RPC服务远程调用方法
08-25
SpringBoot2.0 整合 Dubbo 框架实现 RPC 服务远程调用方法 本文主要介绍了 SpringBoot2.0 整合 Dubbo 框架实现 RPC 服务远程调用方法的详细步骤和配置。在本文中，我们将详细介绍 Dubbo 框架的简介、核心角色说明、...
RestTemplate调用超时问题解决
qq_41570752的博客
03-25 8237
问题描述 工作中，在调用同事写的某个接口的时候，使用的调用方式是RestTemplate。最开始数据量小，调用正常，随着数据量增加，这个接口过分的慢，后台日志出现Read time out异常。 问题分析 最开始我以为是网关设置的ribbon超时过短导致，调大后，还是不行。 然后我配置了自定义的一个RestTemplate，由于集成了公司框架，里面有默认的restTemplate，所以为当前bean指定一个名字。如下 @Configuration public class RestTemplat
RestTemplate 设置超时时间
move_on_on的博客
08-26 1万+
项目访问量大，频繁调取其他系统接口经常出现项目后台假死现象，发现其他系统掉线重启一段时间必现。查看调用接口，同事直接引用了RestTemplate但是没有设置超时时间->_
Spring RestTemplate配置DNS解析超时
最新发布
QiHY的专栏
06-16 518
在spring中使用RestTemplate调用远程接口时往往需要设置超时时间，否则当对方接口过慢时，很容易把自己系统堵死。连接超时、发送请求超时、接收响应超时都有直接的方法可以进行调用设置，设置DNS解析超时需要通过相对复杂的方法进行处理。首先RestTemplate配置使用apache httpclient进行http接口调用，apache httpclient内部通过默认的DnsResolver进行DNS解析，我们可以通过自己实现DnsResolver方法来设置DNS解析超时时间。
RestTemplate远程调用之设置超时时间的几种方式
yuanjinshenglife的专栏
03-13 4990
Spring RestTemplate远程调用之设置超时时间的几种方式
（上篇）java中http请求之restTemplate配置超时时间
热门推荐
qq_61367293的博客
08-31 2万+
restTemplate请求
spring restTemplate超时设置
lixinkuan的博客
11-23 5931
关于spring resttemplate超时设置 Spring org.springframework.web.client.RestTemplate 使用 org.springframework.http.client.SimpleClientHttpRequestFactory建立 java.net.HttpURLConnection 后者采用 HttpURLConnection 的默认超时配置 HttpURLConnection 超时属性 ConnectTimeout(ms) a speci
restTemplate配置超时时间
fulong0406的博客
05-11 1万+
关于spring resttemplate超时设置 Spring org.springframework.web.client.RestTemplate 使用 org.springframework.http.client.SimpleClientHttpRequestFactory建立 java.net.HttpURLConnection 后者采用 HttpURLConnection 的默认超时配置 HttpURLConnection 超时属性 ConnectTimeout(ms) a specifie.
精讲RestTemplate自定义请求失败异常处理.docx
06-28
这样，当请求失败时，我们的`handleError`方法会被调用，允许我们捕获并处理异常，而不是让程序直接终止。 三、自定义处理的优势 通过自定义异常处理，我们可以根据业务需求定制错误处理策略，比如： 1. 统一错误...
详解SpringBoot中RestTemplate的几种实现
08-25
此外，还可以自定义`RestTemplate`的行为，例如设置超时、添加拦截器、调整连接池配置等。 5. **使用示例** 使用`@Autowired`注解可以注入所需的`RestTemplate`实例，然后调用其方法来发起HTTP请求。例如，发送一...
SpringBoot设置接口超时时间的方法
08-25
在本文中，我们介绍了 SpringBoot 设置接口超时时间的方法，包括在配置文件中设置超时时间和在 Config 配置类中设置超时时间。这些方法可以帮助开发者避免请求超时对系统的影响，提高系统的稳定性和可靠性。
解锁新技能RestTemplate设置全局、单个请求超时时间及支持https请求
OceanSky的专栏
08-09 1万+
springboot请求第三方接口时会用到RestTemplate，其底层实现逻辑默认是通过SimpleClientHttpRequestFactory来实现，具体由socket连接来实现；可以替换其默认实现为HttpComponentsClientHttpRequestFactory。
RestTemplate 超时值
wangooo的博客
07-01 1万+
使用Spring的RestTemplate时，默认的超时值是无限的。 默认情况下，RestTemplate使用SimpleClientHttpRequestFactory，然后使用HttpURLConnection。 默认情况下为HttpURLConnection的超时时间为0 - 即无限的，除非它已经被设置这些属性： -Dsun.net.client.defaultConnectTimeout=TimeoutInMiliSec -Dsun.net.client.defaultReadTimeou
resttemplate设置超时
人生最遗憾的莫过于：轻易地放弃了不该放弃的,固执地坚持了不该坚持的
02-11 3181
setConnectTimeout 设定连接超时。从你发起建立连接请求到连接建立前的时间。 setReadTimeout 设定读取超时。连接建立后，发起request到收到response的时间。这个要慎重，如果你设置了超时，上游最后又把数据response给你了，可能出现你和上游的数据不一致。 restTemplateBuilder方式已经被废弃 restTemplateBuilder的方式被...
Springboot2.x中restTemplate超时、连接池、相应错误码处理配置
weixin_44012070的博客
07-18 2368
默认的ClientHttpRequestFactory使用的是HttpUrlConnection，本身不支持连接池。当需要启用连接池提高吞吐量或者减少请求响应时间，替换掉默认的ClientHttpRequestFactory，如Apache HttpComponents HttpClient。通过定义ClientHttpRequestFactory工厂并配置超时时间初始化restTemplate。RestTemplate默认也是用的ClientHttpRequestFactory的。
SpringBoot RestTemplate详解
白羊座的橙子
09-24 1万+
RestTemplate是Spring提供的进行远程调用客户端RestTemplate提供了很多远程调用的方法，能够大大提高客户端的编写效率。调用RestTemplate的默认构造函数，RestTemplate对象在底层通过使用java.net包下的实现创建HTTP 请求可以通过使用ClientHttpRequestFactory指定不同的HTTP请求方式ClientHttpRequestFactory接口主要提供了三种实现方式。
Springboot整合RestTemplate
Sunny_yaa的博客
04-16 2383
springboot整合RestTemplate
spring学习之restTemplate的异常处理器
惜阳
05-29 6940
restTemplate学习
springboot调用python脚本_SpringBoot——RestTemplate远程调用python rest接口
05-17
可以使用SpringBoot中的RestTemplate来调用Python的REST接口。 首先在Python中创建一个REST接口，可以使用Flask框架来实现，示例代码如下： ```Python from flask import Flask app = Flask(__name__) @app.route('/predict', methods=['POST']) def predict(): # 接收请求参数 data = request.get_json() # 对请求参数进行处理 ... # 返回预测结果 return {'result': result} if __name__ == '__main__': app.run() ``` 然后在SpringBoot中使用RestTemplate来调用该接口，示例代码如下： ```Java RestTemplate restTemplate = new RestTemplate(); // 设置请求头 HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_JSON); // 设置请求参数 Map<String, Object> params = new HashMap<>(); params.put("param1", "value1"); params.put("param2", "value2"); // 发送POST请求 String url = "http://localhost:5000/predict"; HttpEntity<Map<String, Object>> request = new HttpEntity<>(params, headers); ResponseEntity<Map> response = restTemplate.postForEntity(url, request, Map.class); // 处理响应结果 Map<String, Object> result = response.getBody(); ``` 需要注意的是，在SpringBoot中调用Python的REST接口时，需要注意跨域问题，可以在Python的REST接口中设置Access-Control-Allow-Origin头来解决跨域问题。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值