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
}