一、简介
Koin是一款轻量级的依赖注入框架，它允许Android应用程序轻松管理组件之间的依赖关系。
Koin的主要目标是使依赖注入变得简单，易于理解和使用。它采用纯Kotlin编写，无代理，无需代码生成或反射，而是基于函数式DSL和注解，提供了一个简单而强大的方式来声明和管理依赖项。
以下是 Koin 和 Hilt 的对比表：
| 功能 | Koin | Hilt |
|---|---|---|
| 轻量级 | 是 | 否 |
| 易于使用 | 是 | 是 |
| 可用于 Android、Kotlin Native 和 JavaScript | 是 | 否 |
| 具有广泛的社区支持 | 是 | 是 |
| 与 Android 生命周期集成 | 否 | 是 |
| 支持自动注入 | 否 | 是 |
| 与 Jetpack 组件集成 | 否 | 是 |
| 具有 Google 的支持 | 否 | 是 |
二、使用
1、添加依赖
在build.gradle中添加依赖
//core为Koin的核心
implementation("io.insert-koin:koin-core:3.4.0")
//android是Koin为Android提供的一些扩展方法
implementation("io.insert-koin:koin-android:3.4.0")
//compat是Koin为Android组件提供的一些扩展方法
implementation("io.insert-koin:koin-android-compat:3.4.0")
}
2、注入对象定义
// 定义三个对象：分别是常规对象注入、单例对象注入、ViewModel对象注入
//1、常规对象定义及注入
class NormalKoin {
}
// normalMoudle就是来管理常规的对象注入
val normalModule = module {
factory { NormalKoin() }
}
//2、单例对象定义及注入
class SingletonKoin {
}
// singleModule则是用来单例对象注入
val singleModule = module {
single { SingletonKoin () }
}
// 3、有参ViewModel定义及注入
class KoinViewModel(private val repository: Repository): ViewModel() {
}
class Repository() {
}
//注意：有参数的注入，需要先在module中注入参数后，告诉koin它是一个注入对象，然后在注入ViewModel的时候通过get()方法就可以自动获取到。
val viewModelModule = module {
single { Repository() }
viewModel { KoinViewModel (get()) }
}
关键方法Koin中Module的方法：
factory{ } ：用来注入常规对象，提供一个工厂定义（每次使用都会创建新的对象）
single{ } ：用来注入单例对象，提供一个单例定义
viewModel{ }：用来注入ViewModel对象
scope{ } - 定义一个作用域
scoped{ } - 为一个定义指定其作用域
get() - 获取依赖对象
bind() - 增加一个类型绑定到给定的定义
binds() - 增加一个类型的数组绑定到给定的定义
named() - 命名定义
3、开启Koin注入
在Application中开启koin注入
startKoin {
AndroidLogger(Level.DEBUG)
androidContext(context)
modules(
listOf(
viewModelModule,
singleModule,
normalModule
)
)
}
startkoin{}：开启Koin功能，然后进行一些配置
- androidLogger()：开启Koin的运行日志，指定日志的等级
- androidContext()：绑定Application上下文，后面可以直接从Koin中获取
- module()：传入Koin的模块，此模块就是我们定义的依赖注入项
- properties() ：加载给定的键值对到容器。（Map形式）
- fileProperties() ：从给定文件中加载键值对到容器。（Android通常用androidFileProperties()替代，文件一定要放在assets目录下，默认文件名为koin.properties，可传入自定义文件名）
- environmentProperties()：从操作系统环境加载键值对到容器。
- createEagerInstances()：创建以createAtStart标记的单例定义。
4、注入获取实例
class MainActivity : BaseActivity<ActivityMainBinding>() {
// 使用Koin进行对象注入
private val normalKoin : NormalKoin by inject()//方法一
private val normalKoin by inject<NormalKoin>()//方法二
private val singletonKoin: SingletonKoinby inject()
private val koinViewModel: KoinViewModel by viewModel()
override fun initViewBinding(): ActivityMainBinding {
return ActivityMainBinding.inflate(layoutInflater)
}
override fun onCreate() {
super.onCreate()
val normalKoin = get<NormalKoin>()//方法三
}
}
Koin不仅可以使用by inject()来注入，也可以直接使用get()来注入一个对象，二者的区别在于一个是懒加载模式，一个是直接获取模式
- inject()：返回的是一个Lazy对象，内部依旧调用的是get()方法
- get()：返回的是需要注入的对象实例
