Skip to content

DSL 레퍼런스 ​

이 페이지는 모든 Koin DSL 키워드를 표로 정리하고, 임포트할 패키지와 이를 설명하는 페이지 링크를 제공합니다. 컴파일러 플러그인 DSL(Compiler Plugin DSL), 생성자 DSL(Constructor DSL, 생성자 참조), 클래식 DSL(Classic DSL, 람다)의 세 가지 DSL 형태를 다룹니다. 애너테이션에 대해서는 애너테이션 레퍼런스를 참조하세요.

DSL 스타일 ​

스타일예제임포트
컴파일러 플러그인 DSLsingle<UserRepository>()org.koin.plugin.module.dsl.*
생성자 DSLsingleOf(::UserRepository)org.koin.core.module.dsl.*
클래식 DSLsingle { UserRepository(get()) }org.koin.dsl.*

컴파일러 플러그인 DSL을 사용하려면 Koin 컴파일러 플러그인이 필요합니다. 이 플러그인은 생성자를 분석하고, get() 호출을 생성하며, 빌드 시점에 의존성 그래프를 검증합니다. 플러그인이 없으면 single<T>()와 같은 호출 시 런타임에 다음 오류가 발생합니다: Error while using 'single<T>()'. The Koin Compiler plugin is missing. Please fix your setup to use 'io.insert-koin.compiler.plugin' Koin Gradle Plugin.

생성자 참조 형태(singleOf(::T)) 또한 컴파일러 플러그인이 적용되면 검증을 거칩니다. 직접 작성한 람다는 검증되지 않습니다. 플러그인은 람다 본문이 수행하는 작업이 아니라 제공하는 타입만을 추적하기 때문입니다. 스타일을 선택하는 방법은 스타일 선택하기를 참조하세요.

Application DSL ​

Koin 컨테이너를 생성하고 시작하는 함수입니다. Koin 시작하기를 참조하세요.

함수패키지기능 설명
startKoin { }org.koin.core.contextKoinApplication을 생성하고 글로벌 컨텍스트에 등록합니다. 이미 시작된 경우 KoinApplicationAlreadyStartedException을 발생시킵니다
startKoin<T>()org.koin.plugin.module.dsl컴파일러 플러그인: @KoinApplication 클래스 T의 모듈로 Koin을 시작합니다
koinApplication { }org.koin.dsl글로벌에 등록되지 않는 독립형(standalone) KoinApplication을 생성합니다. 컨텍스트 격리(Context Isolation)를 참조하세요
koinApplication<T>()org.koin.plugin.module.dsl컴파일러 플러그인: T의 모듈을 사용하는 독립형 애플리케이션입니다
koinConfiguration { }org.koin.dslKoin을 시작하지 않고 재사용 가능한 KoinConfiguration을 선언합니다
koinConfiguration<T>()org.koin.plugin.module.dsl컴파일러 플러그인: T의 모듈을 사용하는 설정입니다
stopKoin()org.koin.core.context글로벌 컨테이너와 모든 인스턴스를 닫습니다
loadKoinModules(module)org.koin.core.context시작된 글로벌 컨테이너에 모듈을 로드합니다
unloadKoinModules(module)org.koin.core.context모듈을 언로드하고 해당 인스턴스를 제거합니다

startKoin { } 및 koinApplication { } 내부 ​

함수기능 설명
modules(...)모듈을 로드합니다: 하나의 Module, 가변 인자(vararg) 또는 List<Module>
modules(UserModule::class, ...)컴파일러 플러그인: @Module 클래스로부터 생성된 모듈을 로드합니다
module<UserModule>()컴파일러 플러그인: 하나의 @Module 클래스로부터 생성된 모듈을 로드합니다
withConfiguration<T>()컴파일러 플러그인: @KoinApplication 클래스 T의 모듈을 기존 애플리케이션에 추가합니다
includes(configuration)하나 이상의 KoinConfiguration 또는 KoinAppDeclaration 블록을 적용합니다
printLogger(level)표준 출력으로 로그를 남깁니다. 기본 레벨은 Level.INFO입니다
logger(logger)사용자 정의 Logger 구현체를 사용합니다. 기본값은 EmptyLogger(출력 없음)입니다
properties(map)Map<String, Any>로부터 프로퍼티를 로드합니다
fileProperties(fileName)JVM 전용. 파일로부터 프로퍼티를 로드합니다. 기본값은 /koin.properties입니다
environmentProperties()JVM 전용. 시스템 프로퍼티와 환경 변수를 로드합니다
allowOverride(Boolean)정의 오버라이드(override)를 허용하거나 금지합니다. 기본값은 true입니다. 정의(Definitions)를 참조하세요
createEagerInstances()createdAtStart 정의들을 생성합니다. startKoin 및 koinApplication에서 이미 호출됩니다
options(...)viewModelScopeFactory()와 같은 Koin 옵션을 설정합니다. ViewModel을 참조하세요
lazyModules(...)백그라운드에서 지연 로딩 모듈(lazy modules)을 로드합니다(koin-core-coroutines). 지연 모듈(Lazy Modules)을 참조하세요

