当前位置 博文首页 > 文章内容

    图文详解OkHttp的超时时间

    作者:21344 栏目:未分类 时间:2021-10-13 14:46:11

    前言

    虽然网上有很多关于okhttp超时时间的文章但大多都一笔带过并没有进行详细的讲解各自的作用,于是就看了下源码大致写一下其中的发现.

    本文以 'com.squareup.okhttp3:okhttp:3.12.0'源码为参考

    首先我们一共可以设置5个超时时间分别如下:

    OkHttpClient client = new OkHttpClient.Builder()

    .connectTimeout(30, TimeUnit.SECONDS)

    .callTimeout(120, TimeUnit.SECONDS)

    .pingInterval(5, TimeUnit.SECONDS)

    .readTimeout(60, TimeUnit.SECONDS)

    .writeTimeout(60, TimeUnit.SECONDS)

    .build();

    其中callTimeout,readTimeout,writeTimeout和okio的AsyncTimeout有着密不可分的关系,其内部维护了一个Watchdog,单独开一个线程死循环判断是否超时

    connectTimeout:

    指的是建立连接所用的时间,适用于网络状况正常的情况下,两端连接所用的时间。

    通过跟源码发现这个值用在了 socket.connect(address, connectTimeout);

    callTimeout:

    这个值从调用call.execute();和enqueue();这两个方法开始计时,时间到后网络还未请求完成将调用cancel();方法
    在RealCall类中可以看到在构造方法中创建timeout匿名内部类

    在execute方法中开始计时

    在timeoutExit方法中结束计时

    pingInterval

    通过跟源码我们可以看到,这个值只有http2和webSocket中有使用

    如果设置了这个值会定时的向服务器发送一个消息来保持长连接

    所以在写websocket时是完全可以只用设置这个值来保持长连接的.

    客户端在发送ping消息时服务端会相应的返回pong消息来进行回应.同时okhttp也实现了pong,服务端在发起ping的时候客户端会通过pong来进行回应,即:在进行长连接时,客户端不需要进行只需要服务端进行定时ping也是可以保持长连接的.

    接下来就开始讲和我们密切相关的readTimeout和writeTimeout了,当然也是最复杂的.其中最重要的还是readTimeout,我们先看writeTimeout

    writeTimeout

    这个值大致有3个地方用到

    其中第二处和第三处的用用法是一致的,最后都是调用了

    sink.timeout().timeout(writeTimeout, MILLISECONDS);
    

    这写到底是什么意思呢?

    这个就不得不说okio了,okhttp中几乎所有的流的操作都是由okio完成的,在okio.AsyncTimeout中对Sink(类似于OutputStream)和Source(类似于InputStream)进行了一层封装

    /**

    Don't write more than 64 KiB of data at a time, give or take a segment. Otherwise slow
    connections may suffer timeouts even when they're making (slow) progress. Without this, writing
    a single 1 MiB buffer may never succeed on a sufficiently slow connection.
    */
    private static final int TIMEOUT_WRITE_SIZE = 64 * 1024;

    这其中的逻辑还是相当复杂的,大致意思就是所有的sink都被封装了一个超时机制,需要在我们设置的时间内写出TIMEOUT_WRITE_SIZE(64k)的数据,如果无法完成即为超时,所以,我们在上次文件时明明只设置了几十秒的超时时间却不会超时.

    在http2中就没有再使用okio的超时机制了,当然超时计时器还是用的AsyncTimeout.的Watchdog




    可以看到,在http2中采用的是线程等待的策略

    readTimeout

    readTimeout和writeTimeout几乎完全一样,只是操作相反,而且header的读取和body的读取是分开进行的,由于header数据量较小就不用讨论了.

    okio中每次读取不大于8k.

    final class Segment {
    /** The size of all segments in bytes. */
    static final int SIZE = 8192;
    

    http2中每次读取不大于8k.

    然后还漏了一点:

    socket.setSoTimeout(chain.readTimeoutMillis());
    
    
    

    这行代码什么意思呢?

    setSotimeout(10000)是表示如果对方连接状态10秒没有收到数据的话强制断开客户端。
    如果想要长连接的话,可以使用心跳包来通知服务器,也就是我没有发给你数据,但是我告诉你我还活着.

    最后,如果超时时间设置的如果是0,那么代表超时时长为无限.

    附上okhttp的默认超时时间

    总结