Dagger与注入

浅谈注入的理解

什么是注入

注入通常作为一个完整框架嵌入到一个项目中，提供一种新的隐式对象初始化方式，通过配置文件、注解等方式指定的变量对象，将由该注入框架负责初始化工作，提供（新建或单例等）合适的特定实现类对象，从代码上看，声明注入对象的类不再需要初始化该字段，即可直接使用。

注入过程

1. 定义 interface 接口
2. 提供接口实现类
3. 配置实现类作为接口对象提供方
4. 通过注入框架，初始化（注入）所需的可注入类型字段变量

优点

注入模式主要用于以近乎静态配置的方式，自动构造（new）对象并提供调用方使用，简化、隐藏繁琐的对象初始化代码，提供对象初始化级别上的隔离，实现更纯粹的面向接口编程，通过对接口型变量进行注入，最终完成从对象变量、方法调用与具体实现类之间的完全解耦。因此，可完全透明地更换实现类而无需修改其他调用类代码，同时也为单体测试提供更合适的 Mock 入口。

尤其当目标对象比较泛用时，可大量减少重复性的模板构造代码，相当于一个隐式自动装配工厂。

适用场景

注入框架自动完成对象初始化，通常主要通过静态方式进行指定配置，因此产生的对象都是模板级别的产品。

适合用于注入的对象属于不太需要动态变换构造参数值的类，例如以下几种：

• 实体类
• 容器类
• 单例工具类

缺点

随着解耦程度越高，代码的调用关系越模糊，越难以通过 IDE 跟踪具体实现代码的逻辑调用链，由于调用关系交由注入框架内部逻辑控制并对使用者隐藏，使得接手项目的程序员更难以阅读代码，并理解其中的整个调用链关系图谱，同时也为代码调试、重构增加了难度，并有可能引入难以预知的潜在Bug。

---

Dagger

Square 公司开源的一套针对 Android 平台的注入框架。
使用该框架需要显式声明可注入对象工厂方法、Module、目标注入类直接的关系，用于提供完整的编译时验证，任何缺失、未使用的注入绑定将报告错误。

主要概念

• ObjectGraph：依赖与注入的管理核心类，管理单元为 Module
• @Module + @Provides：用于声明提供可注入对象的工厂类及其方法
• @Inject：用于声明需要注入的对象变量
• @Module(injects={class...})：绑定当前 Module 与目标注入类
• ObjectGraph.inject：在目标注入类中主动调用，注入 Module 提供的对象

使用方式

• 使用 @Module + @Provides 注解工厂类及其工厂方法，其中工厂方法需要以provide开头命名
• 使用 @Inject 注解字段对象，Dagger 通过ObjectGraph.inject方法进行自动注入
• （可选）使用 @Inject 注解类构造器，作为 Dagger 产生可注入对象的默认工厂方法，方法参数将从其依附的 Module 注入树中进行提取
• 初始化 ObjectGraph：ObjectGraph.create(modules...)
• 使用 ObjectGraph 自动注入对象：objectGraph.inject(this)
• 从 ObjectGraph 中提取对象：objectGraph.get(class)

@Module声明

@Module 注解用于任意一个普通类，声明其为 Module 类并包含一系列 @Provides 注解的方法，用以提供该类型的可注入对象（工厂方法）。

@Module 包含以下几个字段：

• includes = {Modules...}：组合其他 Modules（及其所有子 Modules）
• addsTo = class：（可选）当前 Module 可通过 ObjectGraph.plus() 方法依附到的目标宿主类
• overrides = boolean：当前 Module 声明的 Provide 方法可覆盖其他 Module 的相同工厂方法，应仅用于测试或开发环境
• complete = boolean：当前 Module 中 Provide 方法的参数需要由（不存在 includes 及 addsTo 列表中的）外层 Module 提供时，声明为 false，表示该 Module 作为抽象父类提供扩展
• library = boolean：当前 Module 中存在额外的 Provide 方法，不需要注入到目标 injects 对象时，声明为 true
• injects = {class...}：当前 Module 适配的目标类，这些类可由当前 Module 提供注入对象，并用于 objectGraph.inject 和 objectGraph.get 方法

