Android 神兵利器Dagger2使用詳解(二)Module&Component源碼分析

前言:

本系列所有文章:

Android 神兵利器Dagger2使用詳解(一)基礎(chǔ)使用
Android 神兵利器Dagger2使用詳解(二)Module&Component源碼分析
Android 神兵利器Dagger2使用詳解(三)MVP架構(gòu)下的使用
Android 神兵利器Dagger2使用詳解(四)Scope注解的使用及源碼分析
告別Dagger2模板代碼:DaggerAndroid使用詳解
告別Dagger2模板代碼:DaggerAndroid原理解析
該系列首發(fā)于我的CSDN專(zhuān)欄 :
Android開(kāi)發(fā):Dagger2詳解

在我的上一篇文章中,我們通過(guò)Dagger2依賴(lài)注入的兩種方式獲取Student對(duì)象,并簡(jiǎn)單了解了各個(gè)組件的作用和互相的聯(lián)系:

@Inject : 注入恋谭,被注解的構(gòu)造方法會(huì)自動(dòng)編譯生成一個(gè)Factory工廠(chǎng)類(lèi)提供該類(lèi)對(duì)象蜓陌。

@Component: 注入器,類(lèi)似快遞員,作用是將產(chǎn)生的對(duì)象注入到需要對(duì)象的容器中墨辛,供容器使用英融。

@Module: 模塊,類(lèi)似快遞箱子绍豁,在Component接口中通過(guò)@Component(modules =
xxxx.class),將容器需要的商品封裝起來(lái)芯咧,統(tǒng)一交給快遞員(Component),讓快遞員統(tǒng)一送到目標(biāo)容器中竹揍。

本文我們繼續(xù)按照上文案例來(lái)講敬飒,通過(guò)源碼分析,看看究竟是為什么芬位,我們能夠僅僅通過(guò)數(shù)個(gè)注解无拗,就能隨心所欲使用Student對(duì)象。

一 .代碼回顧

我們先不考慮Module昧碉,還是這樣的代碼:

1 .Student類(lèi)

public class Student {

    @Inject
    public Student() {
    }

}

2 .Module類(lèi)

@Module
public class A01SimpleModule {

    private A01SimpleActivity activity;

    public A01SimpleModule(A01SimpleActivity activity) {
        this.activity = activity;
    }

}

3.Component類(lèi)

@Component(modules = A01SimpleModule.class)
public interface A01SimpleComponent {

    void inject(A01SimpleActivity activity);

}

4.Activity類(lèi)

public class A01SimpleActivity extends AppCompatActivity {

    @BindView(R.id.btn_01)
    Button btn01;

    @Inject
    Student student;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_a01_simple);
        ButterKnife.bind(this);
        //新添代碼
        DaggerA01SimpleComponent.builder()
//                .a01SimpleModule(new A01SimpleModule(this))
                .build()
                .inject(this);
    }

    @OnClick(R.id.btn_01)
    public void onViewClicked(View view) {
        switch (view.getId()){
            case R.id.btn_01:
                Toast.makeText(this,student.toString(),Toast.LENGTH_SHORT).show();
                break;
        }
    }

然后運(yùn)行代碼英染,點(diǎn)擊Button,輸出student對(duì)象信息:

這里寫(xiě)圖片描述

二.源碼解析

我們打開(kāi)app目錄下的build文件夾被饿,以筆者為例四康,目錄結(jié)構(gòu)為:

app\build\generated\source\apt\debug......\A01SimpleActivity_MembersInjector.java

我們不難發(fā)現(xiàn),編譯器已經(jīng)幫我們生成了這樣幾個(gè)文件:

DaggerA01SimpleComponent.java
Student_Factory.java
A01SimpleActivity_MembersInjector.java

我們進(jìn)行一一分析:

1. Student_Factory.java

上一篇文章我們已經(jīng)進(jìn)行了分析狭握,很簡(jiǎn)單闪金,當(dāng)我們@Inject注解一個(gè)類(lèi)的構(gòu)造方法時(shí),編譯器會(huì)自動(dòng)幫我們生成一個(gè)工廠(chǎng)類(lèi)哥牍,負(fù)責(zé)生產(chǎn)該類(lèi)的對(duì)象毕泌,類(lèi)似于商品的廠(chǎng)家