modules(A::class), module<T>(), withConfiguration<T>()는 startKoin<T> { } 내부가 아니라 일반 startKoin { } 또는 koinApplication { }에 작성합니다.

플랫폼 확장 기능은 이 블록에 추가 함수를 제공합니다:

함수아티팩트참고
androidContext(context), androidLogger(level), androidFileProperties()koin-androidAndroid 시작
fragmentFactory()koin-androidFragment Factory
workManagerFactory()koin-androidx-workmanagerWorkManager
slf4jLogger(level)koin-logger-slf4jKtor

Module DSL ​

모듈(Modules) 및 지연 모듈(Lazy Modules)을 참조하세요.

함수패키지기능 설명
module { }org.koin.dsl모듈을 선언합니다
module(createdAtStart = true) { }org.koin.dsl모듈의 모든 single이 시작 시점에 생성됩니다
lazyModule { }org.koin.dsl나중에 백그라운드에서 로드되는 모듈을 선언합니다(koin-core-coroutines)
includes(otherModule, ...)org.koin.dsl다른 모듈들을 가변 인자(vararg) 또는 Collection<Module> 형태로 포함합니다
moduleA + moduleBorg.koin.dslList<Module>을 생성합니다

정의 (Definitions) ​

각 키워드가 무엇을 생성하는지는 정의(Definitions)에 설명되어 있습니다.

정의컴파일러 플러그인 DSL생성자 DSL클래식 DSL
Singlesingle<T>()singleOf(::T)single { T(get()) }
Factoryfactory<T>()factoryOf(::T)factory { T(get()) }
Scoped (스코프 블록 내부)scoped<T>()scopedOf(::T)scoped { T(get()) }
ViewModelviewModel<T>()viewModelOf(::T)viewModel { T(get()) }
Worker (Android)worker<T>()workerOf(::T)worker { T(get(), get()) }
Fragment (Android)지원되지 않음fragmentOf(::T)fragment { T(get()) }
함수 또는 빌더single { create(::buildT) }singleOf(::buildT)single { buildT(get()) }

패키지:

키워드컴파일러 플러그인 DSL생성자 / 클래식 DSL
single, factory, scoped, createorg.koin.plugin.module.dslorg.koin.dsl (람다), org.koin.core.module.dsl (singleOf, factoryOf, scopedOf, new)
viewModel, viewModelOf (아티팩트: koin-core-viewmodel)org.koin.plugin.module.dslorg.koin.core.module.dsl
worker, workerOf (아티팩트: koin-androidx-workmanager)org.koin.plugin.module.dslorg.koin.androidx.workmanager.dsl
fragment, fragmentOf (아티팩트: koin-android)org.koin.androidx.fragment.dsl

org.koin.androidx.viewmodel.dsl 및 org.koin.compose.viewmodel.dsl의 viewModel과 viewModelOf는 지원 중단(deprecated)되었습니다. org.koin.core.module.dsl에서 임포트하세요.

create(::buildT)는 람다 내의 유일한 명령문이어야 합니다. 그렇지 않으면 컴파일러 플러그인에서 create(::buildT) must be the only instruction in the lambda. 오류를 보고합니다. 정의(Definitions)를 참조하세요.

람다 매개변수 ​

람다 정의는 다음과 같은 시그니처를 갖습니다:

키워드매개변수
single(qualifier, createdAtStart) { }qualifier: Qualifier? = null, createdAtStart: Boolean = false
factory(qualifier) { }qualifier: Qualifier? = null
scoped(qualifier) { }qualifier: Qualifier? = null
viewModel(qualifier) { }qualifier: Qualifier? = null
worker(qualifier) { }qualifier: Qualifier = named<T>()

정의 람다 내부 ​

이 람다는 Scope 수신 객체와 ParametersHolder 인수(params)를 사용하여 실행됩니다:

