Dagger與注入

淺談注入的理解

什么是注入

注入通常作為一個完整框架嵌入到一個項目中,提供一種新的隱式對象初始化方式颓屑,通過配置文件、注解等方式指定的變量對象庵佣,將由該注入框架負責(zé)初始化工作抛蚤,提供(新建或單例等)合適的特定實現(xiàn)類對象仪际,從代碼上看州既,聲明注入對象的類不再需要初始化該字段浙值,即可直接使用陕凹。

注入過程

  1. 定義 interface 接口
  2. 提供接口實現(xiàn)類
  3. 配置實現(xiàn)類作為接口對象提供方
  4. 通過注入框架悍抑,初始化(注入)所需的可注入類型字段變量

優(yōu)點

注入模式主要用于以近乎靜態(tài)配置的方式,自動構(gòu)造(new)對象并提供調(diào)用方使用杜耙,簡化搜骡、隱藏繁瑣的對象初始化代碼,提供對象初始化級別上的隔離佑女,實現(xiàn)更純粹的面向接口編程记靡,通過對接口型變量進行注入,最終完成從對象變量团驱、方法調(diào)用與具體實現(xiàn)類之間的完全解耦摸吠。因此,可完全透明地更換實現(xiàn)類而無需修改其他調(diào)用類代碼嚎花,同時也為單體測試提供更合適的 Mock 入口寸痢。

尤其當(dāng)目標對象比較泛用時,可大量減少重復(fù)性的模板構(gòu)造代碼紊选,相當(dāng)于一個隱式自動裝配工廠啼止。

適用場景

注入框架自動完成對象初始化,通常主要通過靜態(tài)方式進行指定配置兵罢,因此產(chǎn)生的對象都是模板級別的產(chǎn)品献烦。

適合用于注入的對象屬于不太需要動態(tài)變換構(gòu)造參數(shù)值的類,例如以下幾種:

  • 實體類
  • 容器類
  • 單例工具類

缺點

隨著解耦程度越高卖词,代碼的調(diào)用關(guān)系越模糊巩那,越難以通過 IDE 跟蹤具體實現(xiàn)代碼的邏輯調(diào)用鏈,由于調(diào)用關(guān)系交由注入框架內(nèi)部邏輯控制并對使用者隱藏,使得接手項目的程序員更難以閱讀代碼拢操,并理解其中的整個調(diào)用鏈關(guān)系圖譜,同時也為代碼調(diào)試舶替、重構(gòu)增加了難度令境,并有可能引入難以預(yù)知的潛在Bug。


Dagger

Square 公司開源的一套針對 Android 平臺的注入框架顾瞪。
使用該框架需要顯式聲明可注入對象工廠方法舔庶、Module、目標注入類直接的關(guān)系陈醒,用于提供完整的編譯時驗證惕橙,任何缺失、未使用的注入綁定將報告錯誤钉跷。

主要概念

  • ObjectGraph:依賴與注入的管理核心類弥鹦,管理單元為 Module
  • @Module + @Provides:用于聲明提供可注入對象的工廠類及其方法
  • @Inject:用于聲明需要注入的對象變量
  • @Module(injects={class...}):綁定當(dāng)前 Module 與目標注入類
  • ObjectGraph.inject:在目標注入類中主動調(diào)用,注入 Module 提供的對象

使用方式

  • 使用 @Module + @Provides 注解工廠類及其工廠方法爷辙,其中工廠方法需要以provide開頭命名
  • 使用 @Inject 注解字段對象彬坏,Dagger 通過ObjectGraph.inject方法進行自動注入
  • (可選)使用 @Inject 注解類構(gòu)造器,作為 Dagger 產(chǎn)生可注入對象的默認工廠方法膝晾,方法參數(shù)將從其依附的 Module 注入樹中進行提取
  • 初始化 ObjectGraph:ObjectGraph.create(modules...)
  • 使用 ObjectGraph 自動注入對象:objectGraph.inject(this)
  • 從 ObjectGraph 中提取對象:objectGraph.get(class)

@Module聲明

@Module 注解用于任意一個普通類栓始,聲明其為 Module 類并包含一系列 @Provides 注解的方法,用以提供該類型的可注入對象(工廠方法)血当。