注意

• @Inject 注解字段变量时，不可以声明为 private 或 final
• @Inject 只能注解一个构造器
• 在使用 @Inject 注解字段对象的类中，可省略对无参构造函数的 @Inject 注解
• 所有注入点必须在 @Module(injects) 中列出

Provider注入

Provider 作为 JSR330 标准接口，用于包装一个注入对象，每次调用 get() 方法时产生一个新对象返回。

使用 Provider 注入时，只需提供 Provider 包装的目标对象 provide 方法，Provider 将由 Dagger 进行自动封装提供。

@Inject Provider<Filter> filterProvider;

void method(){
    filterProvider.get();
    ...
}

或

@Provides
public ObjInf provideObj(Provider<ObjImpl> p) {
    return p.get();
}

由于容易产生难读代码，Dagger 不推荐滥用 Provider，除非在应对遗留代码问题等非正常场合。

参考

Dagger - square
Dagger——Android上的依赖注入框架

---

Dagger2

Google 基于 Dagger1 进行二次开发的注入框架，现在已被 Square 承认用于取代 Dagger1 的新版本。

与 Dagger1 对比

Dagger1

• 优点：
  提供编译时验证
  自动生成代码，提供完整调用追踪，方便调试（与Guice比较）

• 缺点：
  自动生成代码质量低，不易阅读
  使用了反射
  对象依赖图效率低，生成过程不可追踪
  使用映射表式的API（@Module 配置等）
  Scope 仅支持 @Singleton

Dagger2

• 优点：
  完全不使用反射
  完全可追踪，并保证自动生成代码可读性
  简化API
  提高性能，比 Dagger1 快13%
  支持方法注入
  支持自定义 Scope
  提供隐式 null 检测（除非声明为 @Nullable）

@Module

所有 @Module 均定义为 complete = false & library = true，不再需要 complete、library、addsTo、injects、staticInjections 的属性指定，编译时将使用宽松验证。

同时，overrides 和静态注入将不再提供支持。要实现相同功能，可考虑派生目标 Module 子类提供新对象。

includes 属性仍然可用。

ObjectGraph

ObjectGraph 可通过 Module 的 class 或实例对象进行初始化创建。

ObjectGraph.create(ModuleOne.class, ModuleTwo.class, new ModuleThree("hello!"));

Component

Component 提供另外一种方式，组织 Modules 并构建 ObjectGraph。
在 Component 接口中定义方法，与在 Dagger1 中声明 @Module(injects) 效果相同。

@Component(
  modules = {
    ModuleOne.class,
    ModuleTwo.class,
    ModuleThree.class,
  }
)
interface MyComponent {
  /* Functionally equivalent to objectGraph.get(Foo.class). */
  Foo getFoo();
  /* Functionally equivalent to objectGraph.get(Bar.class). */
  Bar getBar();
  /* Functionally equivalent to objectGraph.inject(aBaz). */
  Baz injectBaz(Baz baz);
}

// 实例化 Component
// Dagger2 自动生成 MyComponent 的接口实现，并以 Dagger 为前缀命名
MyComponent myComponent = DaggerMyComponent.create();

// 使用 Module 实例进行初始化时，通过这种方式实例化 Component
MyComponent myComponent = DaggerMyComponent.builder()
    // ModuleOne and ModuleTwo don't need to be set explicitly
    .moduleThree(new ModuleThree("hello!"))
    .build();

注意

注入点与 provide 方法均需要考虑指定 @Nullable，否则编译时 null 验证失败时将抛出错误。

参考

Dagger2 - Google github
更加强大的Dagger2

dagger2 让你爱不释手：基础依赖注入框架篇
dagger2 让你爱不释手：重点概念讲解、融合篇
dagger2 让你爱不释手：终结篇

【腾讯Bugly干货分享】深入理解 ButterKnife，让你的程序学会写代码