【Android架构】依赖注入篇Dagger Hilt&Koin
什么是依赖注入?
依赖注入(Dependency Injection),在编程中被广泛使用,非常适用于Android开发。作为一门应用架构的基础科学,为应用的良性发展提供了非常优秀的支持。
实现依赖注入,可用为我们带来这些好处:
- 重用代码
- 易于重构
- 易于测试
我们都知道,在OOP开发中,类往往需要引用其他类。例如,我们生产一个Car
,总是离不开Engine
,这被成为依赖关系。那么思考一下,Car
要如何获取自己所需要的Engine
呢?我们往往采用这些方式:
- 在类中构造所需依赖
- 从其它地方获取
- 以参数方式提供
而依赖注入,就是以参数方式提供依赖的,简单来看下代码:
class Engine {
fun start() {
println("Engine start!")
}
}
// 无依赖注入
class Car {
fun start() {
val engine = Engine()
engine.start()
}
}
// 构造函数注入
class Car(private val engine: Engine) {
fun start() {
engine.start()
}
}
fun main() {
val engine = Engine()
val car = Car(engine)
car.start()
}
// setter注入
class Car {
lateinit var engine: Engine
fun start() {
engine.start()
}
}
fun main() {
val engine = Engine()
val car = Car()
car.engine = engine
car.start()
}
什么是Dagger?
在上面,我们已经手动实现了最基础的依赖注入案例。你可能会说,这么简单啊,几行代码而已的事嘛。可如果这个Car
示例中,慢慢的加入更多的需求,可能需要引擎、传动装置、底盘以及其他部件;而要制造引擎,则需要汽缸和火花塞,依赖的类变得越来越多,再这样手动实现依赖注入就变得非常困难。这时,Dagger
就该登场了。
Dagger通过注解的方式,在程序编译过程中生成依赖注入所需要的静态代码,只要您声明类的依赖项并指定如何使用注释满足它们的依赖关系,Dagger 便会在构建时自动执行以上所有操作。Dagger 生成的代码与您手动编写的代码类似。在内部,Dagger 会创建一个对象图,然后它可以参考该图来找到提供类实例的方式。对于图中的每个类,Dagger 都会生成一个 factory
类,它会使用该类在内部获取该类型的实例。
Dagger简单案例
我们还是使用上面的汽车案例,用Dagger来对它进行改造。
Inject
// Inject 告诉Dagger如何创建实例
class Car @Inject constructor(
private val engine: Engine
) {
fun start() {
engine.start()
}
}
Module
// Module 提供创建实例所需要的参数
@Module
class CarModule {
@Provides
fun provideEngine(): Engine {
return Engine()
}
}
Component
// Component 将创建出的实例提供给需要的地方
@Singleton
@Component(modules = [CarModule::class])
interface CarComponent {
fun inject(activity: MainActivity)
}
Use
class MainActivity : AppCompatActivity() {
@Inject
lateinit var car: Car
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
// 创建Component
DaggerCarComponent.builder()
.carModule(CarModule())
.build()
.inject(this)
car.start()
}
}
Hilt实践之MVVM
清楚了Dagger最最基本的依赖注入原理之后,我们可以直接步入Google最新推出的专为Android而生的依赖注入库Hilt
,而不用再去纠结去Dagger在Android中配置的细枝末节,极大的降低了学习成本 ,提升开发效率。
这里直接看项目源码。
Kotlin依赖注入之Koin
相较于复杂的Dagger,在Kotlin中还有一个依赖注入框架koin
。它运用了大量的Kotlin特性,将依赖注入用dsl(领域特定语言)的方式实现,使依赖注入变得异常的简单。同样,我们准备了和Hilt相同逻辑的示例项目。
总结
到这里,我们已经介绍了Android中的依赖注入方式,相信你对依赖注入也有了一定的认识和思考,这里我们回到开始的地方,结合实例重新去思考我们在开头提到的依赖注入带来的三个好处,这些好处到底是如何带来的?
-
重用代码:实例中我们的
MainViewModel
中依赖了UserRepository
,我们如果不使用依赖注入,就会new一个UserRepository
对象。这样我们之后每次新建页面的ViewModel
都需要new一个UserRepository
。 -
易于重构:试想我们的App中的
User
信息不只是从Web获取,还希望在本地缓存并且在网络异常是从本地获取,我们就需要在UserRepository
新增构造参数database: UserDatabase
,借助于依赖注入,我们只需要重构repository
中的内容,ViewModel
中的实现完全不会受到任何影响。 -
易于测试:这里设计到测试的内容,比如我们测试
UserRepository
的时候,需要mock依赖的对象,如果每次都需要new一个对象,测试将会变得难以进行。