用戶端外掛程式
許多應用程式都需要不屬於核心應用程式邏輯的常見功能,例如 記錄、序列化或 授權。在 Ktor 中, 這些功能是由用戶端 外掛程式 提供的。
新增外掛程式相依性
某些外掛程式需要額外的相依性。例如,若要使用 Logging 外掛程式,您需要在組建指令碼中新增 ktor-client-logging 構件:
各外掛程式的文件均會註記所需的任何相依性。
安裝外掛程式
若要安裝外掛程式,請將其傳遞給用戶端配置區塊內的 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/")
}
}建立自訂外掛程式
如果現有的外掛程式無法滿足您的需求,您可以建立自己的自訂用戶端外掛程式。自訂外掛程式可讓您攔截請求與回應,並實作可重複使用的行為。
若要了解更多,請參閱 自訂用戶端外掛程式。
