Skip to content
Server Plugin

DoubleReceive

必要的相依性:io.ktor:ktor-server-double-receive

程式碼範例: double-receive

原生伺服器Ktor 支援 Kotlin/Native,可讓您在無需額外執行階段或虛擬機的情況下執行伺服器。 支援:✅

DoubleReceive 外掛程式提供了多次接收請求主體的功能,且不會擲出 RequestAlreadyConsumedException 例外。 當某個外掛程式已經消耗了請求主體,導致您無法在路由處理常式內部接收時,這項功能就非常實用。 例如,您可以利用 DoubleReceive,透過 CallLogging 外掛程式記錄請求主體,然後在 post 路由處理常式內部再次接收該主體。

新增相依性 ​

若要使用 DoubleReceive,請將 ktor-server-double-receive 構件新增至您的組建指令碼中:

kotlin
implementation(ktorLibs.server.doubleReceive)
上述程式碼片段使用 Ktor version catalog 來指定 Ktor 相依性。
groovy
implementation ktorLibs.server.doubleReceive
上述程式碼片段使用 Ktor version catalog 來指定 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 提供了將請求主體接收為以下型別的能力:

預設情況下,DoubleReceive 不支援:

如果您不需要從同一個請求接收不同的型別,也不需要接收串流或通道,請將 cacheRawRequest 屬性設為 false:

kotlin
install(DoubleReceive) {
    cacheRawRequest = false
}