【Http请求-Spring RestTemplate】4.设置超时

设置超时有及其简便的两种方法，分别如下

一.Java的配置类设置

如下方式，添加此配置类即可。

@Configuration 
public class AppConfig{
@Bean
public RestTemplate customRestTemplate(){
HttpComponentsClientHttpRequestFactory httpRequestFactory = new HttpComponentsClientHttpRequestFactory();
httpRequestFactory.setConnectionRequestTimeout(3000);
httpRequestFactory.setConnectTimeout(3000);
httpRequestFactory.setReadTimeout(3000);

return new RestTemplate(httpRequestFactory);
}
}

二.配置文件指定

配置中添加如下项

custom.rest.connection.connection-request-timeout=3000
custom.rest.connection.connect-timeout=3000
custom.rest.connection.read-timeout=3000

然后类里加载配置即可

@Configuration
public class AppConfig{
@Bean
@ConfigurationProperties(prefix = "custom.rest.connection")
public HttpComponentsClientHttpRequestFactory customHttpRequestFactory() {
    return new HttpComponentsClientHttpRequestFactory();
}

@Bean
public RestTemplate customRestTemplate(){
    return new RestTemplate(customHttpRequestFactory());
}
}

 

1.HttpClient内部三个超时时间的区别

HttpClient内部有三个超时时间设置：连接池获取可用连接超时，连接超时，读取数据超时

先看以下HttpClient的初始化代码：

RequestConfig requestConfig = RequestConfig.custom()
                    .setConnectionRequestTimeout(config.connReqTimeout)   //从连接池中获取连接的超时时间
                            //与服务器连接超时时间：httpclient会创建一个异步线程用以创建socket连接，此处设置该socket的连接超时时间
                    .setConnectTimeout(config.connTimeout)
                    .setSocketTimeout(config.socketTimeout)               //socket读数据超时时间：从服务器获取响应数据的超时时间
                    .build();
            httpClient = HttpClientBuilder.create()
                    .setMaxConnTotal(config.maxConnTotal)                   //连接池中最大连接数
                            /**
                             * 分配给同一个route(路由)最大的并发连接数。
                             * route：运行环境机器 到 目标机器的一条线路。
                             * 举例来说，我们使用HttpClient的实现来分别请求 www.baidu.com 的资源和 www.bing.com 的资源那么他就会产生两个route。
                             */
                    .setMaxConnPerRoute(config.maxConnPerRoute)
                    .setDefaultRequestConfig(requestConfig)
                    .build();

三个超时时间详解：

1.从连接池中获取可用连接超时

HttpClient中的要用连接时尝试从连接池中获取，若是在等待了一定的时间后还没有获取到可用连接（比如连接池中没有空闲连接了）则会抛出获取连接超时异常。

2.连接目标超时connectionTimeout

 指的是连接目标url的连接超时时间，即客服端发送请求到与目标url建立起连接的最大时间。如果在该时间范围内还没有建立起连接，则就抛出connectionTimeOut异常。
   如测试的时候，将url改为一个不存在的url：“http://test.com” ， 超时时间3000ms过后，系统报出异常：    org.apache.commons.httpclient.ConnectTimeoutException:The host did not accept the connection within timeout of 3000 ms 

3.等待响应超时（读取数据超时）socketTimeout 

   连接上一个url后，获取response的返回等待时间 ，即在与目标url建立连接后，等待放回response的最大时间，在规定时间内没有返回响应的话就抛出SocketTimeout。
   测试的时候的连接url为我本地开启的一个url，http://localhost:8080/firstTest.htm?method=test，在我这个测试url里，当访问到这个链接时，线程sleep一段时间，来模拟返回response超时。 
--------------------- 
 

 

ConnectTimeout： 链接建立的超时时间；
SocketTimeout：响应超时时间，超过此时间不再读取响应；
ConnectionRequestTimeout： http clilent中从connetcion pool中获得一个connection的超时时间；

• 为HttpUrlConnection设置connectTimeout属性以防止连接被阻塞

urlConnection.setConnectTimeout(3000); 
这时，我们设置为超时时间为3秒，如果3秒内不能连接就被认为是有错误发生，从而有效地避免了由于ip不通导致连接不上的问题。并且，这个时间只是指建立socket的时间，而并不是指发送数据以及数据传输的时间。所以在一般的连接处理中，这个时间已经是非常地长了，不同的项目可以根据具体设置加以调整。但无论如果，给一个url请求，追加一个合适的超时时间是必须的，以保证正常的数据请求都能正确地处理，防止由于暂时的连接错误导致系统不能及时地响应。