從零開始Android組件化改造(五) - Dagger2的使用

我的Github:https://github.com/BzCoder
本文基于MVPArms進行分析:https://github.com/JessYanCoding/MVPArms
歡迎各位留言討論

Dagger2算是本框架中學(xué)習(xí)成本最高的第三方組件,很多細節(jié)也確實很難在本文章中一言盡之,本文只是單純整理本人在組件化開發(fā)中對于Dagger2的理解與使用。

Dagger2

Dagger2是一個依賴注入框架,什么是依賴注入?簡單通俗的說,將類的初始化通過注入的方式去實現(xiàn)從而降低類與類之間的耦合度。

常用注釋以及含義:

注解 含義
@Inject 注入
@Binds 指定接口的實現(xiàn)
@Provides 提供實例
@Named 類型一致時,需要用Named來指定Inject與Provides 的關(guān)系
@Singleton 單例
@Component.Builder Component的構(gòu)造方法,詳細規(guī)則見Dagger2源代碼中有關(guān)于@Component.Builder注釋
@BindsInstance 為變量先提前打樁

組件化項目中使用Dagger2

在組件化工程中雖然分為多個模塊,但是組件之中還是存在諸多共用組件(網(wǎng)絡(luò),緩存,圖片加載,生命周期管理,錯誤管理等),我們保持這些組件的單例,但是同時我們也要保證模塊的低耦合性。此時我們就需要靈活使用Dagger2來解決這些問題。

實現(xiàn)方案

設(shè)定一個父類AppComponent。然后我們工程中所有Component都要通過dependencies依賴此Component以便所有組件可以使用全局共用組件。一般在業(yè)務(wù)頁面(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關(guān)聯(lián)了三個Module,對應(yīng)了三大塊實例。

1.AppModule

AppModule是App基礎(chǔ)實例,包含了每個模塊都需要的實例以及Application,Activity,F(xiàn)ragment的管理, 其中還包含了我們之前在從零開始Android組件化改造(四) - 模塊配置的統(tǒng)一管理中提到的ActivityLifecycle。除此之外還包含:

  • Gson
  • Cache
  • ActivityLifecycleCallbacks
  • FragmentLifecycleCallbacks
  • RepositoryManager

2.ClientModule

ClientModule是第三方框架實例,但是與AppModule不同的是,ClientModule的@Provides方法還包含了第三方的框架配置參數(shù)信息,這些參數(shù)方便在各個模塊中對第三方框架進行個性化配置,而這些信息是通過GlobalConfigModule傳入的,當(dāng)然可以根據(jù)實際情況增減,現(xiàn)在第三方主要包含了以下:

  • 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構(gòu)建的一個類,通過從零開始Android組件化改造(四) - 模塊配置的統(tǒng)一管理中收集的ConfigModule將配置收集后,在appDelegate中注入到GlobalConfigModule的Builder中,通過此將所有配置集中到Dagger2中管理,最終通過ClientModule配置到第三方框架中。具體代碼可以在GlobalConfigModule.java查閱。通過
Mainifest->ConfigModule->AppDelegate->GloablConfigModule->ClientModule的路徑,完成各個模塊對于總體工程的配置。

至此我們就介紹完了Dagger2在組件化開發(fā)中使用,其中利用Dagger2完成對于不同模塊對于APP總體配置的實現(xiàn)思路是非常巧妙的。既保證了單一性也保證了靈活性。

4.Dagger2在組件化開發(fā)中遇到的坑

在實際開發(fā)中有這么一個情境,A模塊和B模塊都繼承一個公用abstract BaseFragment,如果不在公用模塊將其實例化的話,就會報XX_MembersInjector.class is repeatedly generated in the wrong package的錯誤,原因是Dagger2會在每個模塊中重新生成一個BaseFragment_MembersInjector.class從而導(dǎo)致類的重復(fù)。解決的方法是在公共模塊寫一個該類的空實現(xiàn)即可解決。在Dagger2的GitHun的issue中也同樣有人提出了這個問題:https://github.com/google/dagger/issues/955

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,461評論 6 532
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,538評論 3 417
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,423評論 0 375
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,991評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 71,761評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,207評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,268評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,419評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,959評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,782評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,983評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,528評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,222評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,653評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,901評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,678評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 47,978評論 2 374

推薦閱讀更多精彩內(nèi)容