Dagger2---用戶引導(dǎo)(翻譯)

原文鏈接:http://google.github.io/dagger/users-guide.html
從Why Dagger 2 is Different 開(kāi)始翻譯赫悄。

為什么Dagger2是不同的

依賴注入的框架在幾年前就已經(jīng)存在了钧栖,有許多中API實(shí)現(xiàn)了依賴和注入。為什么要重復(fù)造輪子呢?Dagger2是第一個(gè)實(shí)現(xiàn)了全部代碼生成菇篡。它的目標(biāo)原則是模仿用戶那些手寫(xiě)的代碼(實(shí)現(xiàn)依賴注入的代碼)使依賴注入的過(guò)程實(shí)現(xiàn)起來(lái)更加簡(jiǎn)單煞额。

使用Dagger2

我們將通過(guò)CoffeeMaker的例子證明Dagger的依賴注入。已經(jīng)完成的代碼可以從coffee example查看荒吏,并進(jìn)行編譯和運(yùn)行敛惊。

聲明依賴

使用Dagger為你的應(yīng)用類構(gòu)造實(shí)例,并且滿足它們的依賴绰更。Dagger使用 javax.inject.Inject
注解標(biāo)明哪些構(gòu)造方法和參數(shù)是需要注解的瞧挤。
使用@Inject注解一個(gè)構(gòu)造方法表示應(yīng)該用Dagger為這個(gè)類創(chuàng)建一個(gè)實(shí)例锡宋。當(dāng)一個(gè)請(qǐng)求為該對(duì)象創(chuàng)建一個(gè)新的實(shí)例時(shí),Dagger會(huì)獲得請(qǐng)求的參數(shù)值然后執(zhí)行該構(gòu)造方法特恬。

class Thermosiphon implements Pump { 
     private final Heater heater;
     @Inject 
     Thermosiphon(Heater heater) { 
         this.heater = heater; 
     }
 ...
}

Dagger也可以直接注解參數(shù)执俩,在這個(gè)例子中將為一個(gè)heater對(duì)象獲得一個(gè) Heater實(shí)例,為pump對(duì)象獲得一個(gè)Pump實(shí)例癌刽。

class CoffeeMaker { 
@Inject 
Heater heater; 
@Inject
Pump pump;
 ...}

如果你用@inject標(biāo)注了參數(shù)役首,但沒(méi)有用@inject標(biāo)注方法。當(dāng)有請(qǐng)求到這些參數(shù)的時(shí)候显拜,Dagger會(huì)為這些對(duì)象提供注入衡奥,但不會(huì)為他們創(chuàng)建實(shí)例。用@inject標(biāo)注一個(gè)無(wú)參的構(gòu)造函數(shù)远荠,以表明Dagger也可以創(chuàng)建一個(gè)實(shí)例矮固。
Dagger同樣也支持方法的注入,盡管通常情況下優(yōu)先考慮的是參數(shù)和構(gòu)造方法矮台。
如果一個(gè)類缺乏@Inject是不能通過(guò)Dagger構(gòu)建的

滿意的依賴

默認(rèn)情況下乏屯,Dagger通過(guò)構(gòu)造請(qǐng)求類型對(duì)象的實(shí)例滿足每一個(gè)依賴。像上面描述(例子)的那樣瘦赫,當(dāng)你請(qǐng)求(需要)一個(gè)CoffeeMaker對(duì)象辰晕,你將通過(guò)調(diào)用new Caffee()對(duì)象獲得一個(gè)對(duì)象,注入到可以注入的參數(shù)中确虱。
但是@Inject不是任何對(duì)象都可以標(biāo)記的

  • interface是不能被構(gòu)建的
  • 第三方的類不能被注解
  • 通過(guò)配置得到的對(duì)象含友,仍然必須通過(guò)配置得到(Builder模式構(gòu)造的對(duì)象)

在這些情況下,@Inject是不足的(尷尬的)校辩,但是可以通過(guò)使用@Provide注解標(biāo)注的方法來(lái)滿足依賴窘问,這個(gè)方法的返回值的來(lái)滿足那些依賴。

就像下面這樣:當(dāng)需要一個(gè)Heater對(duì)象時(shí)provideHeater()方法會(huì)被執(zhí)行宜咒。

@Provides 
static Heater provideHeater() { 
    return new ElectricHeater();
}

@Provides同樣可以為它自己提供依賴惠赫,當(dāng)我們需要一個(gè)Pump對(duì)象時(shí),下面這個(gè)例子返回一個(gè)Thermosiphon對(duì)象時(shí)

@Provides 
static Pump providePump(Thermosiphon pump) {
  return pump;
}

