框架深入| Dagger2深入浅出 Part1_使用操作

2019-06-19 | 阅读：次

什么是Dagger2？ Dagger2是Dagger的升级版，是一个依赖注入框架,第一代由大名鼎鼎的Square公司共享出来，第二代则是由谷歌接手后推出的，现在由Google接手维护。 google / dagger [GitHub地址]

什么是依赖注入？依赖注入是面向对象编程的一种设计原则，其目的是为了降低程序耦合，这个耦合就是类之间的依赖引起的。

Dagger2专题

框架深入| Dagger2深入浅出 Part1_使用操作
 框架深入| Dagger2深入浅出 Part2_源码分析

如何使用Dagger2

0. 导入Dagger2

// Add Dagger dependencies
dependencies {
  compile 'com.google.dagger:dagger:2.x'
  annotationProcessor 'com.google.dagger:dagger-compiler:2.x'
}

1. 关键的注解

@Inject 这个注解是用来说明该注解下方的属性或方法需要依赖注入。（如果使用在类构造方法上，则该类也会被注册在DI容器中作为注入对象。很重要，理解这个，就能理解Presenter注入到Activity的步骤！）

@Module 带有此注解的类，用来提供依赖，里面定义一些用@Provides注解的以provide开头的方法，这些方法就是所提供的依赖，Dagger2会在该类中寻找实例化某个类所需要的依赖。

@Provider 在@Module注解的类中，使用@Provider注解，说明提供依赖注入的具体对象

@Component 简单说就是，可以通过Component访问到Module中提供的依赖注入对象。假设，如果有两个Module，AModule、BModule，如果Component只注册了AModule，而没有注册BModule，那么BModule中提供的对象，无法进行依赖注入！

@SubComponent 该注解从名字上就能知道，它是子Component，会完全继承父Component的所有依赖注入对象！

@Sigleton 被注解的对象，在App中是单例存在的！

@Scope 用来标注依赖注入对象的适用范围。

@Named(@) 因为Dagger2 的以来注入是使用类型推断的，所以同一类型的对象就无法区分，可以使用@Named注解区分同一类型对象，可以理解为对象的别名！

2. 注入步骤

1) 简单注入（通过构造函数）

将我们需要注入的对象的类的构造参数使用@Inject标注，表示dagger2可以实例化这个类
编写Component接口使用@Component进行标注，里面的void indect()的参数表示要将依赖注入到的目标位置
使用Android Studio的build编译项目，使它自动生成我们编写的Component所对应的的类，生成的类的名字格式为“Dagger+我们所定义的Component的名字”
在需要注入的类中使用@Inject标注要注入的变量；然后调用自动生成的Component类的方法create()或builder().build()，然后inject到当前类；在这之后就可以使用这个@Inject标注的变量了

事实上Component就是注入者与被注入者之间联系的桥梁，有了它dagger2才知道要把谁注入到什么地方，所以它是十分重要且不可缺少的。

2) 使用Module的注入

刚才通过@Inject就可以完成依赖，为什么还要用Module类来提供依赖？之所以有Module类主要是为了提供那些没有构造函数的类的依赖，这些类无法用@Inject标注，比如第三方类库，系统类，以及我们在MVP模式中编写的View接口。

编写Module类并使用@Module标注这个类，编写方法返回值为我们需要inject的类型并使用@Provides标注这个方法；

拓展情况：Module中其中一个依赖又要依赖另外一个依赖。（如下图）如果被@Provides标注的方法带有参数，dagger2会自动寻找本Module中其他返回值类型为参数的类型的且被@Provides标注的方法，否则会去看这个类的构造函数是否被@Inject标注了

module标注

编写Component接口，使用@Component标注这个接口，并使用modules=的方法链接上第一步中编写的Module类；
之后和不使用module注入的步骤一样，使用AS进行编译，生成对应component类，接着标注需要注入的对象，并调用自动生成的component类的builder()或create()方法。这里注意：在Module的构造函数带有参数且参数被使用的情况下，所生产的Component类就没有create()方法了。

通过上面这种方式，我们就能配合mvp进行使用dagger2了，比如将presenter注入到view层；值得一提的是谷歌不推荐直接将presenter的构造参数添加注解，更加推荐的是将presenter放到Module里进行管理，因为这样代码更加容易管理。

3. Component依赖

1) Component的依赖（dependencies属性）

当一个Component和另一个Component所提供的的依赖对象有重复的时候，我们没有必要完全再写一遍。Component可以通过dependencies属性依赖另一个Component，这种写法类似类的继承。

父Component中显式的写出需要暴露可提供给子Component的依赖；
子Component在注解中使用dependencies=来连接父Component；
子Component实例化

2) SubComponent的依赖|Part1

先定义子Component，使用@Subcomponent标注（不可同时再使用@Component）
子Component在注解中使用dependencies=来连接父Component；
子Component实例化

3) SubComponent的依赖|Part2（子Component构建时传入参数）

在子Component，定义一个借口或抽象类（通常定义为xxBuilder），使用@Subcomponent.Builder标注：
- 编写返回值为xxBuilder，方法的参数为需要传入参数的Module；
- 编写返回值为当前子Component的无参方法；
父Component中定义获得子Component.Builder的方法；

4. Scope作用域（单例）

只需提供依赖的类及Component都添加@Singelton标注即可

Component必须添加@Singleton标注
给Module中@provides标注的方法再标注上@Singleton，如果是无module的注入方式，则给注入类的构造方法标注@Singleton
实例化对象

测试log输出，结果为同一对象 Log测试

注意：如果使用@Singleton标注了构造参数，或者只标注了提供依赖的类而没有标注Component，在编译的时候分别会报如下两种错误： @Singleton错误用法报错

5. 使用规范

在使用dagger2的过程中，在定义一些类或方法的名字的时候，要遵守一些谷歌提出的固定标准，以方便代码阅读与维护：

定义的Component和Module的名字是无所谓的，但是一般遵照以Component或Module结尾的名称；
Module中用@Provides标注的方法的方法名是无所谓的，返回值是最重要的，但是一般遵照以provide开头的方法名；
Component中返回值为void且有参的方法，方法名是无所谓的，参数是最重要的代表的是要注入的目标位置，但是方法名一般为inject；
Component中返回值不为void且无参的方法，方法名是无所谓的，返回值是最重要的代表的是暴露给子Component使用的依赖或者是获取的子Component的类型。
编译后生成的Component实现类的名称是Dagger+我们所定义的Component接口的名称。