Skip to content
Client Plugin

快取

程式碼範例: client-caching

Ktor 用戶端提供 HttpCache 外掛程式,用於在記憶體或持久化儲存空間中快取先前擷取的資源。

新增相依性 ​

HttpCache 外掛程式包含在 ktor-client-core 構件中,不需要任何額外的相依性。

記憶體快取 ​

若要啟用記憶體快取,請在用戶端配置區塊中安裝 HttpCache:

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

預設情況下,HttpCache 外掛程式會在記憶體中儲存快取的回應。

例如,如果您對配置了 Cache-Control 標頭的資源發出兩次連續的請求,用戶端可以直接從快取提供第二次回應,而無須再次請求該資源。

持久化快取 ​

您可以透過配置 CacheStorage 實作來持久化儲存快取的回應。

Ktor 提供了 FileStorage() 函式,用於將快取的回應儲存在檔案系統中。FileStorage() 使用 kotlinx-io,並適用於所有支援的平台。

為快取目錄建立一個 Path,並將其傳遞給 FileStorage() 函式。 接著,使用 publicStorage() 或 privateStorage() 函式來配置儲存空間:

kotlin
val client = HttpClient(CIO) {
    install(HttpCache) {
        publicStorage(FileStorage(Path("build/cache")))
    }
}
  • 針對可儲存在共用快取中的回應,請使用 publicStorage() 函式。
  • 針對專用於私有快取的回應,請使用 privateStorage() 函式。

若要取得完整範例,請參閱 client-caching。