@Module 包含以下幾個字段:

  • includes = {Modules...}:組合其他 Modules(及其所有子 Modules)
  • addsTo = class:(可選)當(dāng)前 Module 可通過 ObjectGraph.plus() 方法依附到的目標宿主類
  • overrides = boolean:當(dāng)前 Module 聲明的 Provide 方法可覆蓋其他 Module 的相同工廠方法幻赚,應(yīng)僅用于測試或開發(fā)環(huán)境
  • complete = boolean:當(dāng)前 Module 中 Provide 方法的參數(shù)需要由(不存在 includes 及 addsTo 列表中的)外層 Module 提供時,聲明為 false臊旭,表示該 Module 作為抽象父類提供擴展
  • library = boolean:當(dāng)前 Module 中存在額外的 Provide 方法落恼,不需要注入到目標 injects 對象時,聲明為 true
  • injects = {class...}:當(dāng)前 Module 適配的目標類离熏,這些類可由當(dāng)前 Module 提供注入對象领跛,并用于 objectGraph.injectobjectGraph.get 方法

注意

  • @Inject 注解字段變量時,不可以聲明為 private 或 final
  • @Inject 只能注解一個構(gòu)造器
  • 在使用 @Inject 注解字段對象的類中撤奸,可省略對無參構(gòu)造函數(shù)的 @Inject 注解
  • 所有注入點必須在 @Module(injects) 中列出

Provider注入

Provider 作為 JSR330 標準接口吠昭,用于包裝一個注入對象,每次調(diào)用 get() 方法時產(chǎn)生一個新對象返回胧瓜。

使用 Provider 注入時矢棚,只需提供 Provider 包裝的目標對象 provide 方法,Provider 將由 Dagger 進行自動封裝提供府喳。

@Inject Provider<Filter> filterProvider;

void method(){
    filterProvider.get();
    ...
}

或

@Provides
public ObjInf provideObj(Provider<ObjImpl> p) {
    return p.get();
}

由于容易產(chǎn)生難讀代碼蒲肋,Dagger 不推薦濫用 Provider,除非在應(yīng)對遺留代碼問題等非正常場合。

參考

Dagger - square
Dagger——Android上的依賴注入框架


Dagger2

Google 基于 Dagger1 進行二次開發(fā)的注入框架兜粘,現(xiàn)在已被 Square 承認用于取代 Dagger1 的新版本申窘。

與 Dagger1 對比

Dagger1

  • 優(yōu)點:
    提供編譯時驗證
    自動生成代碼,提供完整調(diào)用追蹤孔轴,方便調(diào)試(與Guice比較)

  • 缺點:
    自動生成代碼質(zhì)量低剃法,不易閱讀
    使用了反射
    對象依賴圖效率低,生成過程不可追蹤
    使用映射表式的API(@Module 配置等)
    Scope 僅支持 @Singleton

Dagger2

  • 優(yōu)點:
    完全不使用反射
    完全可追蹤路鹰,并保證自動生成代碼可讀性
    簡化API
    提高性能贷洲,比 Dagger1 快13%
    支持方法注入
    支持自定義 Scope
    提供隱式 null 檢測(除非聲明為 @Nullable)

@Module

所有 @Module 均定義為 complete = false & library = true,不再需要 complete晋柱、library优构、addsTo、injects雁竞、staticInjections 的屬性指定钦椭,編譯時將使用寬松驗證。

同時碑诉,overrides 和靜態(tài)注入將不再提供支持玉凯。要實現(xiàn)相同功能,可考慮派生目標 Module 子類提供新對象联贩。

includes 屬性仍然可用漫仆。

ObjectGraph

ObjectGraph 可通過 Module 的 class 或?qū)嵗龑ο筮M行初始化創(chuàng)建。

ObjectGraph.create(ModuleOne.class, ModuleTwo.class, new ModuleThree("hello!"));

Component

Component 提供另外一種方式泪幌,組織 Modules 并構(gòu)建 ObjectGraph盲厌。
在 Component 接口中定義方法,與在 Dagger1 中聲明 @Module(injects) 效果相同祸泪。

