Ktor 中的依赖注入 (Dependency Injection)

koin-ktor 模块专门为 Ktor 带来依赖注入。

安装 Koin 插件

要在 Ktor 中启动 Koin 容器，只需安装 Koin 插件，如下所示：

fun Application.main() {
    // 安装 Koin
    install(Koin) {
        slf4jLogger()
        modules(helloAppModule)
    }

}

在 Ktor 中注入

Koin 的 inject() 和 get() 函数可以从 Application、Route、Routing 类中使用：

fun Application.main() {

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

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

从 Ktor 请求作用域解析 (since 4.1.0)

您可以声明组件存在于 Ktor 请求作用域的时间线中。为此，您只需要在 requestScope 部分中声明您的组件。给定一个 ScopeComponent 类在 Ktor Web 请求作用域上实例化，让我们声明它：

requestScope {
    scopedOf(::ScopeComponent)
}

并且从您的 http 调用中，只需调用 call.scope.get() 来解析正确的依赖项：

routing {
    get("/hello") {
        val component = call.scope.get<ScopeComponent>()
        // ... 
    }
}

备注

对于每个新请求，作用域将被重新创建。 这将为每个请求创建和删除作用域实例

从外部 Ktor 模块运行 Koin

对于 Ktor 模块，您可以加载特定的 Koin 模块。只需使用 koin { } 函数声明它们：

fun Application.module2() {

    koin {
        // 加载 koin 模块
        modules(appModule2)
    }

}

Ktor 事件

您可以监听 KTor Koin 事件：

fun Application.main() {
    // ...

    // 安装 Ktor 功能
    environment.monitor.subscribe(KoinApplicationStarted) {
        log.info("Koin started.")
    }

    environment.monitor.subscribe(KoinApplicationStopPreparing) {
        log.info("Koin stopping...")
    }

    environment.monitor.subscribe(KoinApplicationStopped) {
        log.info("Koin stopped.")
    }

    //...
}