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。
