欢迎
Koin 是一个面向 Kotlin 的依赖注入框架。您可以在模块中声明类该如何构建,Koin 会在运行时创建并装配这些实例,并且可选的 Koin 编译器插件可以在构建时检查整个依赖图。它可在 Android、Compose、Kotlin Multiplatform、Ktor 以及任何 Kotlin/JVM 应用程序上运行。
本页是文档导航图。以下各节说明了其解答的问题以及入门途径。
kotlin
class UserRepository(private val api: ApiService)
val appModule = module {
single<ApiService>()
single<UserRepository>()
}
fun main() {
startKoin { modules(appModule) }
}我想要……
- 首先理解依赖注入:什么是依赖注入?
- 五分钟了解 Koin 的工作原理:核心概念
- 在 DSL 和注解之间做出选择:选择您的风格
- 将 Koin 添加到我的 Gradle 构建中:Gradle 设置
- 在 Composable 中注入 ViewModel:Compose 中的 ViewModel
- 在 Activity、Fragment 或 Service 中进行注入:Android 入口点
- 装配 Retrofit、Room 或 OkHttp:Android 库集成
- 在 Android 和 iOS 之间共享模块:KMP 共享模式
- 向定义传递运行时值(例如 ID):注入形参
- 测试我的 Koin 配置:验证您的 Koin 配置与编译时安全
- 修复“No definition found”错误:故障排除
- 从 Hilt 迁移:从 Hilt 迁移
- 将注解从 KSP 迁移至编译器插件:从 KSP 迁移
- 查看 Koin 在生产环境中的运行表现:生产监控
导航指南
新手入门
什么是 Koin?它如何工作?我应该使用哪种风格?
- 什么是 Koin?:Koin 是什么以及其如何工作,包括运行时与编译时。
- 核心概念:定义、模块、容器、注入、作用域。
- 选择您的风格:注解或 DSL(编译器插件、构造函数或经典 DSL)。
- Koin 编译器插件:该插件在构建时执行的操作。
设置
我需要向构建中添加什么?
教程
如何使用 Koin 逐步构建第一个应用程序?
- Kotlin:纯 Kotlin 应用程序。
- Android - ViewModel 和 Android - Jetpack Compose。
- Compose Multiplatform:Android 和 iOS 上的共享 UI。
- Ktor:服务器端应用程序。
核心
如何在任何平台上声明、组织和获取依赖项?
平台
如何将 Koin 与特定平台或框架结合使用?
- Android:在 Android 上启动 Koin、Android ViewModel、多模块 Android 应用。
- Compose:面向 Compose 的 Koin、Compose 中的 ViewModel、Navigation 3。
- Kotlin Multiplatform:KMP 设置、共享模式。
- Ktor:面向 Ktor 的 Koin、请求作用域。
测试
如何测试使用 Koin 的代码,以及测试配置本身?
- 在测试中进行注入:
KoinTest、使用测试替身(fake)替换定义。 - 验证您的 Koin 配置:在单元测试中检查模块。
- Android 插桩测试与测试 Composable。
生产与工具
哪些工具可以帮助我编写、检查和运行 Koin 应用程序?
迁移
我正在使用其他框架或较旧的 Koin 配置,该如何迁移?
- Koin 与 Hilt 对比:两者的比较。
- 从 Hilt 迁移:分步指南。
- JSR-330 兼容性:保留来自
javax.inject的@Inject和@Singleton。 - 从 KSP 迁移:将注解迁移到编译器插件。
参考指南
有哪些关键字、注解和选项?
支持
我应该使用哪个版本?有哪些变更?在哪里可以获得帮助?
