Dagger已经发展好几年了,好多项目和开源项目都使用到了,但是也发生了好多次版本的更新。
学习肯定要学习最新的。之前老的也就不提了,最好学习新的时候忘记老的使用方式,不然心中会有一万只为什么奔腾。
我们以google 的示例项目“GithubBrowserSample”来学习。
几个重要的类
@Singleton
@Component(
modules = [
AndroidInjectionModule::class,
AppModule::class,
MainActivityModule::class]
)
interface AppComponent {
@Component.Builder
interface Builder {
@BindsInstance
fun application(application: Application): Builder
fun build(): AppComponent
}
fun inject(githubApp: GithubApp)
}
@Module(includes = [ViewModelModule::class, TestModel::class])
class AppModule {
@Singleton
@Provides
fun provideGithubService(): GithubService {
return Retrofit.Builder()
.baseUrl("https://api.github.com/")
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(LiveDataCallAdapterFactory())
.build()
.create(GithubService::class.java)
}
...
}
@Suppress("unused")
@Module
abstract class ViewModelModule {
@Binds
@IntoMap
@ViewModelKey(UserViewModel::class)
abstract fun bindUserViewModel(userViewModel: UserViewModel): ViewModel
...
}
@Suppress("unused")
@Module
abstract class FragmentBuildersModule {
@ContributesAndroidInjector
abstract fun contributeRepoFragment(): RepoFragment
@ContributesAndroidInjector
abstract fun contributeUserFragment(): UserFragment
@ContributesAndroidInjector
abstract fun contributeSearchFragment(): SearchFragment
}
就这几个类了,把这个几个类搞清楚了,其它的也就没问题了。
看到这几个类,有几个新的东西:
1.AppComponent 的结构
2.AndroidInjectionModule
3.@Binds @IntoMap
4.@ContributesAndroidInjector
好,一个一个来
1.AppComponent
这个不用解析,记住就行了,记不住就copey来,就跟创建对象为什么要new 一样,就是一个新的写法!
2.AndroidInjectionModule
这是表明对啥类型的组件进行注入,除了这个还有AndroidInjectionModule,看下代码发现是对v4包里面的Fragment的包进行操作,不信的可以自己看下代码。
3.@Binds @IntoMap
这是一种新的写法,会把所有要注入的示例多加到一个集合里面,并且key是可以自己定义的比如上面的
@Binds
@IntoMap
@ViewModelKey(UserViewModel::class)
abstract fun bindUserViewModel(userViewModel: UserViewModel): ViewModel
而且使用了这种形式之后最后一定要加上
@Binds
abstract fun bindViewModelFactory(factory: GithubViewModelFactory): ViewModelProvider.Factory
也就是把集合传到那个实例里面,不然会 编译不过的,记住就行了。
4.@ContributesAndroidInjector
这个注解是针对要注入的四大组件,比如你要MainActivity实行注入
@ContributesAndroidInjector(modules = [FragmentBuildersModule::class])
abstract fun contributeMainActivity(): MainActivity
对Service实行注入
@ContributesAndroidInjector
abstract fun contributeService(): MyService
四大组件都是可以的,包含Fragment也是可以的
比如
@ContributesAndroidInjector
abstract fun contributeRepoFragment(): RepoFragment
完了,这样就完了,三分钟。。。
不,绝对不能三分钟
来一波总结
这次改版后只要在Application中这样写
class GithubApp : Application(), HasActivityInjector {
@Inject
lateinit var dispatchingAndroidInjector: DispatchingAndroidInjector<Activity>
override fun onCreate() {
super.onCreate()
DaggerAppComponent.builder().application(this)
.build().inject(this)
}
override fun activityInjector() = dispatchingAndroidInjector
}
Activity里面一句话就可以了
AndroidInjection.inject(activity)
是不是膜拜google大神。。。。
也就是这次把那些模板代码也给省了,省了之后也就更难懂了,更难懂了也就更容易维护了,这就是架构。
我把现在的Dagger 分两类,一类是要注入的对象,一类是要被注入的对象的对象。
- 要注入的对象,比如全局单例就直接加在AppComponent 中的Modules里面
@Singleton
@Component(
modules = [
AndroidInjectionModule::class,
AppModule::class,
MainActivityModule::class]
)
interface AppComponent {
@Component.Builder
interface Builder {
@BindsInstance
fun application(application: Application): Builder
fun build(): AppComponent
}
fun inject(githubApp: GithubApp)
}
AppModule
@Module(includes = [ViewModelModule::class, TestModel::class])
class AppModule {
@Singleton
@Provides
fun provideGithubService(): GithubService {
return Retrofit.Builder()
.baseUrl("https://api.github.com/")
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(LiveDataCallAdapterFactory())
.build()
.create(GithubService::class.java)
}
@Singleton
@Provides
fun provideDb(app: Application): GithubDb {
return Room
.databaseBuilder(app, GithubDb::class.java, "github.db")
.fallbackToDestructiveMigration()
.build()
}
@Singleton
@Provides
fun provideUserDao(db: GithubDb): UserDao {
return db.userDao()
}
@Singleton
@Provides
fun provideRepoDao(db: GithubDb): RepoDao {
return db.repoDao()
}
}
然后其他的不是单例的就放在AppModule的includes 里面,其实也是可以放在AppComponent的modules 里面的比如把TestModel::class 放到AppModule同一个地方就可以了,最后生成的代码就是类名不一样,里面的代码都是一样的。(最好自己结合生成的代码来理解)
@Singleton
@Component(
modules = [
AndroidInjectionModule::class,
AppModule::class,
MainActivityModule::class,
TestModel::class]
)
interface AppComponent {
@Component.Builder
interface Builder {
@BindsInstance
fun application(application: Application): Builder
fun build(): AppComponent
}
fun inject(githubApp: GithubApp)
}
@Module
class TestModel {
@Provides
fun provideDBUtil(): DBUtil {
return DBUtil()
}
}
效果都是一样的。
2.要被注入的对象的对象
这一类就是四大组件和Fragment了
写法就是@ContributesAndroidInjector 这个注解了
只要是要注入的就用这个注解写
比如
@Suppress("unused")
@Module
abstract class MainActivityModule {
@ContributesAndroidInjector(modules = [FragmentBuildersModule::class])
abstract fun contributeMainActivity(): MainActivity
}
@Suppress("unused")
@Module
abstract class FragmentBuildersModule {
@ContributesAndroidInjector
abstract fun contributeRepoFragment(): RepoFragment
@ContributesAndroidInjector
abstract fun contributeUserFragment(): UserFragment
@ContributesAndroidInjector
abstract fun contributeSearchFragment(): SearchFragment
}
Activity 包含了Fragment 所以把fragment的加在方法上面
@ContributesAndroidInjector(modules = [FragmentBuildersModule::class])
放出来也一样的
比如
@Suppress("unused")
@Module
abstract class MainActivityModule {
@ContributesAndroidInjector(modules = [FragmentBuildersModule::class])
abstract fun contributeMainActivity(): MainActivity
@ContributesAndroidInjector
abstract fun contributeRepoFragment(): RepoFragment
}
我们就可以把多个Activity都用的放出来,只在一个Activity里面用的就放到@ContributesAndroidInjector里面去,这样结构会比较清晰。
只要理解了这两类对象,再遇到Dagger应该就不会一万个为什么了。这是个人的理解,难免有错误的,如果有希望指出,谢谢大家!
这次就先这样了,以后就知道怎么写了,按照这两类这样写就行了,下次再分析为什么要把ViewModel用注入的方式来注入,不能直接生产吗??下次再解析。