首发于公众号: DSGtalk1989
最可怕的还是来了,依赖注入一直是一般工程师最最不愿意去碰的东西。复杂,不易理解。但是不得不承认,使用起来真的很方便。本章节将不尽量不涉及原理说明,只介绍依赖注入使用。
相比较而言,可能知道Dagger
的人会多很多。但是这里选择用Kodein
作为kotlin项目的依赖注入框架,除了kodein
本身是用kotlin写的之外,还有他更加容易理解的使用方式,我们多说无益,跟着我来一起上手吧!
第一步,添加依赖
// 基础组件
implementation 'org.kodein.di:kodein-di-generic-jvm:6.1.0'
// Android扩展组件
implementation 'org.kodein.di:kodein-di-framework-android-core:6.1.0'
// support扩展组件,我的项目中用到了v4包的Fragment,因此我需要它
implementation 'org.kodein.di:kodein-di-framework-android-support:6.1.0'
第二步,在主application中添加实现KodeinAware
接口
class FrameApplication : Application(), KodeinAware {
override val kodein: Kodein = Kodein.lazy { }
}
实现之后会要求你必须复写kodein
属性,我们直接定义成延迟属性lazy
,具体见委托。我们需要在lazy中做一些初始化的工作,其实显而易见了,就是我们将要注入的依赖。
第三步,定义Module
我们挑一个最最常用的注入例子,Retrofit
的service
注入。这里建议大家把所有需要注入的通用module
,放在同一个地方,比如ModuleFactory.kt
kodein
针对module
的语法如下
val moduleName = Kodein.Module(MODULE_TAG) {
bind<injectClass>() with singleton { init it }
instance<haveInjectedClass>
.haveInjectedClassFun(instance())
}
不知道直接这么写,大家可否理解。首先module
是一个属性或者方法都可以,指向的Kodein.Module
需要传入一个TAG
字符串,然后我们将需要注入的对象类型绑定,并在singleton
后面的lambda表达式中对注入对象进行初始化。
针对已经声明过注入的类型对象,我们直接可以使用instance
带注入类型的方式当成注入对象来使用,并且在相关方法中一旦需要传入已经注入过的对象,直接调用instance()
即可,框架会帮我们找到相应的对象。
所以这边okHttpModule
的注入如下:
/**
* OKHTTP module
*/
val httpClientModule = Kodein.Module(HTTP_CLIENT_MODULE_TAG) {
bind<Retrofit.Builder>() with singleton { Retrofit.Builder() }
bind<OkHttpClient.Builder>() with singleton { OkHttpClient.Builder() }
bind<Retrofit>() with singleton {
instance<Retrofit.Builder>()
.baseUrl(AppConfig.BASE_URL)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())
.client(instance())
.build()
}
bind<OkHttpClient>() with singleton {
//打印请求log
val logging = HttpLoggingInterceptor()
logging.level = if (BuildConfig.DEBUG) {
HttpLoggingInterceptor.Level.BODY
} else {
HttpLoggingInterceptor.Level.NONE
}
instance<OkHttpClient.Builder>()
.addInterceptor(logging)
.addInterceptor(headerInterceptor())
.build()
}
}
第四步,import module
在application中,直接做import
override val kodein: Kodein = Kodein.lazy {
import(androidCoreModule(this@FrameApplication))
import(androidXModule(this@FrameApplication))
import(httpClientModule)
}
这里我们还引入了androidCoreModule
和androidXModule
,相关核心控件的context
,甚至很多的系统服务。
第五步,使用注入
在Activity
中,我们同样需要实现KodeinAware
接口,并且复写属性kodein
override val kodein by org.kodein.di.android.kodein()
Ok,就这么简单。接下去所有需要使用到注入的都是同样的操作。
val serviceManager: ServiceManager by instance()
val userDao: UserDao by instance()
所有的属性,我们都只要指出他是什么类型,同时委托给instance()
即可,框架会帮我们自动的初始化。
BTW,有同学跟我反应,有个注入框架比上面讲的kodein还好用,叫做koin,大家可以也看一下哦,之后抽空我来做横向比较。有个框架很好用,有空就访问这个链接koin