実行
Ktor サーバーアプリケーションを実行する際は、以下の点に注意してください。
- サーバーを作成する方法は、パッケージ化された Ktor アプリケーションを実行する際にコマンドライン引数を渡してサーバーパラメータを上書きできるかどうかに影響します。
- EngineMain を使用してサーバーを起動する場合、Gradle/Maven のビルドスクリプトでメインクラス名を指定する必要があります。
- アプリケーションをサーブレットコンテナ内で実行するには、特定のサーブレット設定が必要です。
このトピックでは、これらの設定の詳細を確認し、IntelliJ IDEA 内やパッケージ化されたアプリケーションとして Ktor アプリケーションを実行する方法を説明します。
設定の詳細
設定: コード vs 設定ファイル
Ktor アプリケーションの実行方法は、サーバーを作成した方法(embeddedServer または EngineMain)によって異なります。
embeddedServerの場合、サーバーパラメータ(ホストアドレスやポートなど)はコード内で設定されるため、アプリケーションの実行時にこれらのパラメータを変更することはできません。EngineMainの場合、Ktor はHOCONまたはYAML形式を使用した外部ファイルから設定を読み込みます。このアプローチを使用すると、コマンドラインからパッケージ化されたアプリケーションを実行し、対応するコマンドライン引数を渡すことで必要なサーバーパラメータを上書きできます。
EngineMain の起動: Gradle と Maven の詳細
サーバーの作成に EngineMain を使用する場合、目的のエンジンでサーバーを起動するための main 関数を指定する必要があります。 以下の例は、Netty エンジンでサーバーを実行するために使用される main 関数を示しています。
fun main(args: Array<String>): Unit = io.ktor.server.netty.EngineMain.main(args)main 関数の内部でエンジンを設定せずに Gradle/Maven を使用して Ktor サーバーを実行するには、ビルドスクリプトで次のようにメインクラス名を指定する必要があります。
application {
mainClass.set("io.ktor.server.netty.EngineMain")
}mainClassName = "io.ktor.server.netty.EngineMain"<properties>
<main.class>io.ktor.server.netty.EngineMain</main.class>
</properties>WAR の詳細
Ktor では、アプリケーション内で目的のエンジン(Netty、Jetty、Tomcat など)を使用してサーバーを作成および起動できます。この場合、アプリケーションがエンジンの設定、接続、および SSL オプションを制御します。
このアプローチとは対照的に、サーブレットコンテナがアプリケーションのライフサイクルと接続設定を制御する必要があります。Ktor は、アプリケーションの制御をサーブレットコンテナに委譲する特別な ServletApplicationEngine エンジンを提供しています。アプリケーションの設定方法については、War プラグインの設定を参照してください。
アプリケーションの実行
開発中のサーバーの再起動には時間がかかる場合があります。Ktor では、コードの変更時にアプリケーションクラスをリロードして高速なフィードバックループを提供する自動リロードを使用することで、この制限を克服できます。
Gradle/Maven を使用したアプリケーションの実行
Gradle または Maven を使用して Ktor アプリケーションを実行するには、対応するプラグインを使用します。
- Gradle の場合は Application プラグイン。Native サーバーの場合は Kotlin Multiplatform プラグインを使用します。
- Maven の場合は Exec プラグイン。
IntelliJ IDEA で Ktor アプリケーションを実行する方法については、IntelliJ IDEA ドキュメントの Ktor アプリケーションの実行 セクションを参照してください。
パッケージ化されたアプリケーションの実行
アプリケーションをデプロイする前に、パッケージ化セクションで説明されているいずれかの方法でパッケージ化する必要があります。 生成されたパッケージから Ktor アプリケーションを実行する方法はパッケージの種類によって異なり、次のようになります。
fat JAR にパッケージ化された Ktor サーバーを実行し、設定されたポートを上書きするには、次のコマンドを実行します:
Bashjava -jar sample-app.jar -port=8080Gradle の Application プラグインを使用してパッケージ化されたアプリケーションを実行するには、対応する実行可能ファイルを実行します:
./ktor-samplektor-sample.batサーブレットの Ktor アプリケーションを実行するには、Gretty プラグインの
runタスクを使用します。
