Dagger2入门

陈宇明

发布于 2020-12-15 15:48:05

3690

发布于 2020-12-15 15:48:05

文章被收录于专栏：设计模式

这次入门就不要放弃了

作者：HuYounger

博客：http://rkhcy.github.io/

文章目录

概述
Why
学习资料

概述

最近公司的项目是用mvp+dagger2搭的框架，由于之前没接触过dagger2，改bug和做需求总是一脸懵逼，看了些文档介绍，和大多数学习者一样从Dependency Injection、注解概念等等开始了解，然后敲代码上手，在此记录下学习心得。既然是入门，那些概念和注解的历史就不介绍了，Google一下你就知道，直接介绍最最基本的使用以及具体实现原理。

@Inject、@Component

先看一个例子，MainActivity依赖Province，Province依赖City，City依赖Street；

使用前

Street.java

City.java

Province.java

MainActivity.java

可以看到，为了获取地址信息，在代码中需要实例化各种依赖到的对象，一旦依赖过多就容易影响代码阅读，那么配合使用@Inject和@Component又是怎样的呢？

使用后

1.首先在build.gradle中添加依赖

Street.java

2.需要依赖的成员和提供依赖的成员构造函数用@Inject标注

City.java

Province.java

3.需要额外加一个接口MainActivityComponent.java，用@Component标注

4.执行DaggerMainActivityComponent.create().inject(this)

此时的MainActivity.java

前后的打印是一致的，可以看到MainActivity的中原本需要实例化对象的那些代码现在可以省略了，有助于我们更好地关注业务实现。

小结

回顾下使用注解的步骤:

1.build.gradle中添加dagger2依赖

2.使用@Inject标注在构造函数和被引用的成员变量上

3.新建MainActivityComponent接口，并用@Component标注

4.在MainActivity中执行DaggerMainActivityComponent.create().inject(this)；(第一次需Rebuild Project)

源码分析

我们在MainaActivity中加了DaggerMainActivityComponent.create().inject(this)这句代码替换了之前的一些实例化的操作，那么这句代码具体做了哪些工作？原来Dagger2会在编译过程中生成对应的依赖项，这些依赖项在Android Studio该路径下，如图所示：

DaggerMainActivityComponent.create()

可以看到，不管是通过builder().build()还是create()，最后都会调用DaggerMainActivityComponent构造函数；在通过源码阅读后，可以将整个过程分为两步，分别是initialize()和inject()

initialize()

在initialize()方法中对成员赋值，这里的成员分为两类，分别以_MembersInjector和_Factory为后缀；Xx_MembersInjector可以理解为注入器，用来实现Xx与内部成员的依赖:

Xx_Factory是创建Xx的工厂:

这里先记住两者的功能，具体后面会分析

注释1

先看下Street_Factory.java

代码很简单，通过恶汉式创建了一个Street_Factory单例(这里的源码可能会有不同，之前看过一版是通过枚举创建的单例)；再看下City_MembersInjector.java

City_MembersInjector只是将传进来的Street_Factory赋值给自己的成员变量；

注释2

后面的功能都一样，就用伪代码列出：

City_Factory.java

注释3

Province_MembersInjector.java

注释4

Province_Factory.java

注释5

到此目标工厂和注入器都已经创建完成，但是此时目标对象和依赖关系还没产生。

inject()

inject()通过调用injectMembers()完成真正目标对象实例化以及依赖操作，代码也没多少，就把整个完整的过程涉及到的代码贴出来:

可以看到inject()和initialize()刚好是相反的过程，直到找到依赖的源头完成源头对象的实例化，即这里的Street_Factory的get()方法的返回值；在Street实例化完成之后返回给City完成City实例化，City实例化完之后对自己的成员重新赋值了一遍，即产生依赖关系：

instance.street赋值的时候调用了streetProvider.get()，这是一个怎样的过程呢，还是画个图吧

step1的时候已经完成了Street和City的实例化，接着执行instance.street = streetProvider.get()，这句代码即下面step2的过程：

红色的就变成垃圾了，所以在这个过程中Street被new了两次；继续分析创建Province以及建立依赖的过程：

可以看到在整个过程中Street其实new了4次，如果依赖更多的话(比如最外层再加个Country)，Street在内存中被new的次数也会*2，不过过程中这些对象最终都会变成垃圾被回收(总觉得这是额外的开销，依赖多了岂不是编译就慢了？)，而不用dagger2只要new一次就可以了(如下图)，但是两者最终都是一条依赖链

总结

整个流程：

黑色的流程线是initialize()的过程，用来创建目标实例的工厂和注入器；红色流程线是inject()/injectMembers()的过程，用来创建目标实例以及实现依赖。最后在回过头来看下@inject和@component这两个标注，可以得出一些结论：

1.若一个类(Xx)的构造函数被@inject标注，则该类编译时会产生Xx_Factory；

2.若一个类中的成员变量被@inject标注，则该类编译时会产生Xx_MembersInjector；

3.@Component标注的接口(Xx)在编译时生成DaggerXx，负责将上面两个联系起来。

一个图

@Module和@Provides

学习这两个注解，配合@Inject和@Component使用完成和上面一样的功能

使用前

和上面的使用前代码一致

使用后

1.创建一个Module.java，这里取名BeanModule.java(想怎么取名字都可以，比如周杰伦.java，但是最好别这么干)，并用@Module标注，如下：

2.修改上面的MainActivityComponent.java接口，@Component后面多了一个配置，如下:

modules的作用相当于告诉Component，当你需要创建对象的时候就到我这里来拿。MainActivity不变，运行后的效果和上面一毛一样。

源码分析

先看编译过程生成的文件：

同样从DaggerMainActivityComponent.create().inject(this)，这句代码开始分析

DaggerMainActivityComponent.create()

不管是通过builder().build()还是create()，最后都会调用DaggerMainActivityComponent构造函数；和上面对比这里多了一步，那就是创建了BeanModule实例，还是把这个过程分成两步：initialize()和inject()

initialize()方法对自己的成员赋值，创建了目标对象工厂和注入器，在这里的注入器只有一个MainActivity_MembersInjector；

inject()

这里的inject()和injectMembers()的工作和上面是一样的，调用BeaModule中的方法创建需要的实例，若该实例在创建时依赖其他实例，则调用BeaModule中的对应方法先创建依赖实例，直到找到源头，最大的区别就是在Xx_Factory中少了一步重新创建依赖的过程。用一张图来表示创建的过程就是