依赖项解析

必需依赖项：io.ktor:ktor-server-di

代码示例： server-di

在您注册依赖项后，可以从依赖注入 (DI) 容器中解析它们并将其注入到应用程序代码中。

您可以使用属性委托或直接解析从 DI 容器中显式解析依赖项。

使用属性委托

使用属性委托时，依赖项在首次访问属性时延迟解析：

val service: GreetingService by dependencies

使用直接解析

直接解析会立即返回依赖项，或者挂起直到其可用：

val service = dependencies.resolve<GreetingService>()

形参解析

解析构造函数或函数时，Ktor 使用 DI 容器解析形参。默认情况下按类型解析形参。

如果基于类型的解析不足，可以使用注解显式绑定形参。

使用命名依赖项

使用 @Named 注解解析以指定名称注册的依赖项：

fun Application.userRepository(@Named("mongo") database: Database) {
    // 使用名为 "mongo" 的依赖项
}

使用配置属性

使用 @Property 注解从应用程序配置中注入值：

package com.example

import io.ktor.server.plugins.di.annotations.Property

fun provideDatabase(
    @Property("database.connectionUrl") connectionUrl: String
): Database = PostgresDatabase(connectionUrl)

open class UserRepository(val db: Database)

在上述示例中，database.connectionUrl 属性从应用程序配置中解析：

application.yaml

database:
  connectionUrl: postgres://localhost:5432/admin

异步依赖项解析

为了支持异步加载，可以使用挂起函数：

data class EventsConnection(val connected: Boolean)

suspend fun Application.installEvents() {
    val conn: EventsConnection = dependencies.resolve()
    log.info("Events connection ready: $conn")
}

suspend fun Application.loadEventsConnection() {
    dependencies.provide {
        delay(200) // 模拟异步工作
        EventsConnection(true)
    }
}

DI 插件将自动挂起 resolve() 调用，直到所有依赖项准备就绪。

将依赖项注入到应用程序模块

您可以通过在模块函数中指定形参，直接将依赖项注入到应用程序模块中。Ktor 将根据类型匹配从 DI 容器中解析这些依赖项。

首先，在配置文件中的 ktor.application.dependencies 组中注册您的依赖项提供程序：

application.yaml

ktor:
  application:
    dependencies:
      - com.example.PrintStreamProviderKt.stdout
    modules:
      - com.example.LoggingKt.logging

为您想要注入的依赖项定义带有形参的依赖项提供程序和模块函数。然后，您可以直接在模块函数中使用注入的依赖项：

PrintStreamProvider.ktLogging.kt

package com.example

import java.io.PrintStream

fun stdout(): () -> PrintStream = { System.out }

package com.example

import io.ktor.server.application.*
import io.ktor.server.plugins.di.dependencies
import java.io.PrintStream

class Logger(private val out: PrintStream) {
     fun log(message: String) {
        out.println("[LOG] $message")
    }
}

fun Application.logging(printStreamProvider: () -> PrintStream) {
    dependencies {
        provide<Logger> {
            Logger(printStreamProvider())
        }
    }
}

高级依赖项解析

可选和可空依赖项

使用可空类型优雅地处理可选依赖项：

// 使用属性委托
val config: Config? by dependencies

// 使用直接解析
val config = dependencies.resolve<Config?>()

协变泛型

Ktor 的 DI 系统支持类型协变，这允许在类型形参协变时将值作为其超类型之一进行注入。这对于处理子类型的集合和接口特别有用。

dependencies {
  provide<List<String>> { listOf("one", "two") }
}

// 由于支持类型形参协变，这将可以工作
val stringList: List<CharSequence> by dependencies
// 这也可以工作
val stringCollection: Collection<CharSequence> by dependencies

协变也适用于非泛型超类型：

dependencies {
    provide<BufferedOutputStream> { BufferedOutputStream(System.out) }
}

// 这可以工作，因为 BufferedOutputStream 是 OutputStream 的子类型
val outputStream: OutputStream by dependencies

局限性

虽然 DI 系统支持泛型类型的协变，但目前不支持跨类型参数子类型解析参数化类型。这意味着您无法使用比注册类型更具体或更宽泛的类型来检索依赖项。

例如，以下代码将无法解析：

dependencies {
    provide<Sink<CharSequence>> { CsqSink() }
}

// 将无法解析
val charSequenceSink: Sink<String> by dependencies