本篇文章将介绍如下内容
相关代码在这里DaggerDemo
-
Dagger2 两种基本使用方式
- 通过@Inject注解
- 通过@Module注解
@Provides注解方法参数（递归注入）
Dagger2众所周知是一个依赖注入库，简单粗暴的说法就是帮助完成一个类初始化/实例化。
Dagger2 配置
- 需要在Module中build.gradle
apply plugin: 'kotlin-kapt'
- 再引入dagger库和注解处理器
implementation 'com.google.dagger:dagger:2.16'
kapt 'com.google.dagger:dagger-compiler:2.16'
Dagger2 两种基本使用方式
通过@Inject注解
- 因为你要初始化一个对象，肯定一个构造方法，所以在构造方法加一个@inject
class Person @Inject constructor() {
var name = ""
fun test(context:Context){
Toast.makeText(context,"名字：$name",Toast.LENGTH_SHORT).show()
}
}
- 然后通过一个@Component来将这个对象跟你注入的地方联系起来（Component类还有另外一种定义方法，会在下篇文章说明）
@Component
interface MainComponent {
fun inject(activity: MainActivity)
}
-
点击一个绿色的锤子，会自动生成一个DaggerMainComponent文件（如下图），然后你在想要的地方通过这个文件完成注入
DaggerMainComponent.png
class MainActivity : AppCompatActivity() {
@Inject
lateinit var person: Person
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
DaggerMainComponent.builder().build().inject(this)
person.name = "测试"
btn_inject.setOnClickListener{
person.test(this)
}
}
}
这种情况适用于你知道构造方法或者你可以为构造方法增加@Inject注解。但是如果是第三方的类或者是接口就需要下面这种方式
通过@Module注解
- 创建一个接口和它的实现类（）
接口类
interface IJob {
fun work(context: Context)
}
实现接口类
class Programmer : IJob {
override fun work(context: Context) {
Toast.makeText(context, "敲代码", Toast.LENGTH_SHORT).show()
}
}
- @Module这个注解类来给Dagger提供之后需要注入的初始化方法（由@Provides标识）
@Module
class MainModule {
/**
* 初始化接口
*/
@Provides
fun provideIJob():IJob{
return Programmer()
}
/**
* 初始化第三方
*/
@Provides
fun provideGson():Gson{
return Gson()
}
}
- 在@Component注解中与@Module注解的类联系起来，赋值给modules的是一个class的数组（从 Kotlin 1.2 开始, 注解中的数组类型参数, 可以通过新的字面值语法来指定, 而不必使用 arrayOf 函数）
@Component(modules = [(MainModule::class)])
interface MainComponent {
fun inject(activity: MainActivity)
}
- 在Activity中，方式二适用于需要对@Module注解类做一些相关操作
class MainActivity : AppCompatActivity() {
@Inject
lateinit var job:IJob
@Inject
lateinit var gson:Gson
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
//方式一
DaggerMainComponent.builder().build().inject(this)
//方式二
DaggerMainComponent.builder().mainModule(MainModule()).build().inject(this)
btn_module.setOnClickListener{
job.work(this)
val json = gson.toJson(person)
Log.d("==",json)
}
}
}
@Provides注解方法参数（递归注入）
比如我们更改Programmer的构造方法为多参
class Programmer(val content:String) : IJob {
override fun work(context: Context) {
Toast.makeText(context, "工作内容：$content", Toast.LENGTH_SHORT).show()
}
}
把之前@Provides注解的方法改为
@Provides
fun provideIJob(content:String):IJob{
return Programmer(content)
}
编译之后就会发现报错
错误: [Dagger/MissingBinding] java.lang.String cannot be provided without an @Inject constructor or an @Provides-annotated method.
这句话意思String类没有提供@Inject注解的构造方法或者@Provides注解的方法。
也就是说如果发现@Provides注解的方法有参数，便会递归寻找这个参数的类的@Inject注解的构造方法或者@Provides注解的方法。
如果要改为正确应该这样子，增加返回String的方法
@Provides
fun provideContent():String{
return "敲代码"
}
最后一点，如果一个类同时使用了@Provides和@Inject，@Provides优先级是高于@Inject
