Skip to content
Server Plugin

部分内容

所需依赖项:io.ktor:ktor-server-partial-content

服务端示例: download-file, 客户端示例: client-download-file-range

Native 服务器Ktor 支持 Kotlin/Native,并允许您在无需额外运行时或虚拟机的情况下运行服务器。支持:✅

PartialContent 插件添加了对处理 HTTP 范围请求 (HTTP range requests) 的支持,该请求用于仅将 HTTP 消息的一部分发送回客户端。该插件对于流式传输内容或断点续传非常有用。

PartialContent 具有以下限制:

  • 仅适用于 HEAD 和 GET 请求,如果客户端尝试在其他方法中使用 Range 请求头,则返回 405 Method Not Allowed。
  • 仅适用于已定义 Content-Length 请求头的响应。
  • 在提供范围内容时会禁用压缩 (Compression)。

添加依赖项 ​

要使用 PartialContent,请将 ktor-server-partial-content 工件添加到构建脚本中:

kotlin
implementation(ktorLibs.server.partialContent)
上述代码段使用 Ktor 版本目录 来指定 Ktor 依赖项。
groovy
implementation ktorLibs.server.partialContent
上述代码段使用 Ktor 版本目录 来指定 Ktor 依赖项。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-partial-content-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

安装 PartialContent ​

要将 PartialContent 插件安装到您的应用程序中, 请将其传递给指定模块模块允许您通过对路由进行分组来构建应用程序结构。中的 install 函数。 以下示例展示了如何安装 PartialContent:

  • 在 embeddedServer() 函数调用中。
  • 在 Application 类上显式定义的 module() 扩展函数中。
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.partialcontent.*

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

PartialContent 插件还可以安装到特定路由中。 如果您需要为不同的应用程序资源使用不同的 PartialContent 配置,这会非常有用。

要了解如何使用 PartialContent 通过 HTTP 范围请求提供文件,请参阅文件 (File) 章节。