HttpClient默认重试策略不处理SocketTimeoutException

https://blog.csdn.net/weixin_34288121/article/details/91944946?spm=1001.2101.3001.6661.1&utm_medium=distribute.pc_relevant_t0.none-task-blog-2%7Edefault%7ECTRLIST%7ERate-1-91944946-blog-103029626.t5_download_comparev1&depth_1-utm_source=distribute.pc_relevant_t0.none-task-blog-2%7Edefault%7ECTRLIST%7ERate-1-91944946-blog-103029626.t5_download_comparev1&utm_relevant_index=1

https://blog.csdn.net/u010800970/article/details/79996698?spm=1001.2101.3001.6650.10&utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromBaidu%7ERate-10-79996698-blog-123966252.pc_relevant_default&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromBaidu%7ERate-10-79996698-blog-123966252.pc_relevant_default&utm_relevant_index=12

背景

与公司外服务采用http交互，使用httpClient 4.5.2版本的默认重试策略DefaultHttpRequestRetryHandler，发现对方接口连接超时（3秒）后， 并不会重试 而是直接抛出ConnectTimeoutException，不符合预期。

结论先行

httpClient默认重试策略DefaultHttpRequestRetryHandler针对连接超时和获取数据超时并不会重试，需要自定义重试策略。

问题分析

详细场景

采用HttpClient 4.5.2发起http请求，代码如下，使用方式正常

1. //http设置，retryHandler采用组件提供默认的重试策略DefaultHttpRequestRetryHandler，重试次数为3

2. return HttpClients.custom()

3. .setConnectionManager(****)

4. .setDefaultRequestConfig(****)

5. .setRetryHandler(new DefaultHttpRequestRetryHandler())

6. .build();

8. //请求发起主要代码

9. HttpPost httpPost = new HttpPost(url);

10. httpPost.setEntity(new UrlEncodedFormEntity(nameValuePairs, UTF_8));

11. CloseableHttpResponse response = httpClient.execute(request);

12. HttpEntity entity = response.getEntity();

13. ……其他关闭资源代码

请求后过了超时时间3s得到ConnectTimeoutException异常，且log中没有重试日志，堆栈如下：

1. Caused by: org.apache.http.conn.ConnectTimeoutException: Connect to www.XXX.com:443 [www.XXX.com/XX.1.XX.12] failed: connect timed out

2. at org.apache.http.impl.conn.DefaultHttpClientConnectionOperator.connect(DefaultHttpClientConnectionOperator.java:150)

3. at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.connect(PoolingHttpClientConnectionManager.java:353)

4. at org.apache.http.impl.execchain.MainClientExec.establishRoute(MainClientExec.java:380)

5. at org.apache.http.impl.execchain.MainClientExec.execute(MainClientExec.java:236)

6. at org.apache.http.impl.execchain.ProtocolExec.execute(ProtocolExec.java:184)

7. at org.apache.http.impl.execchain.RetryExec.execute(RetryExec.java:88)

8. at org.apache.http.impl.execchain.RedirectExec.execute(RedirectExec.java:110)

9. at org.apache.http.impl.client.InternalHttpClient.doExecute(InternalHttpClient.java:184)

10. at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:82)

11. at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:107)

12. at com.sankuai.meituan.resv.platform.utils.HttpUtil.getResult(HttpUtil.java:124)

13. ... 36 more

14. Caused by: java.net.SocketTimeoutException: connect timed out

15. at java.net.PlainSocketImpl.socketConnect(Native Method)

16. at java.net.AbstractPlainSocketImpl.doConnect(AbstractPlainSocketImpl.java:350)

17. at java.net.AbstractPlainSocketImpl.connectToAddress(AbstractPlainSocketImpl.java:206)

18. at java.net.AbstractPlainSocketImpl.connect(AbstractPlainSocketImpl.java:188)

19. at java.net.SocksSocketImpl.connect(SocksSocketImpl.java:392)

20. at java.net.Socket.connect(Socket.java:589)

21. at org.apache.http.conn.ssl.SSLConnectionSocketFactory.connectSocket(SSLConnectionSocketFactory.java:337)

22. at org.apache.http.impl.conn.DefaultHttpClientConnectionOperator.connect(DefaultHttpClientConnectionOperator.java:141)

23. ... 46 more

原因分析

出现这个问题，只好看默认重试策略的代码了，DefaultHttpRequestRetryHandler实现了HttpRequestRetryHandler，其中有这么一个方法public boolean retryRequest(final IOException exception,final int executionCount,final HttpContext context)，判断是否需要重试。

那么我们试图请求facebook（实验机器访问不了）来复现连接超时的情况，并进行断点调试，看这个方法的返回值。抛出的异常符合预期，即为ConnectTimeoutException，断点情况如下： 

