Skip to content
Client Plugin

Cookie

代码示例: client-cookies

Ktor 客户端允许你通过以下方式手动处理 Cookie:

  • cookie 函数允许你向特定请求附加 Cookie。
  • setCookie 函数支持解析在响应中接收到的 Set-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 ​

客户端提供了 cookies 函数以获取指定 URL 的所有 Cookie:

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 作为实现参考。