Skip to content
Server Plugin

DoubleReceive

必要な依存関係: io.ktor:ktor-server-double-receive

コード例: double-receive

Native サーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✅

DoubleReceive プラグインは、RequestAlreadyConsumedException 例外を発生させることなく、リクエスト本文を複数回受信する 機能を提供します。 これは、プラグイン がすでにリクエスト本文を消費してしまったために、ルートハンドラー内でリクエスト本文を受信できなくなった場合に便利です。 例えば、DoubleReceive を使用すると、CallLogging プラグインを使用してリクエスト本文をログに記録し、その後 post ルートハンドラー 内でもう一度本文を受信することができます。

依存関係の追加 ​

DoubleReceive を使用するには、ビルドスクリプトに ktor-server-double-receive アーティファクトを追加します。

kotlin
implementation(ktorLibs.server.doubleReceive)
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログ を使用しています。
groovy
implementation ktorLibs.server.doubleReceive
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログ を使用しています。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-double-receive-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

DoubleReceive のインストール ​

DoubleReceive プラグインをアプリケーションにインストールするには、 指定したモジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。内の install 関数に渡します。 以下の例は、DoubleReceive をインストールする方法を示しています。

  • embeddedServer() 関数の呼び出し内。
  • Application クラスで明示的に定義された module() 拡張関数内。
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.doublereceive.*

fun main() {
    embeddedServer(Netty, port = 8080) {
        install(DoubleReceive)
        // ...
    }.start(wait = true)
}
kotlin
import io.ktor.server.application.*
import io.ktor.server.plugins.doublereceive.*
// ...
fun Application.module() {
    install(DoubleReceive)
    // ...
}

DoubleReceive プラグインは、特定のルートにインストールすることもできます。 これは、アプリケーションのリソースごとに異なる DoubleReceive 設定が必要な場合に便利です。

DoubleReceive をインストールした後は、リクエスト本文を複数回受信 することができ、呼び出しごとに同じインスタンスが返されます。 例えば、CallLogging プラグインを使用してリクエスト本文のロギングを有効にし...

kotlin
install(CallLogging) {
    level = Level.TRACE
    format { call ->
        runBlocking {
            "Body: ${call.receiveText()}"
        }
    }
}

...その後、ルートハンドラー内でもう一度リクエスト本文を取得することができます。

kotlin
post("/") {
    val receivedText = call.receiveText()
    call.respondText("Text '$receivedText' is received")
}

完全なコード例はこちらで確認できます: double-receive

DoubleReceive の設定 ​

デフォルト設定では、DoubleReceive は以下の型としてリクエスト本文を受信する 機能を提供します。

  • ByteArray
  • String
  • Parameters
  • ContentNegotiation プラグインで使用されるデータクラス

デフォルトでは、DoubleReceive は以下をサポートしていません:

同じリクエストから異なる型を受信したり、ストリームやチャネルを受信したりする必要がない場合は、cacheRawRequest プロパティを false に設定します:

kotlin
install(DoubleReceive) {
    cacheRawRequest = false
}