サーバーの依存関係の追加
このトピックでは、既存のGradle/MavenプロジェクトにKtorサーバーに必要な依存関係を追加する方法を説明します。
リポジトリの設定
Ktorの依存関係を追加する前に、このプロジェクトのリポジトリを設定する必要があります。
プロダクション
KtorのプロダクションリリースはMaven Centralリポジトリで利用可能です。 ビルドスクリプトで以下のようにこのリポジトリを宣言できます。
kotlinrepositories { mavenCentral() }groovyrepositories { mavenCentral() }プロジェクトはSuper POMからCentralリポジトリを継承しているため、pom.xmlファイルにMaven Centralリポジトリを追加する必要はありません。
早期アクセスプログラム (EAP)
KtorのEAPバージョンにアクセスするには、Spaceリポジトリを参照する必要があります。
kotlinrepositories { maven { url = uri("https://redirector.kotlinlang.org/maven/ktor-eap") } }groovyrepositories { maven { url "https://redirector.kotlinlang.org/maven/ktor-eap" } }xml<repositories> <repository> <id>ktor-eap</id> <url>https://redirector.kotlinlang.org/maven/ktor-eap</url> </repository> </repositories>KtorのEAPにはKotlin devリポジトリが必要になる場合があることに注意してください。
kotlinrepositories { maven { url = uri("https://redirector.kotlinlang.org/maven/dev") } }groovyrepositories { maven { url "https://redirector.kotlinlang.org/maven/dev" } }xml<repositories> <repository> <id>ktor-eap</id> <url>https://redirector.kotlinlang.org/maven/dev</url> </repository> </repositories>
依存関係の追加
コアの依存関係
すべてのKtorアプリケーションには、少なくとも以下の依存関係が必要です。
ktor-server-core: Ktorのコア機能が含まれています。エンジンネットワークリクエストを処理するエンジンについて学びます。(例:
ktor-server-netty)の依存関係。
プラットフォームごとに、Ktorは-jvmなどのサフィックスを持つプラットフォーム固有のアーティファクトを提供しています(例: ktor-server-core-jvm、ktor-server-netty-jvm)。 Gradleは指定されたプラットフォームに適したアーティファクトを解決しますが、Mavenはこの機能をサポートしていないことに注意してください。 つまり、Mavenの場合はプラットフォーム固有のサフィックスを手動で追加する必要があります。 基本的なKtorアプリケーションのdependenciesブロックは以下のようになります。
dependencies {
implementation("io.ktor:ktor-server-core:3.6.1")
implementation("io.ktor:ktor-server-netty:3.6.1")
}dependencies {
implementation "io.ktor:ktor-server-core:3.6.1"
implementation "io.ktor:ktor-server-netty:3.6.1"
}<dependencies>
<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-server-core-jvm</artifactId>
<version>3.6.1</version>
</dependency>
<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-server-netty-jvm</artifactId>
<version>3.6.1</version>
</dependency>
</dependencies>ロギングの依存関係
Ktorは、さまざまなロギングフレームワーク(例: LogbackやLog4j)のファサードとしてSLF4J APIを使用し、アプリケーションイベントをログに記録できるようにします。 必要なアーティファクトの追加方法については、ロガーの依存関係の追加を参照してください。
プラグインの依存関係
Ktorの機能を拡張するプラグインプラグインは、シリアライゼーション、コンテンツエンコーディング、圧縮などの一般的な機能を提供します。には、追加の依存関係が必要になる場合があります。 詳細については、対応するトピックを参照してください。
Ktorバージョンの整合性の確保
Ktor Gradleプラグインの使用
Ktor Gradleプラグインを適用すると、暗黙的にKtor BOMの依存関係が追加され、すべてのKtorの依存関係が同じバージョンであることを保証できます。 この場合、Ktorアーティファクトに依存する際にバージョンを指定する必要がなくなります。
plugins {
// ...
id("io.ktor.plugin") version "3.6.1"
}
dependencies {
implementation("io.ktor:ktor-server-core")
// ...
}plugins {
// ...
id "io.ktor.plugin" version "3.6.1"
}
dependencies {
implementation "io.ktor:ktor-server-core"
// ...
}公開されたバージョンカタログの使用
公開されたバージョンカタログを使用して、Ktorの依存関係の宣言を一元化することもできます。 このアプローチには以下の利点があります。
- 独自のカタログでKtorのバージョンを手動で宣言する必要がなくなります。
- すべてのKtorモジュールを単一の名前空間で公開します。
カタログを宣言するには、settings.gradle.ktsで任意の名前のバージョンカタログを作成します。
dependencyResolutionManagement {
versionCatalogs {
create("ktorLibs") {
from("io.ktor:ktor-version-catalog:3.6.1")
}
}
}その後、カタログ名を参照してモジュールのbuild.gradle.ktsに依存関係を追加できます。
dependencies {
implementation(ktorLibs.server.core)
// ...
}アプリケーション実行用のエントリポイントの作成
Gradle/Mavenを使用したKtorサーバーの実行Ktor サーバーアプリケーションを実行する方法を学びます。は、サーバーの作成アプリケーションのデプロイのニーズに応じてサーバーを作成する方法を学びます。方法に依存します。 アプリケーションのメインクラスは、次のいずれかの方法で指定できます。
embeddedServerを使用する場合、メインクラスを次のように指定します。
kotlinapplication { mainClass.set("com.example.ApplicationKt") }groovyapplication { mainClass = "com.example.ApplicationKt" }xml<properties> <main.class>com.example.ApplicationKt</main.class> </properties>EngineMainを使用する場合、それをメインクラスとして設定する必要があります。 Nettyの場合、以下のようになります。
kotlinapplication { mainClass.set("io.ktor.server.netty.EngineMain") }groovyapplication { mainClass = "io.ktor.server.netty.EngineMain" }xml<properties> <main.class>io.ktor.server.netty.EngineMain</main.class> </properties>
アプリケーションをFat JARとしてパッケージ化する場合は、対応するプラグインを設定する際にサーバーの作成方法も考慮する必要があります。 詳細については、以下のトピックを参照してください。
Ktor Gradleプラグインを使用したFat JARの作成Ktor Gradleプラグインを使用して実行可能なfat JARを作成および実行する方法を学びます。
Maven Assemblyプラグインを使用したFat JARの作成サンプルプロジェクト: tutorial-server-get-started-maven
