Android Dagger2(基礎篇)

對Dagger2從入門到放棄再到恍然大悟。
第一次接觸這個框架的時候,在網(wǎng)上看了十幾篇文章。看完之后的感受是,二臉懵逼,完全不曉得寫的是什么。
然后過了一段時間,又嘗試著去了解,并且一邊照著別人家的demo依葫蘆畫瓢,但是后來發(fā)現(xiàn),寫不下去,我不曉得我這些代碼寫的是什么意思,然后有扔一邊了。
第三次,又心血來潮,靜下心來硬著頭皮反復看,突然有一絲說是靈感?思路?猜測?立馬抓住,然后整條線立馬完整的串起來了。


添加依賴

//project
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
//app
apply plugin: 'com.neenbedankt.android-apt'
apt 'com.google.dagger:dagger-compiler:2.5'
compile 'com.google.dagger:dagger:2.5'
provided 'org.glassfish:javax.annotation:10.0-b28'

如果要和ButterKnife一起用

packagingOptions {    
    exclude 'META-INF/services/javax.annotation.processing.Processor'
}

//apt改為provided
//apt 'com.google.dagger:dagger-compiler:2.5'
provided 'com.google.dagger:dagger-compiler:2.5'

我發(fā)現(xiàn)我之前看這個框架一直沒看懂,有一個原因是太局限于代碼。就是說,框架的使用是為了讓我們打代碼更簡單更容易,而不是為了逼格高(當然逼格確實會變高=。=但是這不是主要目的)從最原始的角度出發(fā),框架都是用來達成某種目的的。Dagger2的目的是依賴注入,說白一點,就是實例化對象,說清楚一點,就是你叫Dagger2幫你實例化對象,這就是最直接的目的,所有的Class和Annotation都是為了達到這個目的輔助工具,所以不必去糾結(jié)這些。下面先舉個例子。。。


比如現(xiàn)在有Fruit,SaladDressing,F(xiàn)ruitSalad三個類,水果,沙拉醬,水果沙拉

public class FruitSalad {    
    private SaladDressing saladDressing;    
    private Fruit fruit;    
   
    @Inject
    public FruitSalad(SaladDressing saladDressing, Fruit fruit) {        
        this.saladDressing = saladDressing;        
        this.fruit = fruit;    
    }    
}

public class SaladDressing {
}

public class Fruit {
}

好了現(xiàn)在我們自己做一份FruitSalad

FruitSalad fruitSalad = new FruitSalad(new SaladDressing(), new Fruit());

但是我不想自己做,我需要Dagger2幫我做一份。當然FruitSalad(水果沙拉)需要SaladDressing(沙拉醬)和Fruit(水果)才能做,所以SaladDressing(沙拉醬)和Fruit(水果)我依舊自己提供。
不過Dagger2也有自己的規(guī)則,如果想要幫忙做FruitSalad(水果沙拉),那么你不但需要提供SaladDressing(沙拉醬)和Fruit(水果)的實例,還要把SaladDressing(沙拉醬)和Fruit(水果)放到Module中。
或者說,你們需要約定一個地方,你把SaladDressing(沙拉醬)和Fruit(水果)放到那個地方,Dagger2從那個地方去取SaladDressing(沙拉醬)和Fruit(水果),用來做FruitSalad(水果沙拉),那個地方就是Module。

@Module
public class FruitSaladModule {    
    private final SaladDressing saladDressing;    
    private final Fruit fruit;    

    public FruitSaladModule(SaladDressing saladDressing, Fruit fruit) {        
        this.saladDressing = saladDressing;        
        this.fruit = fruit;    
    }    

    //提供沙拉醬
    @FruitSaladScope    
    @Provides    
    SaladDressing provideSaladDressing() {        
        return saladDressing;    
    }    

    //提供水果
    @FruitSaladScope    
    @Provides    
    Fruit provideFruit() {        
        return fruit;    
    }
}

使用@Module表明這是一個Module
使用@Provides表明提供這些依賴
現(xiàn)在我把Module準備好了,那我怎么讓Dagger2幫我做FruitSalad(水果沙拉)呢?這個時候就需要Component了

@FruitSaladScope
@Component(modules = FruitSaladModule.class)
public interface FruitSaladComponent {    
    void inject(MainActivity activity);
}

FruitSaladComponent告訴了Dagger2做FruitSalad(水果沙拉)需要的Module是FruitSaladModule,那里有SaladDressing(沙拉醬)和Fruit(水果)可以拿。需要注入到MainActivity,我需要在MainActivity拿到FruitSalad。
使用@Component表示這是一個Component
modules={}表示可以用哪些Module去拿需要的依賴

DaggerFruitSaladComponent.builder()        
    .fruitSaladModule(new FruitSaladModule(new SaladDressing(), new Fruit()))        
    .build().inject(this);

