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ヘッダーが設定されたリソースに対して2回連続してリクエストを送信した場合、クライアントはリソースを再リクエストする代わりにキャッシュから2回目のレスポンスを返すことができます。
永続キャッシュ
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を参照してください。
