添加服务器依赖项
在本主题中,我们将向您展示如何向现有的 Gradle/Maven 项目中添加 Ktor Server 所需的依赖项。
配置仓库
在添加 Ktor 依赖项之前,您需要为该项目配置仓库:
生产版
Ktor 的生产版本可在 Maven 中央仓库中获取。 您可以按如下方式在构建脚本中声明此仓库:
kotlinrepositories { mavenCentral() }groovyrepositories { mavenCentral() }您不需要在 pom.xml 文件中添加 Maven 中央仓库,因为您的项目会从 Super POM 继承该中央仓库。
抢先体验计划 (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 开发仓库:
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 使用 SLF4J API 作为各种日志框架(例如 Logback 或 Log4j)的门面,并允许您记录应用程序事件。 要了解如何添加所需的构件,请参阅添加记录器依赖项。
插件依赖项
扩展 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
