Skip to content

クライアントアプリケーションの作成

Ktorにはマルチプラットフォーム対応の非同期HTTPクライアントが含まれており、リクエストの送信リクエストの送信方法と、リクエストURL、HTTPメソッド、ヘッダー、リクエストボディなどのさまざまなリクエストパラメータの指定方法について学びます。やレスポンスの処理レスポンスの受信、レスポンスボディの取得、およびレスポンスパラメータの取得方法について学びます。を行えるほか、認証Auth プラグインは、クライアントアプリケーションにおける認証と認可を処理します。やJSONシリアライゼーションContentNegotiation プラグインには、クライアントとサーバー間のメディアタイプのネゴシエーション、およびリクエストの送信時やレスポンスの受信時に特定の形式でコンテンツをシリアライズ/デシリアライズするという2つの主な目的があります。などのプラグインクライアントプラグインを使用して、ロギング、シリアライズ、認可などの共通機能を追加する方法を学びます。を使用して機能を拡張できます。

このチュートリアルでは、リクエストを送信してレスポンスを出力する最初のKtorクライアントアプリケーションの作成方法を説明します。

前提条件

このチュートリアルを始める前に、IntelliJ IDEA CommunityまたはUltimateをインストールしてください。

新規プロジェクトの作成

既存のプロジェクトでKtorクライアントを手動で作成および設定Ktorクライアントの作成と設定方法について学びます。することもできますが、最初から始める便利な方法として、IntelliJ IDEAにバンドルされているKotlinプラグインを使用して新規プロジェクトを生成する方法があります。

新しいKotlinプロジェクトを作成するには、IntelliJ IDEAを開き、以下の手順に従ってください。

  1. ウェルカム画面で、New Projectをクリックします。

    または、メインメニューからFile | New | Projectを選択します。

  2. New Projectウィザードで、左側のリストからKotlinを選択します。

  3. 右側のペインで、以下の設定を指定します。

    IntelliJ IDEAの新規Kotlinプロジェクトウィンドウ
    • Name: プロジェクト名を指定します。

    • Location: プロジェクト用のディレクトリを指定します。

    • Build system: Gradleが選択されていることを確認します。

    • Gradle DSL: Kotlinを選択します。

    • Add sample code: 生成されるプロジェクトにサンプルコードを含めるには、このオプションを選択します。

  4. Createをクリックし、IntelliJ IDEAがプロジェクトを生成して依存関係をインストールするまで待ちます。

依存関係の追加

Ktorクライアントに必要な依存関係を追加しましょう。

  1. gradle.propertiesファイルを開き、次の行を追加してKtorのバージョンを指定します。

    kotlin
    ktor_version=3.6.1

    KtorのEAPバージョンを使用するには、Spaceリポジトリを追加する必要があります。

  2. build.gradle.ktsファイルを開き、dependenciesブロックに以下のアーティファクトを追加します。

    kotlin
    dependencies {
        implementation(ktorLibs.client.core)
        implementation(ktorLibs.client.cio)
        implementation(libs.logback.classic)
    }
    • ktor-client-core (ktorLibs.client.core) は、クライアントの主要な機能を提供するコア依存関係です。
    • ktor-client-cio(ktorLibs.client.cio) は、ネットワークリクエストを処理するエンジンネットワークリクエストを処理するエンジンについて学びます。の依存関係です。
  3. build.gradle.ktsファイルの右上隅にあるLoad Gradle Changesアイコンをクリックして、新しく追加した依存関係をインストールします。

    Gradleの変更を読み込む

クライアントの作成

