Koin是一個(gè)輕量級(jí)的依賴注入組件,相比dagger它更容易使用,學(xué)習(xí)。上手更容易。
現(xiàn)在已經(jīng)升級(jí)到2.0版本,增加了更多特性。
集成
implementation 'org.koin:koin-android-viewmodel:2.0.1'
implementation 'org.koin:koin-android:2.0.1'
implementation 'org.koin:koin-android-scope:2.0.1'
implementation 'org.koin:koin-android-ext:2.0.1'
注冊(cè)module:
class MainApplication : Application() {
override fun onCreate() {
super.onCreate()
startKoin {
androidLogger()
androidContext(this@MainApplication)
androidFileProperties()
modules(tesModule)
}
}
}
- androidLogger:用來(lái)打印日志
- androidContext:向Koin中注入context
- androidFileProperties:從assets中讀取保存的數(shù)據(jù)
- modules:注冊(cè)聲明的Module
ViewModel注入
在Architecture Componets中一般會(huì)用到ViewModel,Repository相關(guān)的類,一般都是直接在使用的地方初始化。使用了Koin之后就可以使用依賴注入了,不用再考慮在什么地方初始化,從什么地方傳值過(guò)來(lái)。
- datasource
interface RemoteDatasource {
@POST("test")
fun test(@Body map: Map<String, String>): Observable<Response>
}
- repository
class TestRepository(private val datasource: RemoteDatasource){
fun test(): Observable<Response> = datasource.test()
}
- viewModel
class TestViewModel(private val repository: TestRepository) : ViewModel() {
fun test(){
repository.test()
...
}
}
- 聲明module
val testModule = module{
//datasource實(shí)例化,單例
single { retrofit.create(RemoteDatasource::class.java) }
//Repository初始化,單例
single { TestRepository(get()) }
viewModel{ TestViewModel(get()) }
}
- viewmodel 注入
class MainActivity : AppCompatActivity() {
//注入viewMode,注入完成之后就可以直接使用了
private val viewModel: TestViewModel by viewMode()
}
- fragment中獲取Activity中聲明的viewModel
class TestFragment : Fragment() {
val viewModel: TestViewModel by sharedViewModel()
}
factory
可以在module中使用factory
val myModule = module {
single { DataRepository() }
factory<Presenter> { MyPresenter(get()) }
single { HttpClient(getProperty("server_url")) }
}
factory就是獲取的時(shí)候每次都生成一個(gè)新的實(shí)例
qualifiers
限定符,用來(lái)區(qū)別同一個(gè)類的不同實(shí)例
single(named("dev")) { DataRepository() }
single(named("test")) { DataRepository() }
bind
將指定的實(shí)例綁定到對(duì)應(yīng)的class
single { TestRepository(get()) } bind TestViewModel::class
注入時(shí)傳遞參數(shù)
聲明:
single{ (view : View) -> Presenter(view) }
使用:
val presenter : Presenter by inject { parametersOf(view) }
flags
- createAtStart
在start的時(shí)候就創(chuàng)建實(shí)例。一般都是需要注入的時(shí)候才創(chuàng)建的
val testModule = module(createAtStart = true){
....
}
- override
覆蓋另一個(gè)module中的實(shí)例
val myModuleA = module {
single<Service> { ServiceImp() }
}
val myModuleB = module {
single<Service>(override=true) { TestServiceImp() }
}
scope
Scope就是一個(gè)實(shí)例的作用范圍,一旦該作用范圍結(jié)束,該實(shí)例就是從容器中移除。
Koin有3種scope
- single: 單實(shí)例scope,該scope下的實(shí)例不會(huì)被移除
- factory: 每次都是創(chuàng)建新實(shí)例
- scoped: 自定義scope
自定義scope
module {
scope(named("A Scope Name")){
scoped { Presenter() }
}
}
//創(chuàng)建scope
val scope = koin.createScope("myScope","A_SCOPE_NAME")
//獲取實(shí)例
val presenter = scope.get<Presenter>()
scope中的依賴
class ComponentA
class ComponentB(val a : ComponentA)
module {
scope(named("A_SCOPE_NAME")){
scoped { ComponentA() }
scoped { ComponentB(get()) }
}
}
使用
val myScope = koin.createScope("myScope",named("A_SCOPE_NAME"))
val componentA = myScope.get<ComponentA>()
val componentB = myScope.get<ComponentB>()
關(guān)閉scope
val myScope = koin.createScope("myScope",named("A_SCOPE_NAME"))
myScope.close()
在android中的scope
Activity和Fragment默認(rèn)添加了擴(kuò)展, 可以直接使用
class DetailActivity : AppCompatActivity() {
val presenter : Presenter by currentScop.inject()
}
FileProperties
FileProperties用來(lái)存儲(chǔ)文本數(shù)據(jù),就是一個(gè)普通的Properties文件,在Android中是放在assets下面。路徑為/assets/koin.properties。 startKoin時(shí)候會(huì)把文件中的內(nèi)容都load進(jìn)去。
使用
val testModule = module{
factory{ TestModel(getProperty("test")) }
}
Koin的實(shí)現(xiàn)
Koin的實(shí)現(xiàn)就比較簡(jiǎn)單了,沒有使用注解和生成代碼。通過(guò)容器, kotlln DSL和Kotlin擴(kuò)展實(shí)現(xiàn)。
抽象來(lái)看,關(guān)鍵的只有三個(gè)要素:
- module
- scope
- bean
module中有兩個(gè)容器,分別存放了module下的scope和bean
scope里面有個(gè)BeanRegistry,BeanRegistry中容器內(nèi)存放了該scope下的所有bean
注入的時(shí)候通過(guò)socpe找到里面對(duì)應(yīng)的類型的bean
所有bean的注入都提供了lazy和直接獲取模式
作用域的實(shí)現(xiàn)
scope close之后,scope下的bean都不能再注入了。每個(gè)bean都有一個(gè)OnCloseCallback和close方法
當(dāng)scope close之后會(huì)通過(guò)callback通知下面的bean都close,即清空容器和把bean的引用設(shè)置為null