public enum Student_Factory implements Factory<Student> {
  INSTANCE;

  @Override
  public Student get() {
    return new Student();
  }

  public static Factory<Student> create() {
    return INSTANCE;
  }
}

2.DaggerA01SimpleComponent.java

public final class DaggerA01SimpleComponent implements A01SimpleComponent {
  private MembersInjector<A01SimpleActivity> a01SimpleActivityMembersInjector;

  private DaggerA01SimpleComponent(Builder builder) {
    assert builder != null;
    initialize(builder);
  }

  public static Builder builder() {
    return new Builder();
  }

  public static A01SimpleComponent create() {
    return builder().build();
  }

  @SuppressWarnings("unchecked")
  private void initialize(final Builder builder) {
    //初始化A01SimpleActivity_MembersInjector
    this.a01SimpleActivityMembersInjector =
        A01SimpleActivity_MembersInjector.create(Student_Factory.create());
  }

  @Override
  public void inject(A01SimpleActivity activity) {
    a01SimpleActivityMembersInjector.injectMembers(activity);
  }

  public static final class Builder {
    private Builder() {}

    public A01SimpleComponent build() {
      return new DaggerA01SimpleComponent(this);
    }
   /**
     * @deprecated This module is declared, but an instance is not used in the component. This method is a no-op. For more, see https://google.github.io/dagger/unused-modules.
     */
    @Deprecated
    public Builder a01SimpleModule(A01SimpleModule a01SimpleModule) {
      Preconditions.checkNotNull(a01SimpleModule);
      return this;
    }
  }
}

很熟悉,我們?cè)贏ctivity中就用到了這個(gè)生成的類(lèi)嗅辣,編譯器起名方式也很簡(jiǎn)潔:Dagger+你的Component接口名撼泛。

在我們的Activity中我們是這樣使用:

DaggerA01SimpleComponent.builder()
//              .a01SimpleModule(new A01SimpleModule(this))
                .build()
                .inject(this);

我們根據(jù)這個(gè)步驟查看源碼,發(fā)現(xiàn)

DaggerA01SimpleComponent.builder().build()

實(shí)際上是通過(guò)建造者模式創(chuàng)建了一個(gè)新的DaggerA01SimpleComponent對(duì)象澡谭,在這個(gè)對(duì)象的構(gòu)造方法中愿题,執(zhí)行了initialize()方法损俭,初始化了一個(gè)A01SimpleActivity_MembersInjector對(duì)象。

請(qǐng)注意潘酗,在初始化A01SimpleActivity_MembersInjector時(shí)我們看到這行代碼:

A01SimpleActivity_MembersInjector.create(Student_Factory.create());

可以看到杆兵,Student工廠(chǎng)類(lèi)作為參數(shù)傳入了Injector中。

然后通過(guò)調(diào)用

DaggerA01SimpleComponent.builder().build().inject(this);

中仔夺,實(shí)際上是將Activity作為參數(shù)傳入了A01SimpleActivity_MembersInjector對(duì)象的InjectMembers()方法里面琐脏,僅此而已。

很好缸兔,我們看起來(lái)已經(jīng)明白了Component的作用:編譯器通過(guò)@Component注解日裙,生成了DaggerA01SimpleComponent類(lèi),然后將activity傳入初始化了的A01SimpleActivity_MembersInjector對(duì)象中惰蜜。

這時(shí)我們有了一點(diǎn)頭緒昂拂,因?yàn)槲覀儼l(fā)現(xiàn),Student工廠(chǎng)類(lèi)抛猖,已經(jīng)和Activity同時(shí)都放入了這個(gè)神秘的A01SimpleActivity_MembersInjector類(lèi)中了格侯。

3.A01SimpleActivity_MembersInjector類(lèi),將Student和Activity進(jìn)行連接

public final class A01SimpleActivity_MembersInjector implements MembersInjector<A01SimpleActivity> {
  private final Provider<Student> studentProvider;

