의존성 해결

필수 의존성: io.ktor:ktor-server-di

코드 예제: server-di

의존성을 등록한 후, 의존성 주입(DI) 컨테이너에서 의존성을 해결(resolve)하고 애플리케이션 코드에 주입할 수 있습니다.

프로퍼티 위임 또는 직접 해결을 사용하여 DI 컨테이너에서 의존성을 명시적으로 해결할 수 있습니다.

프로퍼티 위임 사용

프로퍼티 위임을 사용하면 프로퍼티에 처음 접근할 때 의존성이 지연 해결(resolved lazily)됩니다.

val service: GreetingService by dependencies

직접 해결 사용

직접 해결은 의존성을 즉시 반환하거나, 해당 의존성을 사용할 수 있을 때까지 실행을 중단(suspend)합니다.

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

비동기 의존성 해결

비동기 로딩을 지원하기 위해 중단 함수(suspending functions)를 사용할 수 있습니다.

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 그룹에 의존성 제공자(dependency providers)를 등록합니다.

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())
        }
    }
}

고급 의존성 해결

선택 사항 및 Null 허용 의존성

선택적 의존성을 유연하게 처리하려면 null 허용(nullable) 타입을 사용하십시오.

// 프로퍼티 위임 사용
val config: Config? by dependencies

// 직접 해결 사용
val config = dependencies.resolve<Config?>()

공변 제네릭

Ktor의 DI 시스템은 타입 공변성(type covariance)을 지원하여, 타입 파라미터가 공변적일 때 값을 해당 상위 타입(supertypes) 중 하나로 주입할 수 있게 합니다. 이는 하위 타입(subtypes)과 함께 작동하는 컬렉션 및 인터페이스에 특히 유용합니다.

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 시스템은 제네릭 타입에 대한 공변성을 지원하지만, 현재 타입 인자의 하위 타입에 걸친 파라미터화된 타입(parameterized types)의 해결은 지원하지 않습니다. 즉, 등록된 것보다 더 구체적이거나 더 일반적인 타입을 사용하여 의존성을 가져올 수 없음을 의미합니다.

예를 들어, 다음 코드는 해결되지 않습니다.

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

// 해결되지 않음
val charSequenceSink: Sink<String> by dependencies