一. Dagger简介
Dagger 2 是 Google 开源的一款依靠注入结构,它的前身是 square 的 Dagger 1,Dagger 2 在 Android 中有着较为广泛的运用。
Dagger 2 根据 Java 注解,采用 annotationProcessor(注解处理器) 在项目编译时动态生成依靠注入需求的 Java 代码,然后咱们在合适的位置手动完结终究的依靠注入,而不是 Dagger 1 中根据反射的解决方案,所以在性能上是有保障的。
Android官方dagger介绍://代码效果参考:http://hnjlyzjd.com/xl/wz_24269.html
二. Dagger的依赖
// kapt is for implement annotation
apply plugin: 'kotlin-kapt'
// implementation dependences for dagger
implementation "com.google.dagger:dagger:2.21"
implementation "com.google.dagger:dagger-android-support:2.21"
kapt "com.google.dagger-compiler:2.21"
kapt "com.google.dagger-android-processor:2.21"
二. Dagger的配置
1. 初始化对象配置
1.1 使用@Inject注解初始化对象
注意:使用@Inject注解初始化对象时,构造函数所需的参数也必须已经使用dagger初始化,否则编译时会报错:com.record.sample.** cannot be provided without an @Inject constructor or an @Provides-annotated method
1 @Singleton
2 class RecordContractImple @Inject constructor(): RecordContract{
3 // empty body
4 }
1 @Singleton
2 class PicruteAdapter @Inject constructor(
3 context: Context
4 ): RecyclerView.Adapter{
5 // empty body
6 }
1.2 使用provide注解初始化对象
@Module
class RecordModule {
@Provides
@Singleton
fun provideRecordAdapter(
context: Context
): RecordAdapter = RecordAdapter(context)
@Provides
@Singleton
fun provideRecordContract(
recordContractImpl: RecordContractImpl
): RecordContract = recordContractImpl
@Provides
@Singleton
fun provideApplication(application: RecordApplication): RecordApplication = application
@Provides
@Singleton
fun provideContext(application: RecordApplication): Context = application
}
使用@Named注解可以为同一个类初始化不同的对象,在页面中可以使用@Inject+@Named注解类使用该对象,但使用时一直报错: cannot be provided without an @Inject constructor or an @Provides-annotated method,原因未知。
// use @Named annotation to provide different instance for the same class
@Provides
@Singleton
@Named("Okhttp_client")
fun provideOkHttpClient(): OkHttpClient
@Provides
@Singleton
fun provideRetrofit(
// use the @Named annotation to use different instance for same class
@Named("Okhttp_client") okHttpClient: OkHttpClient
): Retrofit {
return RetrofitProvide(...)
}
可以初始化基本类型
@Provider
fun provideAppVersion(): String = "2.21.0"
初始化Set,需要使用@ElementsIntoSet注解,网传dagger2.25以上版本有时候不需要显示提供@ElementsIntoSet注解。
@IntoSet注解告诉Dagger将返回的对象添加到Set依赖项中。
@Singleton
@Provides
@ElementsIntoSet
fun provideSet(): Set {
val set = mutableSetOf()
set.add("a")
set.add("b")
set.add("c")
return set
}
@Singleton
@Provides
@ElementsIntoSet
fun provideSet2(): Set {
val set = mutableSetOf()
set.add("a")
set.add("b")
set.add("c")
return set
}
@Provides
@IntoSet
fun provideInstanceForSet(): Name {
return Name()
}
2. 绑定页面与使用Dagger初始化的对象
设置哪些页面可以使用@Inject方式获取Dagger初始化的对象。(ContributesAndroidInjector参数设置待确认)
@Module
interface BindRecordModule {
@ContributesAndroidInjector
fun bindMainActivity(): MainActivity
@ContributesAndroidInjector
fun bindHomeFragment(): HomeFragment
}
3. 定义Component配置moudle
将1和2中的配置配置到Component中,配置完点击make module后,Dagger会自动生成一个DaggerRecordComponent。
@Singleton
@Component(
modules = 【
// default module, must add
AndroidSupportInjectionModule::class,
RecordModule::class,
BindRecordModule::class,
】
)
interface RecordComponent {
@Component.Builder
interface Builder {
@BindsInstance
fun application(application: Application): Builder
fun build(): RecordComponent
}
fun inject(app: RecordApplication)
完成后点击Make Module,Dagger会自动生成类DaggerRecordComponent
4. 重写Application,配置Component
class RecordApplication: Application(), HasActivityInjector, HasSupportFragmentInjector {
override fun onCreate() {
DaggerRecordComponent.builder().
.application(this)
.build()
.inject(this)
super.onCreate()
}
@Inject
internal lateinit var activityDispatchingAndroidInjector: DispatchingAndroidInjector
override fun activityInjector(): AndroidInjector {
return activityDispatchingAndroidInjector
}
@Inject
internal lateinit var fragmentDispatchingAndroidInjector: DispatchingAndroidInjector
override fun supportFragmentInjector(): AndroidInjector {
return fragmentDispatchingAndroidInjector
}
}
三. 使用
1. Activity中使用
AndroidInjection.inject(this)可以放在onAttach或者onCreate方法中初始化,只要在使用dagger初始化的地方之前调用即可。
HasSupportFragmentInjector可要可不要,原因未知。
class MainActivity: AppCompatActivity, HasSupportFragmentInjector {
// use inject anotation to init instance, do not use private, otherwise the param will not init
@Inject
lateinit var recordContract: RecordContract
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// pass activity instance to dagger for init the param
AndroidInjection.inject(this)
// use the instance function directily
val name = recordContract.getName()
}
@Inject
internal lateinit var fragmentDispatchingAndroidInjector: DispatchingAndroidInjector
override fun supportFragmentInjector(): AndroidInjector {
return fragmentDispatchingAndroidInjector
}
}
2. Fragment中使用
AndroidSupportInjection.inject(this)可以放在onAttach或者onCreate方法中初始化,只要在使用dagger初始化的地方之前调用即可。
class HomeFragment: Fragment() {
// use inject anotation to init instance, do not use private, otherwise the param will not init
@Inject
lateinit var recordContract: RecordContract
override fun onAttach(context: Context) {
super.onAttach(context)
// pass activity instance to dagger for init the param
AndroidSupportInjection.inject(this)
}
}
不断更新中,技术讨论可以留言,谢谢。
end