Dagger2源码解析inject过程

2020-11-22 23:25:56

参考地址 Android开发之Dagger2--源码角度分析inject过程(二)

前言

在上一篇文章中 Android开发之Dagger2的基本使用(一),主要是在项目了里导入了Dagger2,并注入成功,实现了基本的功能。在上一篇文章的末尾也提出了几个问题

  • 添加inject后,通过编译生成的DaggerMainComponent类来导入,说明编译以后生成了一些类,那到底生成了什么类呢。

  • Module和Component又是什么,该怎么里理解
    在这篇文章后里将一一讨论。

引入Dagger2后生成的类

对项目进行编译以后,我们打开app的build目录,我的是在app\build\generated\source\apt\debug\com\jackson\daggertest下,可以看到引入Dagger2后生成的类,一共有三个,分别是 Student_Factory.java,DaggerMainComponent.java,Daggertest1Activity_MembersInjector.java,我们一步步来。


    1. Student_Factory.java,对Student的构造方法用@Inject注解后编译生成

public final class Student_Factory implements Factory<Student> {
  private static final Student_Factory INSTANCE = new Student_Factory();

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

  public static Student_Factory create() {
    return INSTANCE;
  }}

不难看出这实际上是一个工厂类,create()方法提供工厂实例,get()获取Studnet的对象。也就是说我们对一个类的构造方法用@Inject注解后,会生成一个提供该类实例的类。

  • 2 DaggerMainComponent.java
    源码如下:

public final class DaggerMainComponent implements MainComponent {
  private DaggerMainComponent(Builder builder) {}

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

  public static MainComponent create() {
    return new Builder().build();
  }

  @Override
  public void inject(Daggertest1Activity daggertest1Activity) {
    injectDaggertest1Activity(daggertest1Activity);
  }

  private Daggertest1Activity injectDaggertest1Activity(Daggertest1Activity instance) {
    Daggertest1Activity_MembersInjector.injectMStudent(instance, new Student());
    return instance;
  }

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

    public MainComponent build() {
      return new DaggerMainComponent(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 mainModule(MainModule mainModule) {
      Preconditions.checkNotNull(mainModule);
      return this;
    }
  }}

很明显,这是我们在Activity里调用的,类名很简单,就是Dagger+Component的名字,Activity里的调用代码如下:

DaggerMainComponent.builder()
                .mainModule(new MainModule())
                .build()
                .inject(this);

结合源码可以看到,DaggerMainComponent是通过Builder模式新建了一个DaggerMainComponent的对象,当DaggerMainComponent的对象执行inject()方法时,会最终执行Daggertest1Activity_MembersInjector的injectMStudent()方法,参数为this,既当前的Activity的实例,我们继续往下看。

3 Daggertest1Activity_MembersInjector.java

public final class Daggertest1Activity_MembersInjector
    implements MembersInjector<Daggertest1Activity> {
  private final Provider<Student> mStudentProvider;

  public Daggertest1Activity_MembersInjector(Provider<Student> mStudentProvider) {
    this.mStudentProvider = mStudentProvider;
  }

  public static MembersInjector<Daggertest1Activity> create(Provider<Student> mStudentProvider) {
    return new Daggertest1Activity_MembersInjector(mStudentProvider);
  }

  @Override
  public void injectMembers(Daggertest1Activity instance) {
    injectMStudent(instance, mStudentProvider.get());
  }

  public static void injectMStudent(Daggertest1Activity instance, Student mStudent) {
    instance.mStudent = mStudent;
  }}

上面提到,当在Activity执行injec方法时,会最终执行到这个类的injectMStudent()方法,其中传递过来了Activity的实例,那么是怎么将Activity的mStudent和Student_Factory提供的Student实例联系起来呢。

 public static void injectMStudent(Daggertest1Activity instance, Student mStudent) {
    instance.mStudent = mStudent;
  }

通过这个方法,我们可以看到,传递过来的instance里的mStudnet被赋值了一个mStudent对象,那么我们猜测,这个mStudent就是从Student_Factory传递过来的,到底是不是呢,我们继续验证。

