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

前言：

本系列所有文章：

Android 神兵利器Dagger2使用詳解（一）基礎使用
 Android 神兵利器Dagger2使用詳解（二）Module&Component源碼分析
 Android 神兵利器Dagger2使用詳解（三）MVP架構下的使用
 Android 神兵利器Dagger2使用詳解（四）Scope注解的使用及源碼分析
 告別Dagger2模板代碼：DaggerAndroid使用詳解
 告別Dagger2模板代碼：DaggerAndroid原理解析
該系列首發于我的CSDN專欄：
Android開發：Dagger2詳解

在我的上一篇文章中，我們通過Dagger2依賴注入的兩種方式獲取Student對象,并簡單了解了各個組件的作用和互相的聯系:

@Inject ：注入，被注解的構造方法會自動編譯生成一個Factory工廠類提供該類對象。

@Component: 注入器，類似快遞員，作用是將產生的對象注入到需要對象的容器中，供容器使用。

@Module: 模塊，類似快遞箱子，在Component接口中通過@Component(modules =
xxxx.class),將容器需要的商品封裝起來，統一交給快遞員（Component），讓快遞員統一送到目標容器中。

本文我們繼續按照上文案例來講，通過源碼分析，看看究竟是為什么，我們能夠僅僅通過數個注解，就能隨心所欲使用Student對象。

一 .代碼回顧

我們先不考慮Module，還是這樣的代碼：

1 .Student類

public class Student {

    @Inject
    public Student() {
    }

}

2 .Module類

@Module
public class A01SimpleModule {

    private A01SimpleActivity activity;

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

}

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);
        //新添代碼
        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;
        }
    }

然后運行代碼，點擊Button，輸出student對象信息：

這里寫圖片描述

二.源碼解析

我們打開app目錄下的build文件夾，以筆者為例，目錄結構為：

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

我們不難發現，編譯器已經幫我們生成了這樣幾個文件：

DaggerA01SimpleComponent.java
Student_Factory.java
A01SimpleActivity_MembersInjector.java

我們進行一一分析：

1. Student_Factory.java

上一篇文章我們已經進行了分析，很簡單，當我們@Inject注解一個類的構造方法時，編譯器會自動幫我們生成一個工廠類，負責生產該類的對象，類似于商品的廠家：

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;
    }
  }
}

很熟悉，我們在Activity中就用到了這個生成的類，編譯器起名方式也很簡潔：Dagger+你的Component接口名。

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

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

我們根據這個步驟查看源碼，發現

DaggerA01SimpleComponent.builder().build()

實際上是通過建造者模式創建了一個新的DaggerA01SimpleComponent對象，在這個對象的構造方法中，執行了initialize()方法，初始化了一個A01SimpleActivity_MembersInjector對象。

請注意，在初始化A01SimpleActivity_MembersInjector時我們看到這行代碼：

A01SimpleActivity_MembersInjector.create(Student_Factory.create());

可以看到，Student工廠類作為參數傳入了Injector中。

然后通過調用

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

中，實際上是將Activity作為參數傳入了A01SimpleActivity_MembersInjector對象的InjectMembers()方法里面，僅此而已。

很好，我們看起來已經明白了Component的作用：編譯器通過@Component注解，生成了DaggerA01SimpleComponent類，然后將activity傳入初始化了的A01SimpleActivity_MembersInjector對象中。

這時我們有了一點頭緒，因為我們發現，Student工廠類，已經和Activity同時都放入了這個神秘的A01SimpleActivity_MembersInjector類中了。

3.A01SimpleActivity_MembersInjector類,將Student和Activity進行連接

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();
  }
}

其實已經很簡單了，在該Injector的injectMembers()方法中，已經將Student對象通過Student_Factory的get()方法獲得，然后直接賦值給Activity的student對象了！

就是這行代碼：

instance.student = studentProvider.get();

private final Provider<Student> studentProvider ->就是在create（）方法中傳入的Student_Factory工廠類，不信？點擊Factory類：

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

