从零开始Android组件化改造(五) - Dagger2的使用

我的Github:https://github.com/BzCoder
本文基于MVPArms进行分析:https://github.com/JessYanCoding/MVPArms
欢迎各位留言讨论

Dagger2算是本框架中学习成本最高的第三方组件,很多细节也确实很难在本文章中一言尽之,本文只是单纯整理本人在组件化开发中对于Dagger2的理解与使用。

Dagger2

Dagger2是一个依赖注入框架,什么是依赖注入?简单通俗的说,将类的初始化通过注入的方式去实现从而降低类与类之间的耦合度。

常用注释以及含义:

注解 含义
@Inject 注入
@Binds 指定接口的实现
@Provides 提供实例
@Named 类型一致时,需要用Named来指定Inject与Provides 的关系
@Singleton 单例
@Component.Builder Component的构造方法,详细规则见Dagger2源代码中有关于@Component.Builder注释
@BindsInstance 为变量先提前打桩

组件化项目中使用Dagger2

在组件化工程中虽然分为多个模块,但是组件之中还是存在诸多共用组件(网络,缓存,图片加载,生命周期管理,错误管理等),我们保持这些组件的单例,但是同时我们也要保证模块的低耦合性。此时我们就需要灵活使用Dagger2来解决这些问题。

实现方案

设定一个父类AppComponent。然后我们工程中所有Component都要通过dependencies依赖此Component以便所有组件可以使用全局共用组件。一般在业务页面(Fragment,Activity)中可以这样按以下使用。

@xxxxxScope
@Component(modules = xxxxFragmentModule.class, dependencies = AppComponent.class)
public interface xxxxxFragmentComponent {
    void inject(xxxxFragment fragment);
    @Component.Builder
    interface Builder {
        @BindsInstance
        xxxxtComponent.Builder view(NewsListContract.View view);
        xxxxComponent.Builder appComponent(AppComponent appComponent);
        xxxxComponent build();
    }
}

其中AppComponent关联了三个Module,对应了三大块实例。

1.AppModule

AppModule是App基础实例,包含了每个模块都需要的实例以及Application,Activity,Fragment的管理, 其中还包含了我们之前在从零开始Android组件化改造(四) - 模块配置的统一管理中提到的ActivityLifecycle。除此之外还包含:

  • Gson
  • Cache
  • ActivityLifecycleCallbacks
  • FragmentLifecycleCallbacks
  • RepositoryManager

2.ClientModule

ClientModule是第三方框架实例,但是与AppModule不同的是,ClientModule的@Provides方法还包含了第三方的框架配置参数信息,这些参数方便在各个模块中对第三方框架进行个性化配置,而这些信息是通过GlobalConfigModule传入的,当然可以根据实际情况增减,现在第三方主要包含了以下:

  • OkHttpClient
  • Retrofit
  • RxCache
  • RxErrorHandler
  • Interceptor
    以下代码为RxCache的注入,其他第三方组件写法也类似。方法中包含RxCacheConfiguration接口,也就是RxCache的配置信息,这些信息需要在下面的GlobalConfigModule中取得,通过 configuration.configRxCache(application, builder);对RxCache进行配置。
    @Singleton
    @Provides
    static RxCache provideRxCache(Application application, @Nullable RxCacheConfiguration configuration
            , @Named("RxCacheDirectory") File cacheDirectory, Gson gson) {
        RxCache.Builder builder = new RxCache.Builder();
        RxCache rxCache = null;
        if (configuration != null) {
            rxCache = configuration.configRxCache(application, builder);
        }
        if (rxCache != null) return rxCache;
        return builder
                .persistence(cacheDirectory, new GsonSpeaker(gson));
    }

3.GlobalConfigModule

GlobalConfigModule是包含配置信息的Module,利用建造者模式+Dagger2构建的一个类,通过从零开始Android组件化改造(四) - 模块配置的统一管理中收集的ConfigModule将配置收集后,在appDelegate中注入到GlobalConfigModule的Builder中,通过此将所有配置集中到Dagger2中管理,最终通过ClientModule配置到第三方框架中。具体代码可以在GlobalConfigModule.java查阅。通过
Mainifest->ConfigModule->AppDelegate->GloablConfigModule->ClientModule的路径,完成各个模块对于总体工程的配置。

至此我们就介绍完了Dagger2在组件化开发中使用,其中利用Dagger2完成对于不同模块对于APP总体配置的实现思路是非常巧妙的。既保证了单一性也保证了灵活性。

4.Dagger2在组件化开发中遇到的坑

在实际开发中有这么一个情境,A模块和B模块都继承一个公用abstract BaseFragment,如果不在公用模块将其实例化的话,就会报XX_MembersInjector.class is repeatedly generated in the wrong package的错误,原因是Dagger2会在每个模块中重新生成一个BaseFragment_MembersInjector.class从而导致类的重复。解决的方法是在公共模块写一个该类的空实现即可解决。在Dagger2的GitHun的issue中也同样有人提出了这个问题:https://github.com/google/dagger/issues/955

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

推荐阅读更多精彩内容