所有被標(biāo)注了@Provides注解的方法必須要屬于一個(gè)module類(模塊)故黑,這僅僅需要一個(gè)類被@module注解標(biāo)注儿咱。

@Module
class DripCoffeeModule { 
@Provides
 static Heater provideHeater() { 
    return new ElectricHeater();
 } 
@Provides 
static Pump providePump(Thermosiphon pump) {
    return pump; 
 }
}

注:通常@Provides標(biāo)注的方法名都擁有provide前綴,@Module標(biāo)注的類都有一個(gè)叫做Module的后綴场晶。

構(gòu)建對(duì)象關(guān)系圖

@Inject注解和@Provides注解類由他們之間的依賴關(guān)系形成了對(duì)關(guān)系的圖混埠,通過(guò)一組定義好的關(guān)系圖調(diào)用代碼就像使用應(yīng)用程序的main方法或者Android的應(yīng)用程序訪問(wèn)。它的定義是通過(guò)一個(gè)接口:具備無(wú)參的方法和需要的返回值類型诗轻。通過(guò)使用@component注解去標(biāo)注這樣一個(gè)接口和通過(guò)module參數(shù)去配置module類型钳宪,Dagger2隨后會(huì)生成一個(gè)符合的實(shí)現(xiàn)。

@Component(modules = DripCoffeeModule.class)
interface CoffeeShop { 
   CoffeeMaker maker();
}

Dagger2會(huì)自動(dòng)為它生成實(shí)現(xiàn)類,實(shí)現(xiàn)的名字是具有Dagger的前綴加上接口的名稱吏颖。通過(guò)使用builder方法獲得實(shí)例搔体。調(diào)用Builder方法配置依賴,調(diào)用build方法獲得實(shí)例侦高。

CoffeeShop coffeeShop = DaggerCoffeeShop.builder() .dripCoffeeModule(new DripCoffeeModule()) .build();
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末嫉柴,一起剝皮案震驚了整個(gè)濱河市厌杜,隨后出現(xiàn)的幾起案子奉呛,更是在濱河造成了極大的恐慌,老刑警劉巖夯尽,帶你破解...
    沈念sama閱讀 211,817評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件瞧壮,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡匙握,警方通過(guò)查閱死者的電腦和手機(jī)咆槽,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,329評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)圈纺,“玉大人秦忿,你說(shuō)我怎么就攤上這事《耆ⅲ” “怎么了灯谣?”我有些...
    開(kāi)封第一講書(shū)人閱讀 157,354評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)蛔琅。 經(jīng)常有香客問(wèn)我胎许,道長(zhǎng),這世上最難降的妖魔是什么罗售? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,498評(píng)論 1 284
  • 正文 為了忘掉前任辜窑,我火速辦了婚禮,結(jié)果婚禮上寨躁,老公的妹妹穿的比我還像新娘穆碎。我一直安慰自己,他們只是感情好职恳,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,600評(píng)論 6 386
  • 文/花漫 我一把揭開(kāi)白布所禀。 她就那樣靜靜地躺著,像睡著了一般话肖。 火紅的嫁衣襯著肌膚如雪北秽。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 49,829評(píng)論 1 290
  • 那天最筒,我揣著相機(jī)與錄音贺氓,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛辙培,可吹牛的內(nèi)容都是我干的蔑水。 我是一名探鬼主播,決...
    沈念sama閱讀 38,979評(píng)論 3 408
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼扬蕊,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼搀别!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起尾抑,我...
    開(kāi)封第一講書(shū)人閱讀 37,722評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤歇父,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后再愈,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體榜苫,經(jīng)...
    沈念sama閱讀 44,189評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,519評(píng)論 2 327
  • 正文 我和宋清朗相戀三年翎冲,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了垂睬。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,654評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡抗悍,死狀恐怖驹饺,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情缴渊,我是刑警寧澤赏壹,帶...
    沈念sama閱讀 34,329評(píng)論 4 330
  • 正文 年R本政府宣布,位于F島的核電站疟暖,受9級(jí)特大地震影響卡儒,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜俐巴,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,940評(píng)論 3 313
  • 文/蒙蒙 一骨望、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧欣舵,春花似錦擎鸠、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,762評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至糟把,卻和暖如春绢涡,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背遣疯。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,993評(píng)論 1 266
  • 我被黑心中介騙來(lái)泰國(guó)打工雄可, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,382評(píng)論 2 360
  • 正文 我出身青樓数苫,卻偏偏與公主長(zhǎng)得像聪舒,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子虐急,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,543評(píng)論 2 349

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