很明顯了，Student_Factory父類是 Factory,Factory父類是Provider，向上轉型嘛。

三帶Module的源碼解析：

現在我們嘗試上一篇文章中的Module相關代碼:

1.Student類（取消Inject注解）：

public class Student {

    public Student() {
    }

}

2.Module類（增加一個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;
        }
    }
}

我們先把app/build文件夾刪除，刪除自動生成的代碼后，然后ctrl+F9重新編譯,編譯成功運行，依然可以獲得Student對象。

這時我們打開build目錄，層層剝開后，發現這樣三個類：

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);
  }
}

我們知道，我們在Module中創建了一個provideStudent()方法，方法中創建并返回了一個Student對象，其實很相似，Module的@Provides注解就是幫助我們生成了一個Student_Factory的工廠，只不過這個工廠很特別，只有鑰匙才能進(必須傳入A01SimpleModule對象才能實例化)：

//沒有傳入A01SimpleModule對象，無法實例化該工廠類
 public static Factory<Student> create(A01SimpleModule module) {
    return new A01SimpleModule_ProvideStudentFactory(module);
  }

我們查看A01SimpleModule會發現，想實例化A01SimpleModule，必須傳入一個A01SimpleActivity對象，這說明了，A01SimpleModule就像是一個專屬的快遞箱子，只有本人（A01SimpleActivity）才能簽收私人快遞，然后打開自己的盒子（A01SimpleModule->創建A01SimpleModule_ProvideStudentFactory）獲得這個Student對象！

簡單來說，通過@Providers注解后，產生的對象就經過Module包裝，通過Component快遞員送到需要的容器Activity中。

相比@Inject簡單粗暴的注解生成的“萬能工廠”Student_Factory類，似乎這個更“安全”一些~

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) {
    //創建A01Module專屬的工廠
    this.provideStudentProvider =
        A01SimpleModule_ProvideStudentFactory.create(builder.a01SimpleModule);
    //將專屬工廠放入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注解生成的工廠類就好像將商品赤裸著交給Component,@module注解生成的工廠類就好像給商品加了一層防護紙箱，感覺更貼心了呢~

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();
  }
}

可以發現，基本并沒有什么變化。

總結

經過兩次分析我們基本理解了Dagger2的使用方式，原理基本如下：

@Inject 注解構造生成“大眾”工廠類
或者
@Module +@Providers 提供注入“私有”工廠類

然后

通過Component 創建獲得Activity,獲得工廠類Provider，統一交給Injector

最后

Injector將Provider的get()方法提供的對象，注入到Activity容器對應的成員變量中，我們就可以直接使用Activity容器中對應的成員變量了！

了解了原理，接下來怎么使用就隨意了~在接下來的文章中，我會結合MVP的架構對Dagger2進行更深入的使用。

GitHub傳送門，點我看源碼
 Android 神兵利器Dagger2使用詳解（三）MVP架構下的使用

最后編輯于：2017.12.10 15:44:24

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

