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。

  • 2020-12-07 15:17:45

    email-templates + mjml 发送邮件

    mjml 是一个很不错的响应式邮件html 内容标签库,email-templates 是一个灵活强大的邮件发送框架,两者集成起来我们 可以设计灵活强大的邮件发送系统,以下是一个简单的集成使用,实际使用还有好多地方需要完善

  • 2020-12-07 15:19:00

    响应式邮件的编写插件介绍mjml

    以前做项目碰到发邮件的需求,邮件模板的编辑就是一件头疼的事。因为虽说邮件是支持 HTML 的,但是确是 HTML 子集程度的支持,所以存在必须通过 <table> 排版的恶心之处,还有很多兼容性的坑。本质上是各家邮件商的标准有差异吧。

  • 2020-12-07 16:14:22

    nodejs队列实现amqplib,rabbitmq

    其中StartConsumer 会在项目启动时启动,在整个生命周期中一直保持监听状态,在程序结束时mq的链接关闭。需要注意的是 noAck 这个参数,当为false是表示消息出队后不会自动删除,如果设置成true,则无论消息处理成功与否此消息会被删除。注意到在消息不成功是,调用了ch.nack(msg)),此方法是将消息重新入队。

  • 2020-12-07 16:15:46

    RabbitMQ详解

    当前市面上mq的产品很多,比如RabbitMQ、Kafka、ActiveMQ、ZeroMQ和阿里巴巴捐献给Apache的RocketMQ。甚至连redis这种NoSQL都支持MQ的功能。 ActiveMQ ActiveMQ是apache出品,最流行的,能力强劲的开源消息总线,并且它一个完全支持JMS规范的消息中间件。其丰富的API、多种集群构建模式使得它成为业界老牌消息中间件,在中小型企业中应用广泛。

  • 2020-12-07 16:17:53

    nodejs用redis实现队列操作

    其实nodejs实现队列的方式又很多中,也有很多开源的插件和队列数据库可以使用,但是呢,如果我们一个简单的项目,完全可以使用redis来实现队列, 这样再不增加技术难度的同事,我们也就可以完美的实现一个队列

  • 2020-12-07 22:02:44

    intellij idea远程开发的几个想法

    我之前是用idea上面自带的stfp来做的本地开发同步到linux服务器编译,但是我发现这个如果多个客户端同时开发,或者多个同事一起开发,服务器上的就不能更新到本地。是不能增量更新到本地,必须全部下载,比对下载也行,但是工程量打了就特别慢。

  • 2020-12-07 22:06:13

    System Extension Blocked - warning

    After upgrading your macOS computer to High Sierra 10.13.4 or higher (starting in April 2018), you may see a message about a System Extension Blocked. At Williams we have seen this warning appear for these programs: