Skip to content

サーバーの作成

Ktorアプリケーションを作成する前に、アプリケーションをどのように デプロイ Code example: deployment-ktor-plugin するかを考慮する必要があります。

  • 自己完結型パッケージとして

    この場合、ネットワークリクエストを処理するために使用されるアプリケーションエンジンネットワークリクエストを処理するエンジンについて学びます。をアプリケーションの一部にする必要があります。 アプリケーションはエンジンの設定、接続、およびSSLオプションを制御できます。

  • サーブレットとして

    この場合、Ktorアプリケーションはサーブレットコンテナ(TomcatやJettyなど)内にデプロイできます。サーブレットコンテナがアプリケーションのライフサイクルと接続設定を制御します。

自己完結型パッケージ

Ktorサーバーアプリケーションを自己完結型パッケージとして提供するには、まずサーバーを作成する必要があります。 サーバーの設定には、サーバーエンジンネットワークリクエストを処理するエンジンについて学びます。(Netty、Jettyなど)、さまざまなエンジン固有のオプション、ホストとポートの値など、さまざまな設定を含めることができます。 Ktorでサーバーを作成して実行するには、主に2つのアプローチがあります。

  • embeddedServer関数は、 コード内でサーバーパラメータを設定 し、アプリケーションを素早く実行するためのシンプルな方法です。

  • EngineMainは、サーバーを設定するためのより高い柔軟性を提供します。 ファイル内でサーバーパラメータを指定 できるため、アプリケーションを再コンパイルせずに設定を変更できます。さらに、コマンドラインからアプリケーションを実行し、対応するコマンドライン引数を渡すことで必要なサーバーパラメータを上書きすることも可能です。

コード内での設定

embeddedServer関数は、 コード内コード内でさまざまなサーバーパラメータを設定する方法を学びます。 でサーバーパラメータを設定し、アプリケーションを素早く実行するためのシンプルな方法です。以下のコードスニペットでは、サーバーを起動するためのパラメータとして エンジンネットワークリクエストを処理するエンジンについて学びます。 とポートを受け取ります。以下の例では、Nettyエンジンを使用してサーバーを実行し、8080ポートでリスンします。

kotlin
package com.example

import io.ktor.server.response.*
import io.ktor.server.routing.*
import io.ktor.server.engine.*
import io.ktor.server.netty.*

fun main(args: Array<String>) {
    if (args.isEmpty()) {
        println("Running basic server...")
        println("Provide the 'configured' argument to run a configured server.")
        runBasicServer()
    }

    when (args[0]) {
        "basic" -> runBasicServer()
        "configured" -> runConfiguredServer()
        else -> runServerWithCommandLineConfig(args)
    }
}

fun runBasicServer() {
    embeddedServer(Netty, port = 8080) {
        routing {
            get("/") {
                call.respondText("Hello, world!")
            }
        }
    }.start(wait = true)
}

fun runConfiguredServer() {
    embeddedServer(Netty, configure = {
        connectors.add(EngineConnectorBuilder().apply {
            host = "127.0.0.1"
            port = 8080
        })
        connectionGroupSize = 2
        workerGroupSize = 5
        callGroupSize = 10
        shutdownGracePeriod = 2000
        shutdownTimeout = 3000
    }) {
        routing {
            get("/") {
                call.respondText("Hello, world!")
            }
        }
    }.start(wait = true)
}

fun runServerWithCommandLineConfig(args: Array<String>) {
    embeddedServer(
        factory = Netty,
        configure = {
            val cliConfig = CommandLineConfig(args)
            takeFrom(cliConfig.engineConfig)
            loadCommonConfiguration(cliConfig.rootConfig.environment.config)
        }
    ) {
        routing {
            get("/") {
                call.respondText("Hello, world!")
            }
        }
    }.start(wait = true)
}

完全な例については、 embedded-server を参照してください。

ファイル内での設定

EngineMainは、選択したエンジンでサーバーを起動し、外部の設定ファイル構成ファイルでさまざまなサーバーパラメータを設定する方法について説明します。(通常はresourceディレクトリにあるapplication.confまたはapplication.yaml)からアプリケーションモジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。を読み込みます。

どのモジュールを読み込むかの指定に加えて、設定ファイルにはポート、ホスト、SSL設定などのさまざまなサーバーパラメータを含めることができます。例えば、以下の設定ではサーバーポートを8080に設定しています。

kotlin
package com.example

import io.ktor.server.application.*
import io.ktor.server.response.*
import io.ktor.server.routing.*

fun main(args: Array<String>): Unit = io.ktor.server.netty.EngineMain.main(args)

fun Application.module() {
    routing {
        get("/") {
            call.respondText("Hello, world!")
        }
    }
}
ktor {
    deployment {
        port = 8080
    }
    application {
        modules = [ com.example.ApplicationKt.module ]
    }
}
yaml
ktor:
    deployment:
        port: 8080
    application:
        modules:
            - com.example.ApplicationKt.module
EngineMain.main()でサーバーを即座に起動する代わりに、EngineMain.createServer()を使用して手動でサーバーインスタンスを作成することもできます。詳細については、を参照してください。

完全な例については、 engine-main および engine-main-yaml を参照してください。

サーブレット

Ktorアプリケーションは、TomcatやJettyを含むサーブレットコンテナ内で実行およびデプロイできます。 サーブレットコンテナ内にデプロイするには、 WARWARアーカイブを使用して、サーブレットコンテナ内でKtorアプリケーションを実行およびデプロイする方法を学びます。 アーカイブを生成し、それをサーバーまたはWARをサポートするクラウドサービスにデプロイする必要があります。