  public A01SimpleActivity_MembersInjector(Provider<Student> studentProvider) {
    assert studentProvider != null;
    this.studentProvider = studentProvider;
  }

  public static MembersInjector<A01SimpleActivity> create(Provider<Student> studentProvider) {
    return new A01SimpleActivity_MembersInjector(studentProvider);
  }

  @Override
  public void injectMembers(A01SimpleActivity instance) {
    if (instance == null) {
      throw new NullPointerException("Cannot inject members into a null reference");
    }
    instance.student = studentProvider.get();
  }

  public static void injectStudent(A01SimpleActivity instance, Provider<Student> studentProvider) {
    instance.student = studentProvider.get();
  }
}

其實(shí)已經(jīng)很簡(jiǎn)單了,在該Injector的injectMembers()方法中财著,已經(jīng)將Student對(duì)象通過(guò)Student_Factory的get()方法獲得联四,然后直接賦值給Activity的student對(duì)象了!

就是這行代碼:

instance.student = studentProvider.get();

private final Provider<Student> studentProvider ->就是在create()方法中傳入的Student_Factory工廠(chǎng)類(lèi)撑教,不信碎连?點(diǎn)擊Factory類(lèi):

public interface Factory<T> extends Provider<T> {
}

很明顯了,Student_Factory父類(lèi)是 Factory,Factory父類(lèi)是Provider驮履,向上轉(zhuǎn)型嘛。

三 帶Module的源碼解析:

現(xiàn)在我們嘗試上一篇文章中的Module相關(guān)代碼:

1.Student類(lèi)(取消Inject注解):

public class Student {

    public Student() {
    }

}

2.Module類(lèi)(增加一個(gè)Provide注解方法):

@Module
public class A01SimpleModule {

    private A01SimpleActivity activity;

    public A01SimpleModule(A01SimpleActivity activity) {
        this.activity = activity;
    }

    @Provides
    Student provideStudent(){
        return new Student();
    }
}

3.Component(不變)

@Component(modules = A01SimpleModule.class)
public interface A01SimpleComponent {

    void inject(A01SimpleActivity activity);

}

4.Activity(新增一行代碼)

public class A01SimpleActivity extends AppCompatActivity {

    @BindView(R.id.btn_01)
    Button btn01;

    @Inject
    Student student;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_a01_simple);
        ButterKnife.bind(this);
        //新增一行代碼.a01SimpleModule(new A01SimpleModule(this))
        DaggerA01SimpleComponent.builder()
                .a01SimpleModule(new A01SimpleModule(this))
                .build()
                .inject(this);
    }

    @OnClick(R.id.btn_01)
    public void onViewClicked(View view) {
        switch (view.getId()){
            case R.id.btn_01:
                Toast.makeText(this,student.toString(),Toast.LENGTH_SHORT).show();
                break;
        }
    }
}

我們先把a(bǔ)pp/build文件夾刪除廉嚼,刪除自動(dòng)生成的代碼后玫镐,然后ctrl+F9重新編譯,編譯成功運(yùn)行,依然可以獲得Student對(duì)象怠噪。

這時(shí)我們打開(kāi)build目錄恐似,層層剝開(kāi)后,發(fā)現(xiàn)這樣三個(gè)類(lèi):

DaggerA01SimpleComponent.java
A01SimpleModule_ProvideStudentFactory.java
A01SimpleActivity_MembersInjector.java

1.A01SimpleModule_ProvideStudentFactory.java

public final class A01SimpleModule_ProvideStudentFactory implements Factory<Student> {
  private final A01SimpleModule module;

  public A01SimpleModule_ProvideStudentFactory(A01SimpleModule module) {
    assert module != null;
    this.module = module;
  }

  @Override
  public Student get() {
    return Preconditions.checkNotNull(
        module.provideStudent(), "Cannot return null from a non-@Nullable @Provides method");
  }

  public static Factory<Student> create(A01SimpleModule module) {
    return new A01SimpleModule_ProvideStudentFactory(module);
  }
}

