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專欄 :
Android開發(fā):Dagger2詳解

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

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

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

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

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

一 .代碼回顧

我們先不考慮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;
        }
    }

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

這里寫圖片描述

二.源碼解析

我們打開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è)類的構(gòu)造方法時(shí),編譯器會(huì)自動(dòng)幫我們生成一個(gè)工廠類,負(fù)責(zé)生產(chǎn)該類的對(duì)象,類似于商品的廠家

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è)生成的類,編譯器起名方式也很簡(jiǎn)潔:Dagger+你的Component接口名。

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

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

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

DaggerA01SimpleComponent.builder().build()

實(shí)際上是通過建造者模式創(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工廠類作為參數(shù)傳入了Injector中。

然后通過調(diào)用

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

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

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

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

3.A01SimpleActivity_MembersInjector類,將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ì)象通過Student_Factory的get()方法獲得,然后直接賦值給Activity的student對(duì)象了!

就是這行代碼:

instance.student = studentProvider.get();

private final Provider<Student> studentProvider ->就是在create()方法中傳入的Student_Factory工廠類,不信?點(diǎn)擊Factory類:

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

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

三 帶Module的源碼解析:

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

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

public class Student {

    public Student() {
    }

}

2.Module類(增加一個(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í)我們打開build目錄,層層剝開后,發(fā)現(xiàn)這樣三個(gè)類:

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的工廠,只不過這個(gè)工廠很特別,只有鑰匙才能進(jìn)(必須傳入A01SimpleModule對(duì)象才能實(shí)例化):

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

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

簡(jiǎn)單來說,通過@Providers注解后,產(chǎn)生的對(duì)象就經(jīng)過Module包裝,通過Component快遞員送到需要的容器Activity中。

相比@Inject簡(jiǎn)單粗暴的注解生成的“萬能工廠”Student_Factory類,似乎這個(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專屬的工廠
    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注解生成的工廠類就好像給商品加了一層防護(hù)紙箱,感覺更貼心了呢~

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),基本并沒有什么變化。

總結(jié)

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

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

然后

通過Component 創(chuàng)建獲得Activity,獲得工廠類Provider,統(tǒng)一交給Injector

最后

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

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

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容