客户端插件
许多应用程序都需要一些不属于核心应用程序逻辑的通用功能,例如日志记录、序列化或授权。在 Ktor 中,这些功能由客户端_插件_提供。
添加插件依赖项
部分插件需要额外的依赖项。例如,要使用 Logging 插件,您需要在构建脚本中添加 ktor-client-logging 构件:
kotlin
implementation(ktorLibs.client.logging) 上述代码片段使用 Ktor 版本目录 (version catalog) 来指定 Ktor 依赖项。
groovy
implementation ktorLibs.client.logging 上述代码片段使用 Ktor 版本目录 (version catalog) 来指定 Ktor 依赖项。
xml
<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-client-logging-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>各个插件的文档都会指明其所需的依赖项。
安装插件
要安装插件,请在客户端配置块内将其传递给 install() 函数。
例如,安装 Logging 插件的方式如下:
kotlin
import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.logging.*
val client = HttpClient(CIO) {
install(Logging)
}安装或替换插件
在某些情况下,插件可能已经被安装——例如由共享的客户端配置代码安装。在这些情况下,您可以使用 installOrReplace() 函数来替换其配置:
kotlin
import io.ktor.client.*
import io.ktor.client.engine.cio.*
val client = HttpClient(CIO) {
installOrReplace(ContentNegotiation) {
// ...
}
}该函数会在插件不存在时进行安装,若已安装则替换其现有的配置。
配置插件
大多数插件都会提供可在 install 块内进行设置的配置选项。
例如,Logging 插件允许您指定记录器、日志级别以及筛选日志消息的条件:
kotlin
package com.example
import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.logging.*
import io.ktor.client.request.*
import io.ktor.client.statement.*
import io.ktor.http.*
import kotlinx.coroutines.runBlocking
fun main() {
runBlocking {
val client = HttpClient(CIO) {
install(Logging) {
logger = Logger.DEFAULT
level = LogLevel.HEADERS
filter { request ->
request.url.host.contains("ktor.io")
}
sanitizeHeader { header -> header == HttpHeaders.Authorization }
}
}
val response1: HttpResponse = client.get("https://ktor.io/")
val response2: HttpResponse = client.get("https://jetbrains.com/")
}
}创建自定义插件
如果现有的插件无法满足您的需求,您可以创建自己的自定义客户端插件。自定义插件允许您拦截请求与响应,并实现可复用的行为。
要了解更多信息,请参阅自定义客户端插件。