人面猴
序言：七十年代末，一起剝皮案震驚了整個濱河市，隨后出現的幾起案子，更是在濱河造成了極大的恐慌，老刑警劉巖，帶你破解...
沈念sama閱讀 227,882評論 6贊 531
死咒
序言：濱河連續發生了三起死亡事件，死亡現場離奇詭異，居然都是意外死亡，警方通過查閱死者的電腦和手機，發現死者居然都...
沈念sama閱讀 98,208評論 3贊 414
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人，你說我怎么就攤上這事?！?“怎么了？”我有些...
開封第一講書人閱讀 175,746評論 0贊 373
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵，是天一觀的道長。經常有香客問我，道長，這世上最難降的妖魔是什么？我笑而不...
開封第一講書人閱讀 62,666評論 1贊 309
?港島之戀（遺憾婚禮）
正文為了忘掉前任，我火速辦了婚禮，結果婚禮上，老公的妹妹穿的比我還像新娘。我一直安慰自己，他們只是感情好，可當我...
茶點故事閱讀 71,477評論 6贊 407
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布。她就那樣靜靜地躺著，像睡著了一般。火紅的嫁衣襯著肌膚如雪。梳的紋絲不亂的頭發上，一...
開封第一講書人閱讀 54,960評論 1贊 321
城市分裂傳說
那天，我揣著相機與錄音，去河邊找鬼。笑死，一個胖子當著我的面吹牛，可吹牛的內容都是我干的。我是一名探鬼主播，決...
沈念sama閱讀 43,047評論 3贊 440
雙鴛鴦連環套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了？” 一聲冷哼從身側響起，我...
開封第一講書人閱讀 42,200評論 0贊 288
萬榮殺人案實錄
序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后，有當地人在樹林里發現了一具尸體，經...
沈念sama閱讀 48,726評論 1贊 333
?護林員之死
正文獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛以下內容為張勛視角年9月15日...
茶點故事閱讀 40,617評論 3贊 354
?白月光啟示錄
正文我和宋清朗相戀三年，在試婚紗的時候發現自己被綠了。大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
茶點故事閱讀 42,807評論 1贊 369
活死人
序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖，靈堂內的尸體忽然破棺而出，到底是詐尸還是另有隱情，我是刑警寧澤，帶...
沈念sama閱讀 38,327評論 5贊 358
?日本核電站爆炸內幕
正文年R本政府宣布，位于F島的核電站，受9級特大地震影響，放射性物質發生泄漏。R本人自食惡果不足惜，卻給世界環境...
茶點故事閱讀 44,049評論 3贊 347
男人毒藥：我在死后第九天來索命
文/蒙蒙一、第九天我趴在偏房一處隱蔽的房頂上張望。院中可真熱鬧，春花似錦、人聲如沸。這莊子的主人今日做“春日...
開封第一講書人閱讀 34,425評論 0贊 26
一樁弒父案，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽。三九已至，卻和暖如春，著一層夾襖步出監牢的瞬間，已是汗流浹背。一陣腳步聲響...
開封第一講書人閱讀 35,674評論 1贊 281
情欲美人皮
我被黑心中介騙來泰國打工，沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留，地道東北人。一個月前我還...
沈念sama閱讀 51,432評論 3贊 390
代替公主和親
正文我出身青樓，卻偏偏與公主長得像，于是被迫代替她去往敵國和親。傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當晚...
茶點故事閱讀 47,769評論 2贊 372

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

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

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

前言：

本系列所有文章：

一 .代碼回顧

1 .Student類

2 .Module類

3.Component類

4.Activity類

二.源碼解析

1. Student_Factory.java

2.DaggerA01SimpleComponent.java

3.A01SimpleActivity_MembersInjector類,將Student和Activity進行連接

三帶Module的源碼解析：

1.Student類（取消Inject注解）：

2.Module類（增加一個Provide注解方法）：

3.Component(不變)

4.Activity（新增一行代碼）

1.A01SimpleModule_ProvideStudentFactory.java

2.DaggerA01SimpleComponent

3.A01SimpleActivity_MembersInjector

總結

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美 国产 综合 欧美 视频

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

前言：

本系列所有文章：

一 .代碼回顧

1 .Student類

2 .Module類

3.Component類

4.Activity類

二.源碼解析

1. Student_Factory.java

2.DaggerA01SimpleComponent.java

3.A01SimpleActivity_MembersInjector類,將Student和Activity進行連接

三 帶Module的源碼解析：

1.Student類（取消Inject注解）：

2.Module類（增加一個Provide注解方法）：

3.Component(不變)

4.Activity（新增一行代碼）

1.A01SimpleModule_ProvideStudentFactory.java

2.DaggerA01SimpleComponent

3.A01SimpleActivity_MembersInjector

總結

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

三帶Module的源碼解析：