 @Override
  public void injectMembers(Daggertest1Activity instance) {
    injectMStudent(instance, mStudentProvider.get());
  }

injectMStudent()方法在这个地方调用,其中传递过来的是mStudentProvider.get(),在看一下这个mStudentProvider的定义,private final Provider<Student> mStudentProvider; 这个应该就是在Student_Factory里提供的工厂类。
不信看一下

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

Factory的父类正是Provider,mStudentProvider.get()就是获取的是Student_Factory的Student对象,然后和instnce里的对象进行赋值;

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

综上,通过生成的类,我们一步步追踪到了,当对一个类吃的构造方法使用@Inject注解

@Inject
    public Student(){

    }

在Activity里,执行注入操作后

@Inject
    Student mStudent;  // 注入Studnet的实例

  DaggerMainComponent.builder()
                .mainModule(new MainModule())
                .build()
                .inject(this);

Activity里的mStudent是怎么和Student的实例联系起来的。
总结起来就是一下几点:

  • 1 通过工厂方法提供类的实例

  • 2 生成Dagger+Component名字的类,通过Builder模式提供该类的实例

  • 3 执行inject方法时建立实例之间的联系

下篇文章再讨论 Module和Component。

  • 2019-08-22 17:26:21

    详解javaScript的深拷贝

    最开始意识到深拷贝的重要性是在我使用redux的时候(react + redux), redux的机制要求在reducer中必须返回一个新的对象,而不能对原来的对象做改动,事实上,当时我当然不会主动犯这个错误,但很多时候,一不小心可能就会修改了原来的对象,例如:var newObj = obj; newObj.xxx = xxx 实际上,这个时候newObj和obj两个引用指向的是同一个对象,我修改了newObj,实际上也就等同于修改了obj,这,就是我和深浅拷贝的第一次相遇。

  • 2019-08-22 19:14:21

    Android Studio 3.5最新特性

    Android Studio(以下简称为AS) 3.5正式版终于发布了,从第一个bate版本发布到正式版本,历时三个半月。AS一直以来被开发者吐槽,因此谷歌也放慢了版本的变化,对测试版本进行大力度的优化,提高了稳定性。从3.3版本开始,谷歌启动了名为Project Marble的计划,意为谷歌团队致力于使集成开发环境(IDE)的基本功能和流程变得坚如磐石,同时精炼和完善面向用户的功能。而AS 3.5则是Project Marble主要成果的版本,下面来介绍主要成果。

  • 2019-08-27 05:43:13

    Laravel 门面自动补全工具 laravel-ide-helper

    当我们在 PhpStorm 编辑器中,开发 Laravel 框架的项目时,很多类方法都不能自动补全和定位,比如 Facade 门面的方法,DB::table()、Route::get() 等。

  • 2019-08-28 08:28:36

    Js apply,call方法详解,及其apply()方法的妙用

    在给对象参数的情况下,如果参数的形式是数组的时候,比如apply示例里面传递了参数arguments,这个参数是数组类型,并且在调用Person的时候参数的列表是对应一致的(也就是Person和Student的参数列表前两位是一致的) 就可以采用 apply , 如果我的Person的参数列表是这样的(age,name),而Student的参数列表是(name,age,grade),这样就可以用call来实现了,也就是直接指定参数列表对应值的位置(Person.call(this,age,name,grade));

  • 2019-08-28 08:49:47

    Nginx + fastcgi + php 的原理与关系

    CGI对每个请求会parse一遍对应脚本的配置文件(如php.ini), 加载配置和扩展,初始化执行环境,性能非常差,所有有了下面的流程:

  • 2019-08-28 09:23:15

    php单例模式

    单例模式,是一种常见的软件设计模式。在应用这个模式时,单例对象的类必须保证只有一个实例存在。