RestTemplate超时引发的血案

最近线上出了一次故障，收银台系统所有服务全部假死。订单量瞬时下降，造成很大损失。

故障总结，导致问题的原因有两方面：

数据库慢查询

 ●  RestTemplate超时时间设置不生效。

 ●  spring-web不同版本设置RestTemplate方式不完全一样。

默认超时设置

默认情况下是没有超时设置的，此时超时依赖两方面：

依赖TCP连接本身的超时时间（tcp空闲连接，超过一定时间，连接会被关闭）。

请求所经过的网络节点的超时时间。e.g. 中间经过nginx, nginx默认读取后端服务的超时时间是60s，所以超时时间在60s左右（日志显示稍微大一点，不会大很多）。

代码分析

例子

1. long start = System.currentTimeMillis();

2. try {

3. RestTemplate restTemplate = new RestTemplate();

4. Map responseObject = restTemplate.getForObject(url, Map.class);

5. System.out.println(responseObject);

6. } catch (Exception e) {

7. Assert.assertNotNull(e);

8. System.out.println("timeout = " + (System.currentTimeMillis() - start));

9. }

原因：

RestTemplate继承自 HttpAccessor, 默认使用的 ClientHttpRequestFactory是 SimpleClientHttpRequestFactory

1. public abstract class HttpAccessor {

3. /**

4. * Logger available to subclasses.

5. */

6. protected final Log logger = LogFactory.getLog(getClass());

8. private ClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();

9. }

11. public class SimpleClientHttpRequestFactory implements ClientHttpRequestFactory {

13. private static final int DEFAULT_CHUNK_SIZE = 4096;

16. private Proxy proxy;

18. private boolean bufferRequestBody = true;

20. private int chunkSize = DEFAULT_CHUNK_SIZE;

22. // 连接和读取超时都是 -1, 也就是没有超时设置。

23. private int connectTimeout = -1;

24. private int readTimeout = -1;

25. }

那么我们使用 RestTemplate该如何设置超时时间呢？

RestTemplate超时设置

由上面的代码我们了解到，超时设置其实应该通过内部的 ClientHttpRequestFactory

来设置的。

所以就可以通过给 RestTemplate设置一个我们自己创建的，设置了超时时间的 ClientHttpRequestFactory来实现。

1. SimpleClientHttpRequestFactory clientHttpRequestFactory = new SimpleClientHttpRequestFactory();

2. clientHttpRequestFactory.setConnectTimeout(1000);

3. clientHttpRequestFactory.setReadTimeout(50);

4. RestTemplate restTemplate = new RestTemplate();

5. restTemplate.setRequestFactory(clientHttpRequestFactory);

或者

1. HttpComponentsClientHttpRequestFactory clientHttpRequestFactory = new HttpComponentsClientHttpRequestFactory();

2. clientHttpRequestFactory.setConnectTimeout(1000);

3. clientHttpRequestFactory.setReadTimeout(50);

4. RestTemplate restTemplate = new RestTemplate();

5. restTemplate.setRequestFactory(clientHttpRequestFactory);

但是要注意的是: HttpComponentsClientHttpRequestFactory底层使用了apache的 HttpClient，超时时间的设置其实是针对它进行设置的。

HttpComponentsClientHttpRequestFactory

1. private static final int DEFAULT_MAX_TOTAL_CONNECTIONS = 100;

3. private static final int DEFAULT_MAX_CONNECTIONS_PER_ROUTE = 5;

4. //默认读取超时 60s

5. private static final int DEFAULT_READ_TIMEOUT_MILLISECONDS = (60 * 1000);

7. private HttpClient httpClient;

9. /**

10. * Set the connection timeout for the underlying HttpClient.

11. * A timeout value of 0 specifies an infinite timeout.

12. * @param timeout the timeout value in milliseconds

13. */

14. public void setConnectTimeout(int timeout) {

15. Assert.isTrue(timeout >= 0, "Timeout must be a non-negative value");

16. getHttpClient().getParams().setIntParameter(CoreConnectionPNames.CONNECTION_TIMEOUT, timeout);

17. }

到此，如果就通过上面提到的方式设置超时时间，那么我们的应用就不用有超时问题，也不会发生故障了。

但问题就发生在，公司内部使用的组件，不是通过 HttpComponentsClientHttpRequestFactory

设置超时时间，而是通过设置 HttpComponentsClientHttpRequestFactory内部的 HttpClient设置的超时时间，并且设置了 HttpClient使用的 HttpClientConnectionManager，从而导致了问题的发生。

问题代码&测试

1. @Test

2. public void testRestTemplateWithRequestFactoryWithoutTimeOut() {

3. long start = System.currentTimeMillis();

4. try {

5. HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory();

7. //2.设置超时时间， 设置/不设置ConnectionManager

8. HttpClient httpClient = HttpClientBuilder.create()

9. .setDefaultRequestConfig(getRequestConfig())

10. .setDefaultSocketConfig(getSocketConfig())

11. .setConnectionManager(new PoolingHttpClientConnectionManager(3, TimeUnit.MINUTES))

12. .build();

14. requestFactory.setHttpClient(httpClient);

15. RestTemplate restTemplate = new RestTemplate();

16. restTemplate.setRequestFactory(requestFactory);

18. Map responseObject = restTemplate.getForObject(QUERY_USER_RENEW_URL, Map.class);

19. System.out.println(responseObject);

20. } catch (Exception e) {

21. Assert.assertNotNull(e);

22. System.out.println("timeout = " + (System.currentTimeMillis() - start));

23. }

24. }

结论

spring-web 版本 3.2.0

 ●  默认超时 60s, 因为nginx默认的proxyreadtimeout 是60s

 ●  设置了 HttpClient的超时时间， 不设置 ConnectionManager 超时生效

 ●  设置了 HttpClient的超时时间， 设置 ConnectionManager 超时生效

spring-web 版本 4.0.9.RELEASE

 ●  设置了 HttpClient的超时时间， 设置 ConnectionManager 超时不生效 （qiyue-store 就是这样问题）

spring-web 版本 4.3.0.RELEASE

spring-web 版本 4.3.11.RELEASE

 ●  默认超时 60s, 因为nginx默认的 proxyreadtimeout 是60s

 ●  设置了 HttpClient的超时时间， 设置 ConnectionManager 超时生效 其实问题就在与不同的版本中 HttpComponentsClientHttpRequestFactory.createRequest 方法的实现逻辑不同。如何不同，自己查看。:grin:

总结

超时设置至关重要。外部依赖接口调用可以通过Hystrix进行包装。

任何参数的设置都需要验证是否可以正常工作，可以加入到测试环节中，方便在不同的依赖版本中进行验证。

原文发布时间为：2018-11-23

本文来自云栖社区合作伙伴“

Java杂记

”，了解相关信息可以关注“

”。