Ktor

Ktor 是一个用于使用强大的 Kotlin 编程语言在连接系统中构建异步服务器和客户端的框架。我们在这里将使用 Ktor 来构建一个简单的 Web 应用程序。

开始吧 🚀

NOTE

更新 - 2024-10-21

获取代码

INFO

源代码可在 Github 上获取

Gradle 设置

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

dependencies {
    // 适用于 Kotlin 应用程序的 Koin
    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 {
    
}

让我们声明我们的第一个组件。我们希望通过创建 UserRepositoryImpl 的实例来获得 UserRepository 的单例 (singleton)。

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 控制器来创建 HTTP 路由 (Route)。在 Ktor 中，这将通过 Ktor 扩展函数 (extension function) 来表达：

fun Application.main() {

    // 惰性注入 HelloService
    val service by inject<UserService>()

    // 路由部分
    routing {
        get("/hello") {
            call.respondText(service.sayHello())
        }
    }
}

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

ktor {
    deployment {
        port = 8080

        // 仅用于开发目的
        //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)
    }

    // 惰性注入 HelloService
    val service by inject<UserService>()
    service.saveDefaultUsers()

    // 路由部分
    routing {
        get("/hello") {
            call.respondText(service.sayHello())
        }
    }
}

让我们启动 Ktor：

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

就是这样！你已准备就绪。检查 http://localhost:8080/hello 这个 URL！