Koin DSL

Kotlin 언어의 강력한 기능 덕분에 Koin은 애플리케이션에 어노테이션을 추가하거나 코드를 생성하는 대신 DSL을 통해 애플리케이션을 설명할 수 있도록 도와줍니다. Koin은 Kotlin DSL을 통해 의존성 주입을 준비하기 위한 스마트한 기능적 API를 제공합니다.

Application & Module DSL

Koin은 Koin Application의 요소를 설명할 수 있도록 다음과 같은 여러 키워드를 제공합니다.

• Application DSL: Koin 컨테이너 구성 설명
• Module DSL: 주입해야 하는 컴포넌트 설명

Application DSL

KoinApplication 인스턴스는 Koin 컨테이너 인스턴스 구성입니다. 이를 통해 로깅, 속성 로딩 및 모듈을 구성할 수 있습니다.

새로운 KoinApplication을 빌드하려면 다음 함수를 사용하십시오.

• koinApplication { } - KoinApplication 컨테이너 구성 생성
• startKoin { } - KoinApplication 컨테이너 구성을 생성하고 GlobalContext에 등록하여 GlobalContext API를 사용할 수 있도록 함

KoinApplication 인스턴스를 구성하려면 다음 함수 중 하나를 사용할 수 있습니다.

• logger( ) - 사용할 로거 구현 및 레벨 설명 (기본적으로 EmptyLogger 사용)
• modules( ) - 컨테이너에 로드할 Koin 모듈 목록 설정 (list 또는 vararg list)
• properties() - HashMap 속성을 Koin 컨테이너에 로드
• fileProperties( ) - 지정된 파일에서 Koin 컨테이너로 속성 로드
• environmentProperties( ) - OS 환경에서 Koin 컨테이너로 속성 로드
• createEagerInstances() - eager 인스턴스 생성 (createdAtStart로 표시된 Single 정의)

KoinApplication 인스턴스: Global vs Local

위에서 볼 수 있듯이 Koin 컨테이너 구성을 koinApplication 또는 startKoin 함수라는 두 가지 방법으로 설명할 수 있습니다.

• koinApplication Koin 컨테이너 인스턴스 설명
• startKoin Koin 컨테이너 인스턴스를 설명하고 Koin GlobalContext에 등록

컨테이너 구성을 GlobalContext에 등록하면 글로벌 API에서 직접 사용할 수 있습니다. 모든 KoinComponent는 Koin 인스턴스를 참조합니다. 기본적으로 GlobalContext의 인스턴스를 사용합니다.

자세한 내용은 Custom Koin instance 장을 확인하십시오.

Starting Koin

Koin을 시작한다는 것은 KoinApplication 인스턴스를 GlobalContext에서 실행한다는 의미입니다.

모듈을 사용하여 Koin 컨테이너를 시작하려면 다음과 같이 startKoin 함수를 사용할 수 있습니다.

// start a KoinApplication in Global context
startKoin {
    // declare used logger
    logger()
    // declare used modules
    modules(coffeeAppModule)
}

Module DSL

Koin 모듈은 애플리케이션에 주입/결합할 정의를 수집합니다. 새 모듈을 만들려면 다음 함수를 사용하십시오.

• module { // module content } - Koin 모듈 생성

모듈에서 콘텐츠를 설명하려면 다음 함수를 사용할 수 있습니다.

• factory { //definition } - 팩토리 빈 정의 제공
• single { //definition } - 싱글톤 빈 정의 제공 (별칭 bean으로도 사용 가능)
• get() - 컴포넌트 종속성 해결 (이름, 스코프 또는 매개변수도 사용할 수 있음)
• bind() - 지정된 빈 정의에 바인딩할 유형 추가
• binds() - 지정된 빈 정의에 바인딩할 유형 배열 추가
• scope { // scope group } - scoped 정의에 대한 논리적 그룹 정의
• scoped { //definition }- 스코프에만 존재하는 빈 정의 제공

참고: named() 함수를 사용하면 문자열, enum 또는 유형으로 한정자(qualifier)를 지정할 수 있습니다. 정의에 이름을 지정하는 데 사용됩니다.

Writing a module

Koin 모듈은 모든 컴포넌트를 선언하는 공간입니다. module 함수를 사용하여 Koin 모듈을 선언하십시오.

val myModule = module {
   // your dependencies here
}

이 모듈에서 아래 설명된 대로 컴포넌트를 선언할 수 있습니다.

withOptions - DSL 옵션 (3.2부터)

새로운 Constructor DSL 정의와 마찬가지로 withOptions 연산자를 사용하여 "일반적인" 정의에 대한 정의 옵션을 지정할 수 있습니다.

module {
    single { ClassA(get()) } withOptions { 
        named("qualifier")
        createdAtStart()
    }
}

이 옵션 람다 내에서 다음 옵션을 지정할 수 있습니다.

• named("a_qualifier") - 정의에 String 한정자(qualifier) 부여
• named<MyType>() - 정의에 Type 한정자(qualifier) 부여
• bind<MyInterface>() - 지정된 빈 정의에 바인딩할 유형 추가
• binds(arrayOf(...)) - 지정된 빈 정의에 바인딩할 유형 배열 추가
• createdAtStart() - Koin 시작 시 단일 인스턴스 생성