我們知道傍念,我們?cè)贛odule中創(chuàng)建了一個(gè)provideStudent()方法矫夷,方法中創(chuàng)建并返回了一個(gè)Student對(duì)象,其實(shí)很相似憋槐,Module的@Provides注解就是幫助我們生成了一個(gè)Student_Factory的工廠(chǎng)双藕,只不過(guò)這個(gè)工廠(chǎng)很特別,只有鑰匙才能進(jìn)(必須傳入A01SimpleModule對(duì)象才能實(shí)例化):

//沒(méi)有傳入A01SimpleModule對(duì)象阳仔,無(wú)法實(shí)例化該工廠(chǎng)類(lèi)
 public static Factory<Student> create(A01SimpleModule module) {
    return new A01SimpleModule_ProvideStudentFactory(module);
  }

我們查看A01SimpleModule會(huì)發(fā)現(xiàn)忧陪,想實(shí)例化A01SimpleModule,必須傳入一個(gè)A01SimpleActivity對(duì)象,這說(shuō)明了嘶摊,A01SimpleModule就像是一個(gè)專(zhuān)屬的快遞箱子延蟹,只有本人(A01SimpleActivity)才能簽收私人快遞,然后打開(kāi)自己的盒子(A01SimpleModule->創(chuàng)建A01SimpleModule_ProvideStudentFactory)獲得這個(gè)Student對(duì)象叶堆!

簡(jiǎn)單來(lái)說(shuō)阱飘,通過(guò)@Providers注解后,產(chǎn)生的對(duì)象就經(jīng)過(guò)Module包裝虱颗,通過(guò)Component快遞員送到需要的容器Activity中沥匈。

相比@Inject簡(jiǎn)單粗暴的注解生成的“萬(wàn)能工廠(chǎng)”Student_Factory類(lèi),似乎這個(gè)更“安全”一些~

2.DaggerA01SimpleComponent

public final class DaggerA01SimpleComponent implements A01SimpleComponent {
  private Provider<Student> provideStudentProvider;

  private MembersInjector<A01SimpleActivity> a01SimpleActivityMembersInjector;

  private DaggerA01SimpleComponent(Builder builder) {
    assert builder != null;
    initialize(builder);
  }

  public static Builder builder() {
    return new Builder();
  }

  @SuppressWarnings("unchecked")
  private void initialize(final Builder builder) {
    //創(chuàng)建A01Module專(zhuān)屬的工廠(chǎng)
    this.provideStudentProvider =
        A01SimpleModule_ProvideStudentFactory.create(builder.a01SimpleModule);
    //將專(zhuān)屬工廠(chǎng)放入Injector中
    this.a01SimpleActivityMembersInjector =
        A01SimpleActivity_MembersInjector.create(provideStudentProvider);
  }

  @Override
  public void inject(A01SimpleActivity activity) {
      //將Activity容器傳入Injector中
    a01SimpleActivityMembersInjector.injectMembers(activity);
  }

  public static final class Builder {
    private A01SimpleModule a01SimpleModule;

    private Builder() {}

    public A01SimpleComponent build() {
      if (a01SimpleModule == null) {
        throw new IllegalStateException(A01SimpleModule.class.getCanonicalName() + " must be set");
      }
      return new DaggerA01SimpleComponent(this);
    }
    
    //傳入需要的Module
    public Builder a01SimpleModule(A01SimpleModule a01SimpleModule) {
      this.a01SimpleModule = Preconditions.checkNotNull(a01SimpleModule);
      return this;
    }
  }

變化很少上枕,相比較@Inject注解的方式咐熙,@Inject注解生成的工廠(chǎng)類(lèi)就好像將商品赤裸著交給Component,@module注解生成的工廠(chǎng)類(lèi)就好像給商品加了一層防護(hù)紙箱,感覺(jué)更貼心了呢~

3.A01SimpleActivity_MembersInjector

public final class A01SimpleActivity_MembersInjector implements MembersInjector<A01SimpleActivity> {
  private final Provider<Student> studentProvider;

  public A01SimpleActivity_MembersInjector(Provider<Student> studentProvider) {
    assert studentProvider != null;
    this.studentProvider = studentProvider;
  }