接下來你只要把Module交給Dagger2,Dagger2就會幫你做FruitSalad(水果沙拉)了,而且SaladDressing(沙拉醬)和Fruit(水果)都是我自己提供的。
然后現(xiàn)在有人和我說,你的SaladDressing(沙拉醬)我包了,所以我就只需要提供Fruit(水果)就夠了,而且我自己不做,那SaladDressing(沙拉醬)就讓Dagger2幫我保管,我只要告訴他SaladDressing(沙拉醬)去哪里拿就好了。

@Module
public class SaladDressingModule {    
    private final SaladDressing saladDressing;   
 
    public SaladDressingModule(SaladDressing saladDressing) {        
        this.saladDressing = saladDressing;    
    }    

    @SaladDressingScope    
    @Provides    
    SaladDressing provideSaladDressing() {        
        return saladDressing;    
    }
}

@SaladDressingScope
@Component(modules = SaladDressingModule.class)
public interface SaladDressingComponent {    
    SaladDressing getSaladDressing();
}

所以現(xiàn)在我把SaladDressing(沙拉醬)放到了SaladDressingModule里,Dagger2用SaladDressingComponent就可以拿到了

SaladDressingComponent saladDressingComponent = DaggerSaladDressingComponent.builder()        
    .saladDressingModule(new SaladDressingModule(別人給的saladDressing))
    .build();

既然我不需要自己提供SaladDressing(沙拉醬)那么FruitSaladModule和FruitSaladComponent應該修改一下

@Module
public class FruitSaladModule { 
    private final Fruit fruit; 

    public FruitSaladModule(Fruit fruit) { 
        this.fruit = fruit; 
    } 

    //提供水果 
    @FruitSaladScope 
    @Provides 
    Fruit provideFruit() { 
        return fruit; 
    }
}

@FruitSaladScope
@Component(dependencies = SaladDressingComponent.class, modules = FruitSaladModule.class)
public interface FruitSaladComponent { 
    void inject(MainActivity activity);
}

這樣,SaladDressing(沙拉醬)我交給Dagger2保管,通過SaladDressingComponent就可以拿到,F(xiàn)ruit(水果)依舊會提供給FruitSaladModule

DaggerFruitSaladComponent.builder()        
    .saladDressingComponent(saladDressingComponent)        
    .fruitSaladModule(new FruitSaladModule(new Fruit()))        
    .build().inject(this);

dependencies={}告訴Dagger2可以去別的Component找需要的依賴,把代碼補全差不多這樣

@Inject
FruitSalad fruitSalad;

SaladDressingComponent saladDressingComponent = DaggerSaladDressingComponent.builder() 
    .saladDressingModule(new SaladDressingModule(別人給的saladDressing)) 
    .build();

DaggerFruitSaladComponent.builder()        
    .saladDressingComponent(saladDressingComponent)        
    .fruitSaladModule(new FruitSaladModule(new Fruit()))        
    .build().inject(this);

現(xiàn)在我又想要VegetableSalad(蔬菜沙拉)了,繼續(xù)讓Dagger2幫我做,反正SaladDressing(沙拉醬)已經(jīng)有了,我只要提供蔬菜就好了

@Module
public class VegetableSaladModule { 
    private final Vegetable vegetable; 

    public VegetableSaladModule(Vegetable vegetable) { 
        this.vegetable = vegetable; } 

    //提供蔬菜  
    @VegetableSaladScope 
    @Provides 
    Vegetable provideVegetable() { 
        return vegetable; 
    }
}

@VegetableSaladScope
@Component(dependencies = SaladDressingComponent.class, modules = VegetableSaladModule.class)
public interface VegetableSaladComponent { 
    void inject(MainActivity activity);
}

加一段代碼

@Inject
FruitSalad fruitSalad;

@Inject
VegetableSalad vegetableSalad;

SaladDressingComponent saladDressingComponent = DaggerSaladDressingComponent.builder() 
    .saladDressingModule(new SaladDressingModule(別人給的saladDressing)) 
    .build();

DaggerFruitSaladComponent.builder()        
    .saladDressingComponent(saladDressingComponent)        
    .fruitSaladModule(new FruitSaladModule(new Fruit()))        
    .build().inject(this);

DaggerVegetableSaladComponent.builder()        
    .saladDressingComponent(saladDressingComponent)        
    .vegetableSaladModule(new VegetableSaladModule(new Vegetable()))        
    .build().inject(this);

哎,反正我也不曉得有沒有講清楚,然后講一下遇到的坑。

@AScope
@Component(modules = AModule.class)
public interface AComponent { 
}

@Component(dependencies = AComponent.class, modules = BModule.class)
public interface BComponent { 
}

這樣寫會報錯,BComponent(沒有加@Scope)不能dependencies(依賴)AComponent(加了@Scope),所以你需要給BComponent也加上@Scope

@XScope
@Component(modules = AModule.class)
public interface AComponent { 
}

@XScope
@Component(dependencies = AComponent.class, modules = BModule.class)
public interface BComponent { 
}

這樣也會報錯,兩個Component有依賴關系是不能用相同的@Scope的,自己再定義一個@Scope然后把其中一個換掉就可以了


有什么理解不到位的地方歡迎指點惹=。=

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

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