コードによる設定
Ktorでは、ホストアドレス、ポート、サーバーモジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。など、さまざまなサーバーパラメータをコード内で直接設定できます。設定方法は、サーバーのセットアップ方法(embeddedServerまたはEngineMainアプリケーションのデプロイのニーズに応じてサーバーを作成する方法を学びます。のどちらを使用するか)によって異なります。
embeddedServerを使用する場合、必要なパラメータを関数に直接渡すことでサーバーを設定します。 embeddedServer 関数は、サーバーエンジンネットワークリクエストを処理するエンジンについて学びます。、サーバーがリッスンするホストとポート、および追加の設定など、サーバーを構成するためのさまざまなパラメータを受け取ります。
このセクションでは、サーバーを効果的に設定する方法を示すために、embeddedServerを実行するいくつかの異なる例を見ていきます。
基本設定
以下のコードスニペットは、Nettyエンジンと8080ポートを使用した基本的なサーバーセットアップを示しています。
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>) {
embeddedServer(Netty, port = 8080) {
routing {
get("/") {
call.respondText("Hello, world!")
}
}
}.start(wait = true)
}portパラメータを0に設定すると、サーバーをランダムなポートで実行できることに注意してください。 embeddedServer関数はエンジンインスタンスを返すため、 ApplicationEngine.resolvedConnectors 関数を使用してコード内でポート値を取得できます。
エンジン設定
embeddedServer関数では、configureパラメータを使用してエンジン固有のオプションを渡すことができます。このパラメータには、すべてのエンジンに共通で、 ApplicationEngine.Configuration クラスによって公開されているオプションが含まれます。
以下の例は、Nettyエンジンを使用してサーバーを設定する方法を示しています。 configureブロック内で、connectorを定義してホストとポートを指定し、さまざまなサーバーパラメータをカスタマイズしています。
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>) {
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)
}connectors.add()メソッドは、指定されたホスト(127.0.0.1)とポート(8080)でコネクタを定義します。
これらのオプションに加えて、他のエンジン固有のプロパティを設定することもできます。
Netty
Netty固有のオプションは、 NettyApplicationEngine.Configuration クラスによって公開されています。
import io.ktor.server.engine.*
import io.ktor.server.netty.*
fun main() {
embeddedServer(Netty, configure = {
requestQueueLimit = 16
shareWorkGroup = false
configureBootstrap = {
// ...
}
responseWriteTimeoutSeconds = 10
}) {
// ...
}.start(true)
}Jetty
Jetty固有のオプションは、 JettyApplicationEngineBase.Configuration クラスによって公開されています。
configureServer ブロック内でJettyサーバーを設定できます。これにより、 Server インスタンスにアクセスできます。
idleTimeoutプロパティを使用して、接続が閉じられるまでにアイドル状態を維持できる期間を指定します。
import io.ktor.server.engine.*
import io.ktor.server.jetty.jakarta.*
fun main() {
embeddedServer(Jetty, configure = {
configureServer = { // this: Server ->
// ...
}
idleTimeout = 30.seconds
}) {
// ...
}.start(true)
}CIO
CIO固有のオプションは、 CIOApplicationEngine.Configuration クラスによって公開されています。
import io.ktor.server.engine.*
import io.ktor.server.cio.*
fun main() {
embeddedServer(CIO, configure = {
connectionIdleTimeoutSeconds = 45
}) {
// ...
}.start(true)
}Tomcat
エンジンとしてTomcatを使用する場合、 configureTomcat プロパティを使用して設定できます。これにより、 Tomcat インスタンスにアクセスできます。
import io.ktor.server.engine.*
import io.ktor.server.tomcat.jakarta.*
fun main() {
embeddedServer(Tomcat, configure = {
configureTomcat = { // this: Tomcat ->
// ...
}
}) {
// ...
}.start(true)
}カスタム環境
以下の例は、 ApplicationEngine.Configuration クラスで表されるカスタム設定を使用して、複数のコネクタエンドポイントでサーバーを実行する方法を示しています。
import io.ktor.server.application.*
import io.ktor.server.response.*
import io.ktor.server.routing.*
import io.ktor.server.engine.*
import io.ktor.server.netty.*
fun main() {
val appProperties = serverConfig {
module { module() }
}
embeddedServer(Netty, appProperties) {
envConfig()
}.start(true)
}
fun ApplicationEngine.Configuration.envConfig() {
connector {
host = "0.0.0.0"
port = 8080
}
connector {
host = "127.0.0.1"
port = 9090
}
}完全な例については、 embedded-server-multiple-connectors を参照してください。
カスタム環境を使用して HTTPSを提供 することもできます。
コマンドライン設定
Ktorでは、コマンドライン引数を使用してembeddedServerを動的に設定できます。これは、ポート、ホスト、タイムアウトなどの設定を実行時に指定する必要がある場合に特に便利です。
これを実現するには、 CommandLineConfig クラスを使用してコマンドライン引数を設定オブジェクトにパースし、それを設定ブロック内で渡します。
fun main(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)
} この例では、Application.Configurationの takeFrom() 関数を使用して、portやhostなどのエンジン設定値を上書きしています。 loadCommonConfiguration() 関数は、タイムアウトなどのルート環境からの設定をロードします。
サーバーを実行するには、次のように引数を指定します。
./gradlew run --args="-port=8080"