Skip to content

クライアントプラグイン ​

多くのアプリケーションでは、ロギング、シリアライズ、認可など、アプリケーションのコアロジックには含まれない共通機能が必要になります。Ktorでは、このような機能はクライアントプラグインによって提供されます。

プラグインの依存関係を追加する ​

一部のプラグインには追加の依存関係が必要です。たとえば、Logging プラグインを使用するには、ビルドスクリプトに ktor-client-logging アーティファクトを追加する必要があります。

kotlin
implementation(ktorLibs.client.logging)
上記のコードスニペットでは、Ktorの依存関係を指定するために Ktor バージョンカタログ を使用しています。
groovy
implementation ktorLibs.client.logging
上記のコードスニペットでは、Ktorの依存関係を指定するために 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/")
    }
}

カスタムプラグインを作成する ​

既存のプラグインでニーズを満たせない場合は、独自のカスタムクライアントプラグインを作成できます。カスタムプラグインを使用すると、リクエストやレスポンスをインターセプトし、再利用可能な動作を実装できます。

詳細については、カスタムクライアントプラグインを参照してください。