该方法的确返回了false，即不会重试。

代码分析

实例化DefaultHttpRequestRetryHandler时会初始化nonRetriableClasses，结果如上图圈红出所示，然后发现这个继承关系public class ConnectTimeoutException extends InterruptedIOException { ，所以进入if分支返回false。

举一反三读取数据超时

连接超时不会重试，那读取数据超时是否会重试呢，根据继承关系public class SocketTimeoutException extends java.io.InterruptedIOException 判断是不会重试的。我们通过测试来复现下。

复现方式：http请求本地某个服务，设置SocketTimeout为3s，在服务端打上断点，让client调用超时。 结果的确没有重试，异常堆栈如下，

1. Caused by: java.net.SocketTimeoutException: Read timed out

2. at java.net.SocketInputStream.socketRead0(Native Method)

3. at java.net.SocketInputStream.socketRead(SocketInputStream.java:116)

4. at java.net.SocketInputStream.read(SocketInputStream.java:171)

5. at java.net.SocketInputStream.read(SocketInputStream.java:141)

6. at org.apache.http.impl.io.SessionInputBufferImpl.streamRead(SessionInputBufferImpl.java:137)

7. at org.apache.http.impl.io.SessionInputBufferImpl.fillBuffer(SessionInputBufferImpl.java:153)

8. at org.apache.http.impl.io.SessionInputBufferImpl.readLine(SessionInputBufferImpl.java:282)

9. at org.apache.http.impl.conn.DefaultHttpResponseParser.parseHead(DefaultHttpResponseParser.java:140)

10. at org.apache.http.impl.conn.DefaultHttpResponseParser.parseHead(DefaultHttpResponseParser.java:57)

11. at org.apache.http.impl.io.AbstractMessageParser.parse(AbstractMessageParser.java:259)

12. at org.apache.http.impl.DefaultBHttpClientConnection.receiveResponseHeader(DefaultBHttpClientConnection.java:163)

13. at org.apache.http.impl.conn.CPoolProxy.receiveResponseHeader(CPoolProxy.java:167)

14. at org.apache.http.protocol.HttpRequestExecutor.doReceiveResponse(HttpRequestExecutor.java:273)

15. at org.apache.http.protocol.HttpRequestExecutor.execute(HttpRequestExecutor.java:125)

16. at org.apache.http.impl.execchain.MainClientExec.execute(MainClientExec.java:271)

17. at org.apache.http.impl.execchain.ProtocolExec.execute(ProtocolExec.java:184)

18. at org.apache.http.impl.execchain.RetryExec.execute(RetryExec.java:88)

19. at org.apache.http.impl.execchain.RedirectExec.execute(RedirectExec.java:110)

20. at org.apache.http.impl.client.InternalHttpClient.doExecute(InternalHttpClient.java:184)

21. at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:82)

22. at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:107)

解决方案

自定义重试策略，某些异常时让它返回true重试就好。

1. private class MyHttpRequestRetryHandler implements HttpRequestRetryHandler{

3. @Override

4. public boolean retryRequest(IOException exception, int executionCount, HttpContext context) {

5. if (executionCount > retryTimes){

6. return false;

7. }

8. if (exception instanceof InterruptedIOException

9. || exception instanceof NoHttpResponseException) {

10. // Timeout or 服务端断开连接

11. return true;

12. }

13. // Unknown host

14. if (exception instanceof UnknownHostException) {

15. return false;

16. }

17. // SSL handshake exception

18. if (exception instanceof SSLException) {

19. return false;

20. }

22. final HttpClientContext clientContext = HttpClientContext.adapt(context);

23. final HttpRequest request = clientContext.getRequest();

24. boolean idempotent = !(request instanceof HttpEntityEnclosingRequest);

25. if (idempotent) {

26. // Retry if the request is considered idempotent

27. return true;

28. }

29. return false;

30. }

31. }

几个超时时间设置参数

1. /** 从连接池获取连接超时时间 **/

2. private int connectionRequestTimeout = 500;

4. /** 连接一个url的连接等待时间,建立socket连接时间 **/

5. private int connectTimeout = 3000;

7. /** 传输数据等待返回的超时时间 **/

8. private int socketTimeout = 3000;

反思总结

coding时认为默认重试策略遇到连接超时是会重试的，但实际没有进行这种异常case的测试，也没有看默认策略的代码实现，所以线上出现超时并没有重试的情况。

总结 ：为异常流程开发的处理方式，测试的时候虽然会麻烦些，但应该覆盖到，保证线上真正出现异常时恢复流程能正常work。

转载于:https://my.oschina.net/hebaodan/blog/1795348