함수반환값참고
get<T>(), get<T>(qualifier)인스턴스. 누락된 경우 NoDefinitionFoundException 발생주입(Injection)
getOrNull<T>()인스턴스 또는 null주입(Injection)
inject<T>()Lazy<T>주입(Injection)
getAll<T>()T에 바인딩된 모든 인스턴스고급 패턴(Advanced Patterns)
getProperty(key), getProperty(key, default), getPropertyOrNull(key)Koin 프로퍼티Koin 시작하기
params.get<T>(), (id) -> ... 구조 분해 할당주입된 매개변수주입 매개변수(Injected Parameters)
new(::T)모든 생성자 매개변수가 get()을 통해 해결된 새로운 T
create(::T)컴파일러 플러그인: 동일한 기능 및 빌드 타임 검증 제공정의(Definitions)
getSource<T>()스코프 소스(source) 객체스코프(Scopes)
androidContext(), androidApplication()Android Context 또는 ApplicationAndroid 시작

정의 옵션 ​

옵션은 정의 뒤에 중위(infix) 연산자를 사용하거나 withOptions { } 블록 내에서 적용됩니다. 모든 정의 키워드에서 동작합니다.

옵션형태기능 설명참고
bindsingle<T>() bind I::class보조(secondary) 타입을 추가합니다정의(Definitions)
bindssingle<T>() binds arrayOf(I::class, J::class)여러 보조 타입을 추가합니다정의(Definitions)
onClosesingle<T>() onClose { it?.close() }인스턴스가 해제될 때 실행되는 콜백정의(Definitions)
withOptions { }single<T>() withOptions { ... }아래의 옵션 블록을 엽니다
.override()single<T> { ... }.override()allowOverride(false)가 설정되어 있을 때 허용된 오버라이드로 표시합니다정의(Definitions)

withOptions { } 내부나 singleOf(::T) { }, factoryOf, scopedOf, viewModelOf의 후행 블록에서 사용 가능한 옵션:

옵션기능 설명
named("name")문자열 한정자(qualifier). 한정자(Qualifiers)를 참조하세요
named<Type>()타입 한정자
bind<I>()보조 타입을 추가합니다
binds(listOf(I::class, J::class))여러 보조 타입을 추가합니다
createdAtStart()Koin이 시작될 때 single을 생성합니다
onClose { }해제(release) 콜백
kotlin
val appModule = module {
    single<UserRepositoryImpl>() withOptions {
        named("local")
        bind<UserRepository>()
        createdAtStart()
    }

    // Constructor DSL
    singleOf(::UserRepositoryImpl) {
        named("local")
        bind<UserRepository>()
    }
}

Scope DSL ​

스코프 블록은 스코프의 수명 주기 동안 유지되는 정의들을 그룹화합니다. 스코프(Scopes)를 참조하세요.

함수패키지기능 설명
scope<T> { }Module 멤버타입 T로 식별되는 스코프(일반적으로 스코프 소스의 타입)
scope(named("session")) { }Module 멤버한정자로 식별되는 스코프

스코프 블록 내부:

정의컴파일러 플러그인 DSL생성자 DSL클래식 DSL
Scopedscoped<T>()scopedOf(::T)scoped { T(get()) }
Factoryfactory<T>()factoryOf(::T)factory { T(get()) }
ViewModelviewModel<T>()viewModelOf(::T)viewModel { T(get()) }
Worker (Android)worker<T>()workerOf(::T)worker { T(get(), get()) }
kotlin
val sessionModule = module {
    scope<UserSession> {
        scoped<SessionCache>()
        factory<SessionPresenter>()
    }
}

스코프 아키타입 (Scope archetypes) ​

아키타입(archetype)은 단일 클래스가 아니라 특정 스코프 소스 유형을 위한 스코프 블록입니다. 해당 유형의 모든 소스는 해당 정의들을 공유합니다.

함수아티팩트스코프 대상참고
viewModelScope { }koin-core-viewmodel각 ViewModelViewModel
activityScope { }koin-android각 ActivityAndroid 스코프
activityRetainedScope { }koin-android구성 변경(configuration changes) 시에도 유지되는 각 ActivityAndroid 스코프
fragmentScope { }koin-android각 FragmentAndroid 스코프
navigationScope { }koin-compose-viewmodel-navigation각 내비게이션 목적지(NavBackStackEntry)Compose 스코프
requestScope { }koin-ktor각 Ktor 호출(call)Ktor 스코프