@Component(
  modules = {
    ModuleOne.class,
    ModuleTwo.class,
    ModuleThree.class,
  }
)
interface MyComponent {
  /* Functionally equivalent to objectGraph.get(Foo.class). */
  Foo getFoo();
  /* Functionally equivalent to objectGraph.get(Bar.class). */
  Bar getBar();
  /* Functionally equivalent to objectGraph.inject(aBaz). */
  Baz injectBaz(Baz baz);
}

// 實例化 Component
// Dagger2 自動生成 MyComponent 的接口實現(xiàn)吗浩,并以 Dagger 為前綴命名
MyComponent myComponent = DaggerMyComponent.create();

// 使用 Module 實例進行初始化時,通過這種方式實例化 Component
MyComponent myComponent = DaggerMyComponent.builder()
    // ModuleOne and ModuleTwo don't need to be set explicitly
    .moduleThree(new ModuleThree("hello!"))
    .build();

注意

注入點與 provide 方法均需要考慮指定 @Nullable没隘,否則編譯時 null 驗證失敗時將拋出錯誤懂扼。

參考

Dagger2 - Google github
更加強大的Dagger2

dagger2 讓你愛不釋手:基礎(chǔ)依賴注入框架篇
dagger2 讓你愛不釋手:重點概念講解、融合篇
dagger2 讓你愛不釋手:終結(jié)篇

【騰訊Bugly干貨分享】深入理解 ButterKnife右蒲,讓你的程序?qū)W會寫代碼

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末阀湿,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子瑰妄,更是在濱河造成了極大的恐慌陷嘴,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,270評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件间坐,死亡現(xiàn)場離奇詭異灾挨,居然都是意外死亡邑退,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,489評論 3 395
  • 文/潘曉璐 我一進店門劳澄,熙熙樓的掌柜王于貴愁眉苦臉地迎上來地技,“玉大人,你說我怎么就攤上這事秒拔∧#” “怎么了?”我有些...
    開封第一講書人閱讀 165,630評論 0 356
  • 文/不壞的土叔 我叫張陵溯警,是天一觀的道長趣苏。 經(jīng)常有香客問我狡相,道長梯轻,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,906評論 1 295
  • 正文 為了忘掉前任尽棕,我火速辦了婚禮喳挑,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘滔悉。我一直安慰自己伊诵,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,928評論 6 392
  • 文/花漫 我一把揭開白布回官。 她就那樣靜靜地躺著曹宴,像睡著了一般。 火紅的嫁衣襯著肌膚如雪歉提。 梳的紋絲不亂的頭發(fā)上笛坦,一...
    開封第一講書人閱讀 51,718評論 1 305
  • 那天,我揣著相機與錄音苔巨,去河邊找鬼版扩。 笑死,一個胖子當(dāng)著我的面吹牛侄泽,可吹牛的內(nèi)容都是我干的礁芦。 我是一名探鬼主播,決...
    沈念sama閱讀 40,442評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼悼尾,長吁一口氣:“原來是場噩夢啊……” “哼柿扣!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起闺魏,我...
    開封第一講書人閱讀 39,345評論 0 276
  • 序言:老撾萬榮一對情侶失蹤窄刘,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后舷胜,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體娩践,經(jīng)...
    沈念sama閱讀 45,802評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡活翩,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,984評論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了翻伺。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片材泄。...
    茶點故事閱讀 40,117評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖吨岭,靈堂內(nèi)的尸體忽然破棺而出拉宗,到底是詐尸還是另有隱情,我是刑警寧澤辣辫,帶...
    沈念sama閱讀 35,810評論 5 346
  • 正文 年R本政府宣布旦事,位于F島的核電站,受9級特大地震影響急灭,放射性物質(zhì)發(fā)生泄漏姐浮。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,462評論 3 331
  • 文/蒙蒙 一葬馋、第九天 我趴在偏房一處隱蔽的房頂上張望卖鲤。 院中可真熱鬧,春花似錦畴嘶、人聲如沸蛋逾。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,011評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽区匣。三九已至,卻和暖如春蒋院,著一層夾襖步出監(jiān)牢的瞬間亏钩,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,139評論 1 272
  • 我被黑心中介騙來泰國打工悦污, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留铸屉,地道東北人。 一個月前我還...
    沈念sama閱讀 48,377評論 3 373
  • 正文 我出身青樓切端,卻偏偏與公主長得像彻坛,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子踏枣,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,060評論 2 355

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