본문으로 건너뛰기

CheckModules - Koin 구성 확인 (더 이상 사용되지 않음)

경고

이 API는 Koin 4.0 이후로 더 이상 사용되지 않습니다.

Koin을 사용하면 구성 모듈을 검증하여 런타임 시 의존성 주입 문제를 발견하는 것을 방지할 수 있습니다.

Koin Dynamic Check - CheckModules()​

간단한 JUnit 테스트 내에서 checkModules() 함수를 호출합니다. 그러면 모듈이 시작되고 가능한 각 정의를 실행하려고 시도합니다.

class CheckModulesTest : KoinTest {

    @Test
    fun verifyKoinApp() {
        
        koinApplication {
            modules(module1,module2)
            checkModules()
        }
    }
}

checkKoinModules를 사용하는 것도 가능합니다.

class CheckModulesTest : KoinTest {

    @Test
    fun verifyKoinApp() {
        
        checkKoinModules(listOf(module1,module2))
    }
}

CheckModule DSL​

주입된 매개변수, 속성 또는 동적 인스턴스를 사용하는 모든 정의에 대해 checkModules DSL은 다음 경우에 어떻게 작동할지 지정할 수 있습니다.

  • withInstance(value) - value 인스턴스를 Koin 그래프에 추가합니다 (의존성 또는 매개변수로 사용 가능).

  • withInstance<MyType>() - MyType의 모의 (mock) 인스턴스를 추가합니다. MockProviderRule을 사용하세요. (의존성 또는 매개변수로 사용 가능).

  • withParameter<Type>(qualifier){ qualifier -> value } - value 인스턴스를 매개변수로 주입되도록 추가합니다.

  • withParameter<Type>(qualifier){ qualifier -> parametersOf(...) } - value 인스턴스를 매개변수로 주입되도록 추가합니다.

  • withProperty(key,value) - 속성을 Koin에 추가합니다.

Junit 규칙으로 모의 (mocking) 허용​

checkModules와 함께 모의를 사용하려면 MockProviderRule을 제공해야 합니다.

@get:Rule
val mockProvider = MockProviderRule.create { clazz ->
    // Mock with your framework here given clazz 
}

동적 동작으로 모듈 검증 (3.1.3 이상)​

다음과 같은 동적 동작을 검증하려면 CheckKoinModules DSL을 사용하여 테스트에 누락된 인스턴스 데이터를 제공해 보겠습니다.

val myModule = module {
    factory { (id: String) -> FactoryPresenter(id) }
}

다음과 같이 검증할 수 있습니다.

class CheckModulesTest : KoinTest {

    @Test
    fun verifyKoinApp() {
        
        koinApplication {
            modules(myModule)
            checkModules(){
                // value to add to Koin, used by definition
                withInstance("_my_id_value")
            }
        }
    }
}

이렇게 하면 FactoryPresenter 정의가 위에서 정의한 "_my_id_value"로 주입됩니다.

또한 모의 인스턴스를 사용하여 그래프를 채울 수도 있습니다. Koin이 주입된 정의를 모의할 수 있도록 하려면 MockProviderRule 선언이 필요합니다.

val myModule1 = module {
    factory { (a : ComponentA) -> ComponentB(a) }
}
// or
val myModule2 = module {
    factory { ComponentB(get()) }
}
class CheckModulesTest : KoinTest {
    
    @get:Rule
    val mockProvider = MockProviderRule.create { clazz ->
        // Setup your nock framework
        Mockito.mock(clazz.java)
    }

    @Test
    fun verifyKoinApp() {
        
        koinApplication {
            modules(myModule1)
            checkModules(){
                // add a mock of ComponentA to Koin 
                withInstance<ComponentA>()
            }
        }
    }
}

Android용 모듈 검사 (3.1.3)​

다음은 일반적인 Android 앱에 대한 그래프를 테스트하는 방법입니다.

class CheckModulesTest {

    @get:Rule
    val rule: TestRule = InstantTaskExecutorRule()

    @get:Rule
    val mockProvider = MockProviderRule.create { clazz ->
        Mockito.mock(clazz.java)
    }

    @Test
    fun `test DI modules`(){
        koinApplication {
            modules(allModules)
            checkModules(){
                withInstance<Context>()
                withInstance<Application>()
                withInstance<SavedStateHandle>()
                withInstance<WorkerParameters>()
            }
        }
    }
}

checkKoinModules를 사용하는 것도 가능합니다.

class CheckModulesTest {

    @get:Rule
    val rule: TestRule = InstantTaskExecutorRule()

    @get:Rule
    val mockProvider = MockProviderRule.create { clazz ->
        Mockito.mock(clazz.java)
    }

    @Test
    fun `test DI modules`(){
        checkKoinModules(allModules) {
            withInstance<Context>()
            withInstance<Application>()
            withInstance<SavedStateHandle>()
            withInstance<WorkerParameters>()
        }
    }
}

기본값 제공 (3.1.4)​

필요한 경우 검사된 모듈의 모든 유형에 대한 기본값을 설정할 수 있습니다. 예를 들어 주입된 모든 문자열 값을 재정의할 수 있습니다.

checkModules 블록에서 withInstance() 함수를 사용하여 모든 정의에 대한 기본값을 정의해 보겠습니다.

@Test
fun `test DI modules`(){
    koinApplication {
        modules(allModules)
        checkModules(){
            withInstance("_ID_")
        }
    }
}

주입된 String 매개변수를 사용하는 모든 주입된 정의는 "_ID_"를 받습니다.

module {
    single { (i: String) -> Simple.ComponentC(i) }
    factory { (id: String) -> FactoryPresenter(id) }
}

ParametersOf 값 제공 (3.1.4)​

withParameter 또는 withParameters 함수를 사용하여 특정 정의에 주입될 기본값을 정의할 수 있습니다.

@Test
fun `test DI modules`(){
    koinApplication {
        modules(allModules)
        checkModules(){
            withParameter<FactoryPresenter> { "_FactoryId_" }
            withParameters<FactoryPresenter> { parametersOf("_FactoryId_",...) }
        }
    }
}

Scope 링크 제공​

checkModules 블록에서 withScopeLink 함수를 사용하여 스코프를 연결하여 다른 스코프 정의에서 인스턴스를 주입할 수 있습니다.

val myModule = module {
    scope(named("scope1")) {
        scoped { ComponentA() }
    }
    scope(named("scope2")) {
        scoped { ComponentB(get()) }
    }
}
@Test
fun `test DI modules`(){
    koinApplication {
        modules(myModule)
        checkModules(){
            withScopeLink(named("scope2"), named("scope1"))
        }
    }
}