Dagger2学习笔记

大家在阅读之前，如果是新手，建议先阅读一下轻松学，听说你还没有搞懂 Dagger2

Android Studio 中的配置（使用 Kotlin 开发）

在 app 的 build.gradle 中配置

apply plugin: 'kotlin-kapt'

implementation 'com.google.dagger:dagger:2.16'
kapt 'com.google.dagger:dagger-compiler:2.14.1' // 必须使用kapt方式添加注解，否则会出现无法编译自动生成类文件的bug

Dagger Github地址

具体使用

单 Module

• 创建 MainModule

@Module
class MainModule {

    @Provides
    fun provideString(): String = "我是MainModule"
}

• 创建 MainComponent

@Component(modules = [MainModule::class])
interface MainComponent {

    fun inject(activity: MainActivity)
}

注意：创建完 MainComponent ，必须要 Rebuild Project 一下。

• 修改 MainActivity

class MainActivity : AppCompatActivity() {

    @Inject
    @JvmField
    var valueString: String? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        DaggerMainComponent.builder().build().inject(this)
        Log.i("Wanzi", "valueString:$valueString")
    }
}

注意：Kotlin 中使用 Dagger2 可能导致错误”Dagger does not support injection into private fields”，Kotlin 生成 .java 文件时属性默认为 private ，给属性添加 @JvmField 声明可以转成 public

• 打印结果
  

多 Module

• 创建 IntModule

@Module
class IntModule {

    @Provides
    fun provideInt(): Int = 123456
}

• 修改 MainComponent

@Component(modules = [MainModule::class,IntModule::class])
interface MainComponent {

    fun inject(activity: MainActivity)
}

在 modules 又加入了 IntModule

• 修改 MainActivity

class MainActivity : AppCompatActivity() {

    @Inject
    @JvmField
    var valueString: String? = null

    @Inject
    @JvmField
    var valueInt: Int? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        DaggerMainComponent.builder().build().inject(this)
        Log.i("Wanzi", "valueString:$valueString   valueInt:$valueInt")
    }
}

新增一个参数 valueInt 用来演示效果

• 打印结果
  

Component 之间相互依赖

• 创建 IntComponent

@Component(modules = [IntModule::class])
interface IntComponent {

    fun getInt(): Int
}

注意： module 中 provide 的返回值，要在 component 中也返回。
可能有点绕，例如： IntModule 中 provideInt 函数返回一个 Int 类型的值，那么在 IntComponent 中也需要一个返回 Int 类型的函数。

• 修改 MainComponent

@Component(modules = [MainModule::class], dependencies = [IntComponent::class])
interface MainComponent {

    fun inject(activity: MainActivity)
}

新增 dependencies = [IntComponent::class]

• 修改 MainActivity

class MainActivity : AppCompatActivity() {

    @Inject
    @JvmField
    var valueString: String? = null

    @Inject
    @JvmField
    var valueInt: Int? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val intComponent = DaggerIntComponent.builder().build()

        DaggerMainComponent.builder().intComponent(intComponent).build().inject(this)
        Log.i("Wanzi", "valueString:$valueString   valueInt:$valueInt")
    }
}

• 打印结果
  

Module 实现有参的构造方法

• 修改 MainModule

@Module
class MainModule(var value: String) {

    @Provides
    fun provideString(): String = value
}

给 MainModule 构造加入参数

• 修改 MainActivity

class MainActivity : AppCompatActivity() {

    @Inject
    @JvmField
    var valueString: String? = null

    @Inject
    @JvmField
    var valueInt: Int? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val intComponent = DaggerIntComponent.builder().build()

        DaggerMainComponent.builder().mainModule(MainModule("有参的构造")).intComponent(intComponent).build().inject(this)
        Log.i("Wanzi", "valueString:$valueString   valueInt:$valueInt")
    }
}

• 打印结果
  

@Inject 注解使用①

• 创建 Student

class Student @Inject
constructor() {

}

• 修改 MainModule

@Module
class MainModule(var value: String) {

    @Provides
    fun provideString(): String = value

    @Provides
    fun provideStudent(): Student = Student()
}

• 修改 MainActivity

class MainActivity : AppCompatActivity() {

    @Inject
    @JvmField
    var valueString: String? = null

    @Inject
    @JvmField
    var valueInt: Int? = null

    @Inject
    @JvmField
    var valueStudent: Student? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val intComponent = DaggerIntComponent.builder().build()

        DaggerMainComponent.builder().mainModule(MainModule("有参的构造")).intComponent(intComponent).build().inject(this)
        Log.i("Wanzi", "valueString:$valueString   valueInt:$valueInt   valueInt:${valueStudent}")
    }
}

• 打印结果
  

@Inject 注解使用②

现在 Student 类要加一个参数 name

• 修改 Student

data class Student @Inject
constructor(var name: String) {
}

将 Student 修改成了数据类

• 修改 MainModule

@Module
class MainModule(var value: String) {

    @Provides
    fun provideString(): String = value

    @Provides
    fun provideStudent(): Student = Student("小明")
}

• 修改 MainActivity

class MainActivity : AppCompatActivity() {

    @Inject
    @JvmField
    var valueString: String? = null

    @Inject
    @JvmField
    var valueInt: Int? = null

    @Inject
    @JvmField
    var valueStudent: Student? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val intComponent = DaggerIntComponent.builder().build()

        DaggerMainComponent.builder().mainModule(MainModule("有参的构造")).intComponent(intComponent).build().inject(this)
        Log.i("Wanzi", "valueString:$valueString   valueInt:$valueInt   valueInt:${valueStudent?.name}")
    }
}

• 打印结果