Kotlin 中的依赖注入 KODEIN

用 Java 进行 Android 开发的话，依赖注入这一块通常使用 Dagger ,转用 Kotlin 以后有更多的选择，Kodein 是个不错的库， 4.0 5.0 都使用过了，相对于 Dagger 有不少好处。

• 用 Kotlin 编写利用了更优秀的语言特性 好比类型推断，Dagger 在编写 Component 的时候须要知道注入类的类型
• 无需像 Dagger 同样编写大量模板代码
• 不会像 Dagger 同样在编译期由于其它的编译错误致使没法生成所需文件从而报一堆错。
• ...

最基本的使用步骤

1. 在 Application 继承 KodeinAware 并绑定依赖

class MyApp : Application(), KodeinAware {
	override val kodein = Kodein.lazy { 
	    /* bindings */
	}
}
复制代码

2. 在 context aware 的 Android 类中经过 closestKodein 方法获取
3. 加载依赖

class MyApp : Application(), KodeinAware {

    //实例化 Application 级的 kodein 经过 DSL 绑定 module
	override val kodein = Kodein.lazy { 
        //导入预设的 android 组件
        import(androidModule(this@MainApplication))
        //绑定或者导入自定义依赖
	}
}
复制代码

相关基本概念

在 Application 定义 Application 级的 Kodein

class MyApp : Application(), KodeinAware {

    //实例化 Application 级的 kodein 经过 DSL 绑定 module
	override val kodein = Kodein.lazy { 
        //导入预设的 android 组件
        import(androidModule(this@MainApplication))
        //绑定或者导入自定义依赖
	}
}
复制代码

经过 closestKodein 恢复 Application 级的 Kodein 而后经过 Kodein 加载依赖

kodein & ds 默认都是懒加载

class MyActivity : Activity(), KodeinAware {
    override val kodein by closestKodein()
    val ds: DataSource by instance()
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        ds.connect() 
        /* ... */
    }
}
复制代码

使用 Trigger 在 onCreate() 中手动触发加载依赖（取消懒加载）

一样能够避免依赖死循环（除非加载依赖的方式只有 instance）

class MyActivity : Activity(), KodeinAware {
    override val kodein by closestKodein()
    override val kodeinTrigger = KodeinTrigger()
    val ds: DataSource by instance()
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        kodeinTrigger.trigger() 
        /* ... */
    }
}
复制代码

在没有 Non-Context-Aware 的类中加载 Kodein

class MyController(androidContext: Context) : KodeinAware {
    override val kodein by androidContext.closestKodein()
    override val kodeinContext = kcontext(androidContext)
    val inflater: LayoutInflater by instance()
}
复制代码

多级 Kodin 依赖

定义 Activity 级的 Kodein 继承自 Application 级

class MyActivity : Activity(), KodeinAware {
    private val _parentKodein by closestKodein() 
    override val kodein: Kodein = Kodein {
        extend(_parentKodein) 
        /* activity specific bindings */
    }
}
复制代码

Activity Retained Kodein

使用 retainedKodein 在 Activity 重启的时候不会从新建立 Kodein

class MyActivity : Activity(), KodeinAware {
    private val _parentKodein by closestKodein()
    override val kodein: Kodein by retainedKodein { 
        extend(_parentKodein)
        /* activity specific bindings */
    }
}
复制代码

Android scopes 做用域

//每一个 Activity 一个单例
val kodein = Kodein {
    bind<Controller>() with scoped(androidScope<Activity>()).singleton { ControllerImpl(context) } 
}
复制代码

Activity retained scope

一样 activityRetainedScope 在 Activity 重启时不会从新建立依赖

val kodein = Kodein {
    bind<Controller>() with scoped(activityRetainedScope).singleton { ControllerImpl() } 
}
复制代码

Bindings: Declaring dependencies 申明依赖的一些重要的参数

绑定的方式

• Provider binding : 每次加载都生成新的实例，无参， 传入() -> T
• Singleton binding : 单例 传入 () → T
• Eager singleton : 单例 建立了 Kodein 实例后当即实例化 传入 () -> T
• Factory binding : 每次加载都生成新的实例，须要参数，传入(A) -> T
• Multiton binding : 有参的单例，一样参数一样实例，传入 (A) -> T
• Tagged bindings : 经过 tag 来区分同类型不一样的实例 例如

val kodein = Kodein {
    bind<Die>() with ... 
    bind<Die>(tag = "DnD10") with ... 
    bind<Die>(tag = "DnD20") with ... 
}
复制代码

基本上以上的参数涵盖了大部分的通用使用场景，Kodein 还有不少复杂的高级用法

JVM: Soft & Weak 两种引用回收机制

1. 使用 WeakReference 在OutOfMemoryException以前 JVM 执行 GC
2. 使用 SoftReference 在没有引用的时候就 JVM 执行 GC

val kodein = Kodein {
    bind<Map>() with refSingleton(ref = softReference) { WorldMap() } 
    bind<Client>() with refSingleton(ref = weakReference) { id -> clientFromDB(id) } 
}
复制代码

Transitive dependencies 依赖传递

依赖中使用依赖的状况，Kotlin 的类型推断系统能够很简单的实现。

class Die(private val random: Random, private val sides: Int) {
/*...*/
}

val kodein = Kodein {
    bind<Die>() with singleton { Die(instance(), instance(tag = "max")) } 

    bind<Random>() with provider { SecureRandom() } 
    constant(tag "max") with 5 
}
复制代码

更多高级用法...

• KODEIN DI: KOtlin DEpendency INjection: 5.0.0
• Kodein on Android
• Getting started
• Core documentation