DoubleReceive
所需依赖项:io.ktor:ktor-server-double-receive
代码示例: double-receive
DoubleReceive 插件提供了多次接收请求正文的能力,而不会抛出 RequestAlreadyConsumedException 异常。 如果某个插件已经消耗了请求正文,导致您无法在路由处理程序中接收它,该功能会非常有用。 例如,您可以使用 DoubleReceive 通过 CallLogging 插件记录请求正文,然后在 post 路由处理程序中再次接收正文。
DoubleReceive插件使用的是实验性 API,预计在未来的更新中会发生演进,并可能引入破坏性变更。
添加依赖项
要使用 DoubleReceive,您需要在构建脚本中包含 ktor-server-double-receive 构件:
安装 DoubleReceive
要将 DoubleReceive 插件安装到应用程序,请将其传递给指定
install 函数。 以下代码段展示了如何安装 DoubleReceive …… - ……在
embeddedServer函数调用中。 - ……在显式定义的
module中,它是Application类的扩展函数。
DoubleReceive 插件还可以安装到特定路由。 如果您需要为不同的应用程序资源使用不同的 DoubleReceive 配置,这会非常有用。
安装 DoubleReceive 后,您可以多次接收请求正文,并且每次调用都会返回相同的实例。 例如,您可以使用 CallLogging 插件启用请求正文的日志记录……
install(CallLogging) {
level = Level.TRACE
format { call ->
runBlocking {
"Body: ${call.receiveText()}"
}
}
}……然后在路由处理程序中再次获取请求正文。
post("/") {
val receivedText = call.receiveText()
call.respondText("Text '$receivedText' is received")
}您可以在此处找到完整的示例:double-receive。
配置 DoubleReceive
在默认配置下,DoubleReceive 支持将请求正文接收为以下类型:
ByteArrayStringParameters- 由
ContentNegotiation插件使用的数据类
默认情况下,DoubleReceive 不支持:
- 从同一个请求中接收不同的类型;
- 接收流或通道。
如果您不需要从同一个请求中接收不同类型,或者不需要接收流或通道,请将 cacheRawRequest 属性设置为 false:
install(DoubleReceive) {
cacheRawRequest = false
}