Skip to content
Server Plugin

部分コンテンツ

必要な依存関係: io.ktor:ktor-server-partial-content

サーバーの例: download-file、 クライアントの例: client-download-file-range

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

PartialContent プラグインは、クライアントにHTTPメッセージの一部のみを返送するために使用されるHTTP範囲リクエスト(HTTP range requests)を処理するためのサポートを追加します。このプラグインは、コンテンツのストリーミングや中断したダウンロードの再開に役立ちます。

PartialContent には以下の制限事項があります。

  • HEAD および GET リクエストに対してのみ動作し、クライアントが他のメソッドで Range ヘッダーを使用しようとした場合は 405 Method Not Allowed を返します。
  • Content-Length ヘッダーが定義されているレスポンスに対してのみ動作します。
  • 範囲配信(range requests)の提供時には 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 設定が必要な場合に役立ちます。

HTTP範囲リクエストを使用してファイルを配信するために PartialContent を使用する方法については、File セクションを参照してください。