Ktor

Ktor 是一个使用强大的 Kotlin 编程语言，在互联系统中构建异步服务器和客户端的框架。 我们将在此处使用 Ktor 构建一个简单的 Web 应用程序。

让我们开始吧 🚀

备注

更新 - 2024-10-21

获取代码

信息

源代码可在 Github 上找到

Gradle 设置

首先，添加 Koin 依赖，如下所示：

dependencies {
    // Koin for Kotlin apps
    implementation("io.insert-koin:koin-ktor:$koin_version")
    implementation("io.insert-koin:koin-logger-slf4j:$koin_version")
}

应用概述

该应用程序的想法是管理一个用户列表，并在我们的 UserApplication 类中显示它：

Users -> UserRepository -> UserService -> UserApplication

“用户”数据

我们将管理一个用户集合。 这是数据类：

data class User(val name : String)

我们创建一个“Repository”（仓库）组件来管理用户列表（添加用户或按名称查找用户）。 下面是 UserRepository 接口及其实现：

interface UserRepository {
    fun findUser(name : String): User?
    fun addUsers(users : List<User>)
}

class UserRepositoryImpl : UserRepository {

    private val _users = arrayListOf<User>()

    override fun findUser(name: String): User? {
        return _users.firstOrNull { it.name == name }
    }

    override fun addUsers(users : List<User>) {
        _users.addAll(users)
    }
}

Koin 模块

使用 module 函数来声明一个 Koin 模块。 Koin 模块是我们定义所有要注入的组件的地方。

val appModule = module {
    
}

让我们声明我们的第一个组件。 我们想要一个 UserRepository 的单例，通过创建 UserRepositoryImpl 的实例：

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
}

UserService 组件

让我们编写 UserService 组件来请求默认用户：

class UserService(private val userRepository: UserRepository) {

    fun getDefaultUser() : User = userRepository.findUser(DefaultData.DEFAULT_USER.name) ?: error("Can't find default user")
}

UserRepository 在 UserPresenter 的构造函数中被引用

我们在 Koin 模块中声明 UserService。 我们将其声明为 singleOf 定义：

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
    singleOf(::UserService)
}

HTTP 控制器

最后，我们需要一个 HTTP Controller 来创建 HTTP 路由。 在 Ktor 中，它将通过 Ktor 扩展函数来表达：

fun Application.main() {

    // Lazy inject HelloService
    val service by inject<UserService>()

    // Routing section
    routing {
        get("/hello") {
            call.respondText(service.sayHello())
        }
    }
}

检查您的 application.conf 是否配置如下，以帮助启动 Application.main 函数：

ktor {
    deployment {
        port = 8080

        // For dev purpose
        //autoreload = true
        //watch = [org.koin.sample]
    }

    application {
        modules = [ org.koin.sample.UserApplicationKt.main ]
    }
}

声明您的依赖项

让我们用一个 Koin 模块组装我们的组件：

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
    singleOf(::UserService)
}

启动并注入

最后，让我们从 Ktor 启动 Koin：

fun Application.main() {
    install(Koin) {
        slf4jLogger()
        modules(appModule)
    }

    // Lazy inject HelloService
    val service by inject<UserService>()
    service.saveDefaultUsers()

    // Routing section
    routing {
        get("/hello") {
            call.respondText(service.sayHello())
        }
    }
}

让我们启动 Ktor：

fun main(args: Array<String>) {
    // Start Ktor
    embeddedServer(Netty, commandLineEnvironment(args)).start(wait = true)
}

就这样！ 你准备好了。 检查 http://localhost:8080/hello url!