验证你的 Koin 配置

Koin 允许你验证你的配置模块，避免在运行时发现依赖注入（dependency injection）问题。

使用 Verify() 进行 Koin 配置检查 - 仅限 JVM [3.3]

在 Koin 模块上使用 verify() 扩展函数。就是这样！在底层，这将验证所有构造函数类，并与 Koin 配置进行交叉检查，以了解是否为此依赖项声明了组件。如果失败，该函数将抛出一个 MissingKoinDefinitionException 异常。

val niaAppModule = module {
    includes(
        jankStatsKoinModule,
        dataKoinModule,
        syncWorkerKoinModule,
        topicKoinModule,
        authorKoinModule,
        interestsKoinModule,
        settingsKoinModule,
        bookMarksKoinModule,
        forYouKoinModule
    )
    viewModelOf(::MainActivityViewModel)
}

class NiaAppModuleCheck {

    @Test
    fun checkKoinModule() {

        // Verify Koin configuration
        niaAppModule.verify()
    }
}

启动 JUnit 测试，你就完成了！✅

正如你所看到的，我们使用额外的 Types 参数来列出在 Koin 配置中使用但未直接声明的类型。 SavedStateHandle 和 WorkerParameters 类型就是这种情况，它们被用作注入的参数。 Context 由启动时的 androidContext() 函数声明。

verify() API 非常轻量级，不需要任何类型的 mock/stub 就可以在你的配置上运行。

验证注入参数 - 仅限 JVM [4.0]

当你的配置包含使用 parametersOf 注入的对象时，验证将会失败，因为你的配置中没有参数类型的定义。但是，你可以定义一个参数类型，通过给定的定义 definition<Type>(Class1::class, Class2::class ...) 进行注入。

以下是具体用法：

class ModuleCheck {

    // 给定一个带有注入定义的定义
    val module = module {
        single { (a: Simple.ComponentA) -> Simple.ComponentB(a) }
    }

    @Test
    fun checkKoinModule() {
        
        // 验证并声明注入参数
        module.verify(
            injections = injectedParameters(
                definition<Simple.ComponentB>(Simple.ComponentA::class)
            )
        )
    }
}

类型白名单

我们可以将类型添加为“白名单”。这意味着对于任何定义，此类型都被视为存在于系统中。以下是具体用法：

class NiaAppModuleCheck {

    @Test
    fun checkKoinModule() {

        // Verify Koin configuration
        niaAppModule.verify(
            // List types used in definitions but not declared directly (like parameters injection)
            extraTypes = listOf(MyType::class ...)
        )
    }
}