Skip to content
Client Plugin

逾時

程式碼範例: client-timeout

HttpTimeout 外掛程式可讓您設定以下逾時:

  • 請求逾時 (request timeout) — 處理一次 HTTP 呼叫所需的時間週期:從傳送請求到接收回應。
  • 連線逾時 (connection timeout) — 用戶端與伺服器建立連線所需的時間週期。
  • Socket 逾時 (socket timeout) — 與伺服器交換資料時,兩個資料封包之間無活動的最長時間。

您可以為所有請求或僅針對特定請求指定這些逾時。

新增相依性 ​

HttpTimeout 只需要 ktor-client-core 構件,不需要任何特定的相依性。

安裝 HttpTimeout ​

若要安裝 HttpTimeout,請在用戶端設定區塊中將其傳遞給 install 函式:

kotlin
import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.*
//...
val client = HttpClient(CIO) {
    install(HttpTimeout)
}

設定逾時 ​

若要設定逾時,您可以使用相對應的屬性:

您可以在 install 區塊中為所有請求指定逾時。下方的程式碼範例示範如何使用 requestTimeoutMillis 設定請求逾時:

kotlin
val client = HttpClient(CIO) {
    install(HttpTimeout) {
        requestTimeoutMillis = 1000
    }
}

若您只需要為特定請求設定逾時,請使用 HttpRequestBuilder.timeout 屬性:

kotlin
val response: HttpResponse = client.get("http://0.0.0.0:8080/path1") {
    timeout {
        requestTimeoutMillis = 3000
    }
}

請注意,為特定請求指定的逾時會覆寫來自 install 區塊的全域逾時。

發生逾時時,Ktor 會擲出 HttpRequestTimeoutException、ConnectTimeoutException 或 SocketTimeoutException。

限制 ​

HttpTimeout 對於特定引擎存在一些限制。下表顯示這些引擎支援的逾時類型:

引擎請求逾時 (Request Timeout)連線逾時 (Connect Timeout)Socket 逾時 (Socket Timeout)
Darwin✅️✖️✅️
JavaScript✅✖️✖️
Curl✅✅️✖️
MockEngine✅✖️✅