Client Plugin
Cookie
コード例: client-cookies
Ktor クライアントでは、以下の方法で Cookie を手動で処理できます。
HttpCookies プラグインは Cookie を自動的に処理し、ストレージ内で呼び出し間にわたって保持します。 デフォルトではインメモリストレージを使用しますが、CookiesStorage を使用して永続ストレージを実装することもできます。
依存関係の追加
HttpCookies は ktor-client-core アーティファクトのみを必要とし、特定の依存関係を追加する必要はありません。
HttpCookies のインストールと設定
HttpCookies をインストールするには、クライアント設定ブロック内で install 関数に渡します。
kotlin
val client = HttpClient(CIO) {
install(HttpCookies)
}これだけで、Ktor クライアントがリクエスト間で Cookie を保持できるようになります。完全なサンプルはこちらで確認できます: client-cookies。
また、HttpCookies プラグインでは、ConstantCookiesStorage を使用して各リクエストに特定の Cookie セットを追加することもできます。これは、サーバーのレスポンスを検証するテストケースなどで役立ちます。以下の例は、特定のドメインに対するすべてのリクエストに指定した Cookie を追加する方法を示しています。
kotlin
val client = HttpClient(CIO) {
install(HttpCookies) {
storage = ConstantCookiesStorage(Cookie(name = "user_name", value = "jetbrains", domain = "0.0.0.0"))
}
}Cookie の取得
クライアントには、指定された URL のすべての Cookie を取得するための cookies 関数が用意されています。
kotlin
client.cookies("http://0.0.0.0:8080/")カスタム Cookie ストレージ
必要に応じて、CookiesStorage インターフェースを実装することでカスタムの Cookie ストレージを作成できます。
kotlin
val client = HttpClient(CIO) {
install(HttpCookies) {
storage = CustomCookiesStorage()
}
}
public class CustomCookiesStorage : CookiesStorage {
// ...
}実装の参考として AcceptAllCookiesStorage を参照してください。
