Dagger Android 使用解惑

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 分两类,一类是要注入的对象,一类是要被注入的对象的对象。

  1. 要注入的对象,比如全局单例就直接加在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用注入的方式来注入,不能直接生产吗??下次再解析。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容