  public static MembersInjector<A01SimpleActivity> create(Provider<Student> studentProvider) {
    return new A01SimpleActivity_MembersInjector(studentProvider);
  }

  @Override
  public void injectMembers(A01SimpleActivity instance) {
    if (instance == null) {
      throw new NullPointerException("Cannot inject members into a null reference");
    }
    instance.student = studentProvider.get();
  }

  public static void injectStudent(A01SimpleActivity instance, Provider<Student> studentProvider) {
    instance.student = studentProvider.get();
  }
}

可以發(fā)現(xiàn)辨萍,基本并沒(méi)有什么變化棋恼。

總結(jié)

經(jīng)過(guò)兩次分析 我們基本理解了Dagger2的使用方式,原理基本如下:

@Inject 注解構(gòu)造 生成“大眾”工廠(chǎng)類(lèi)
或者
@Module +@Providers 提供注入“私有”工廠(chǎng)類(lèi)

然后

通過(guò)Component 創(chuàng)建獲得Activity,獲得工廠(chǎng)類(lèi)Provider锈玉,統(tǒng)一交給Injector

最后

Injector將Provider的get()方法提供的對(duì)象爪飘,注入到Activity容器對(duì)應(yīng)的成員變量中,我們就可以直接使用Activity容器中對(duì)應(yīng)的成員變量了拉背!

了解了原理师崎,接下來(lái)怎么使用就隨意了~在接下來(lái)的文章中,我會(huì)結(jié)合MVP的架構(gòu)對(duì)Dagger2進(jìn)行更深入的使用椅棺。

GitHub傳送門(mén)犁罩,點(diǎn)我看源碼
Android 神兵利器Dagger2使用詳解(三)MVP架構(gòu)下的使用

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市两疚,隨后出現(xiàn)的幾起案子床估,更是在濱河造成了極大的恐慌,老刑警劉巖诱渤,帶你破解...
    沈念sama閱讀 218,858評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件丐巫,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡勺美,警方通過(guò)查閱死者的電腦和手機(jī)递胧,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,372評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)赡茸,“玉大人缎脾,你說(shuō)我怎么就攤上這事√陈樱” “怎么了赊锚?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,282評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵治筒,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我舷蒲,道長(zhǎng)耸袜,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,842評(píng)論 1 295
  • 正文 為了忘掉前任牲平,我火速辦了婚禮堤框,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘纵柿。我一直安慰自己蜈抓,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,857評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布昂儒。 她就那樣靜靜地躺著沟使,像睡著了一般。 火紅的嫁衣襯著肌膚如雪渊跋。 梳的紋絲不亂的頭發(fā)上腊嗡,一...
    開(kāi)封第一講書(shū)人閱讀 51,679評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音拾酝,去河邊找鬼燕少。 笑死,一個(gè)胖子當(dāng)著我的面吹牛蒿囤,可吹牛的內(nèi)容都是我干的客们。 我是一名探鬼主播,決...
    沈念sama閱讀 40,406評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼材诽,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼底挫!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起脸侥,我...
    開(kāi)封第一講書(shū)人閱讀 39,311評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤凄敢,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后湿痢,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,767評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡扑庞,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評(píng)論 3 336
  • 正文 我和宋清朗相戀三年譬重,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片罐氨。...
    茶點(diǎn)故事閱讀 40,090評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡臀规,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出栅隐,到底是詐尸還是另有隱情塔嬉,我是刑警寧澤玩徊,帶...
    沈念sama閱讀 35,785評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站谨究,受9級(jí)特大地震影響恩袱,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜胶哲,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,420評(píng)論 3 331
  • 文/蒙蒙 一畔塔、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧鸯屿,春花似錦澈吨、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,988評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至婶恼,卻和暖如春桑阶,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背熙尉。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,101評(píng)論 1 271
  • 我被黑心中介騙來(lái)泰國(guó)打工联逻, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人检痰。 一個(gè)月前我還...
    沈念sama閱讀 48,298評(píng)論 3 372
  • 正文 我出身青樓包归,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親铅歼。 傳聞我的和親對(duì)象是個(gè)殘疾皇子公壤,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,033評(píng)論 2 355

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