快捷導(dǎo)航

圖文詳解OkHttp的超時(shí)時(shí)間

更新時(shí)間：2021年10月13日 12:04:34 作者：今天i你好嗎

HTTP是現(xiàn)代應(yīng)用常用的一種交換數(shù)據(jù)和媒體的網(wǎng)絡(luò)方式,高效地使用HTTP能讓資源加載更快,節(jié)省帶寬,OkHttp是一個(gè)高效的HTTP客戶端,下面這篇文章主要給大家介紹了關(guān)于OkHttp超時(shí)時(shí)間的相關(guān)資料,需要的朋友可以參考下

前言

雖然網(wǎng)上有很多關(guān)于okhttp超時(shí)時(shí)間的文章但大多都一筆帶過(guò)并沒(méi)有進(jìn)行詳細(xì)的講解各自的作用,于是就看了下源碼大致寫(xiě)一下其中的發(fā)現(xiàn).

本文以 'com.squareup.okhttp3:okhttp:3.12.0'源碼為參考

首先我們一共可以設(shè)置5個(gè)超時(shí)時(shí)間分別如下:

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有著密不可分的關(guān)系,其內(nèi)部維護(hù)了一個(gè)Watchdog,單獨(dú)開(kāi)一個(gè)線程死循環(huán)判斷是否超時(shí)

connectTimeout:

指的是建立連接所用的時(shí)間，適用于網(wǎng)絡(luò)狀況正常的情況下，兩端連接所用的時(shí)間。

通過(guò)跟源碼發(fā)現(xiàn)這個(gè)值用在了 socket.connect(address, connectTimeout);

callTimeout:

這個(gè)值從調(diào)用call.execute();和enqueue();這兩個(gè)方法開(kāi)始計(jì)時(shí),時(shí)間到后網(wǎng)絡(luò)還未請(qǐng)求完成將調(diào)用cancel();方法
在RealCall類中可以看到在構(gòu)造方法中創(chuàng)建timeout匿名內(nèi)部類

在execute方法中開(kāi)始計(jì)時(shí)

在timeoutExit方法中結(jié)束計(jì)時(shí)

pingInterval

通過(guò)跟源碼我們可以看到,這個(gè)值只有http2和webSocket中有使用

如果設(shè)置了這個(gè)值會(huì)定時(shí)的向服務(wù)器發(fā)送一個(gè)消息來(lái)保持長(zhǎng)連接

所以在寫(xiě)websocket時(shí)是完全可以只用設(shè)置這個(gè)值來(lái)保持長(zhǎng)連接的.

客戶端在發(fā)送ping消息時(shí)服務(wù)端會(huì)相應(yīng)的返回pong消息來(lái)進(jìn)行回應(yīng).同時(shí)okhttp也實(shí)現(xiàn)了pong,服務(wù)端在發(fā)起ping的時(shí)候客戶端會(huì)通過(guò)pong來(lái)進(jìn)行回應(yīng),即:在進(jìn)行長(zhǎng)連接時(shí),客戶端不需要進(jìn)行只需要服務(wù)端進(jìn)行定時(shí)ping也是可以保持長(zhǎng)連接的.

接下來(lái)就開(kāi)始講和我們密切相關(guān)的readTimeout和writeTimeout了,當(dāng)然也是最復(fù)雜的.其中最重要的還是readTimeout,我們先看writeTimeout

writeTimeout

這個(gè)值大致有3個(gè)地方用到

其中第二處和第三處的用用法是一致的,最后都是調(diào)用了

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

這寫(xiě)到底是什么意思呢?

這個(gè)就不得不說(shuō)okio了,okhttp中幾乎所有的流的操作都是由okio完成的,在okio.AsyncTimeout中對(duì)Sink(類似于OutputStream)和Source(類似于InputStream)進(jìn)行了一層封裝

/**

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;

這其中的邏輯還是相當(dāng)復(fù)雜的,大致意思就是所有的sink都被封裝了一個(gè)超時(shí)機(jī)制,需要在我們?cè)O(shè)置的時(shí)間內(nèi)寫(xiě)出TIMEOUT_WRITE_SIZE(64k)的數(shù)據(jù),如果無(wú)法完成即為超時(shí),所以,我們?cè)谏洗挝募r(shí)明明只設(shè)置了幾十秒的超時(shí)時(shí)間卻不會(huì)超時(shí).

在http2中就沒(méi)有再使用okio的超時(shí)機(jī)制了,當(dāng)然超時(shí)計(jì)時(shí)器還是用的AsyncTimeout.的Watchdog

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

readTimeout

readTimeout和writeTimeout幾乎完全一樣,只是操作相反,而且header的讀取和body的讀取是分開(kāi)進(jìn)行的,由于header數(shù)據(jù)量較小就不用討論了.

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

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

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

然后還漏了一點(diǎn):

socket.setSoTimeout(chain.readTimeoutMillis());

這行代碼什么意思呢?

setSotimeout(10000)是表示如果對(duì)方連接狀態(tài)10秒沒(méi)有收到數(shù)據(jù)的話強(qiáng)制斷開(kāi)客戶端。
如果想要長(zhǎng)連接的話，可以使用心跳包來(lái)通知服務(wù)器，也就是我沒(méi)有發(fā)給你數(shù)據(jù)，但是我告訴你我還活著.

最后,如果超時(shí)時(shí)間設(shè)置的如果是0,那么代表超時(shí)時(shí)長(zhǎng)為無(wú)限.

附上okhttp的默認(rèn)超時(shí)時(shí)間