クライアントの実装を追加するには、src/main/kotlinに移動し、以下の手順に従ってください。

  1. Main.ktファイルを開き、既存のコードを以下の実装に置き換えます。

    kotlin
    import io.ktor.client.*
    import io.ktor.client.engine.cio.*
    
    fun main() {
        val client = HttpClient(CIO)
    }

    Ktorでは、クライアントはHttpClientクラスで表現されます。

  2. HttpClient.get()メソッドを使用してGETリクエストを送信リクエストの送信方法と、リクエストURL、HTTPメソッド、ヘッダー、リクエストボディなどのさまざまなリクエストパラメータの指定方法について学びます。します。レスポンスレスポンスの受信、レスポンスボディの取得、およびレスポンスパラメータの取得方法について学びます。はHttpResponseクラスのオブジェクトとして受信されます。

    kotlin
    import io.ktor.client.*
    import io.ktor.client.engine.cio.*
    import io.ktor.client.request.*
    import io.ktor.client.statement.*
    
    fun main() {
        val client = HttpClient(CIO)
        val response: HttpResponse = client.get("https://ktor.io/")
    }

    上記のコードを追加すると、IDEはget()関数に対して次のエラーを表示します: Suspend function 'get' should be called only from a coroutine or another suspend function 。

    suspend関数のエラー

    これを解決するには、main()関数をサスペンド(suspending)関数にする必要があります。

    suspend関数の呼び出しについての詳細は、コルーチンの基本を参照してください。
  3. IntelliJ IDEAで定義の横にある赤い電球アイコンをクリックし、Make main suspendを選択します。

    Make main suspend
  4. サーバーから返されたステータスコードを出力するにはprintln()関数を使用し、ストリームを閉じて関連するリソースを解放するにはclose()関数を使用します。Main.ktファイルは次のようになります。

    kotlin
    import io.ktor.client.*
    import io.ktor.client.engine.cio.*
    import io.ktor.client.request.*
    import io.ktor.client.statement.*
    
    suspend fun main() {
        val client = HttpClient(CIO)
        val response: HttpResponse = client.get("https://ktor.io/")
        println(response.status)
        client.close()
    }

アプリケーションの実行

アプリケーションを実行するには、Main.ktファイルに移動し、以下の手順に従ってください。

  1. IntelliJ IDEAでmain()関数の横にあるガターアイコンをクリックし、Run 'MainKt'を選択します。

    アプリを実行
  2. IntelliJ IDEAがアプリケーションを実行するまで待ちます。
  3. IDEの下部にあるRunペインに出力が表示されます。

    サーバーのレスポンス

    サーバーは200 OKメッセージで応答しますが、同時にSLF4JがStaticLoggerBinderクラスの検出に失敗し、デフォルトでno-operation (NOP) ロガー実装にフォールバックしたことを示すエラーメッセージも表示されます。これは実質的にロギングが無効になっていることを意味します。

    これでクライアントアプリケーションは動作するようになりました。ただし、この警告を解消し、ログ出力によってHTTP呼び出しをデバッグできるようにするには、追加の手順が必要です。

ロギングの有効化

KtorはJVM上でのロギングにSLF4J抽象化レイヤーを使用しているため、ロギングを有効にするにはLogbackなどのロギングフレームワークを提供する必要があります。

  1. gradle.propertiesファイルで、ロギングフレームワークのバージョンを指定します。

    kotlin
    logback_version=1.6.3
  2. build.gradle.ktsファイルを開き、dependenciesブロックに以下のアーティファクトを追加します。

    kotlin
    //...
    val logback_version: String by project
    
    dependencies {
        //...
        implementation("ch.qos.logback:logback-classic:$logback_version")
    }
  3. Load Gradle Changesアイコンをクリックして、新しく追加した依存関係をインストールします。
  4. IntelliJ IDEAで再実行ボタン(IntelliJ IDEA再実行アイコン)をクリックして、アプリケーションを再起動します。

  5. エラーが表示されなくなり、IDE下部のRunペインに先ほどと同じ200 OKメッセージが表示されます。

    サーバーのレスポンス

    これでロギングが有効になりました。ログの出力を確認するには、ロギング設定を追加する必要があります。

  6. src/main/resourcesに移動し、以下の実装を含む新しいlogback.xmlファイルを作成します。

    xml
    <configuration>
        <appender name="APPENDER" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>%d{YYYY-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
            </encoder>
        </appender>
        <root level="trace">
            <appender-ref ref="APPENDER"/>
        </root>
    </configuration>
  7. IntelliJ IDEAで再実行ボタン(IntelliJ IDEA再実行アイコン)をクリックして、アプリケーションを再起動します。

  8. Runペイン内の出力されたレスポンスの上に、トレースログが表示されるようになります。

    サーバーのレスポンス
KtorはLogging必要な依存関係: io.ktor:ktor-client-loggingプラグインを通じてHTTP呼び出しのログを追加するシンプルで簡単な方法を提供しますが、設定ファイルを追加することで、複雑なアプリケーションにおけるロギング動作を細かく調整できます。

次のステップ

この設定についてさらに理解を深め、拡張するには、Ktorクライアントの作成と設定Ktorクライアントの作成と設定方法について学びます。を参照してください。