Dagger2 User's Guide
本文主要翻译官方自 user's guide 文档，并添加了一点个人理解，原文在此 http://google.github.io/dagger/users-guide.html
使用 dagger 的准备工作
在 gradle 中添加依赖
// root project build.gradle file
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:1.5.0'
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
}
// module build.gradle file
apply plugin: 'com.neenbedankt.android-apt'
...
dependencies {
...
apt 'com.google.dagger:dagger-compiler:2.1'
compile 'com.google.dagger:dagger:2.1'
...
}
dagger 用例
我们会示例使用依赖注入跟 dagger 来制作一个咖啡机程序，要获得完整的可编译运行的代码，请看 coffee example
声明依赖
Dagger 会对你程序中的类构建实例，并满足这些类的依赖。它使用 javax.inject.Inject
注解来区分哪些 构造方法与属性 是需要注入依赖的。
使用@Inject来注解一个构造方法，令dagger在创建实例的时候使用这个它。当需要一个新实例的时候，dagger会获取所需参数，并调用这个构造方法
class Thermosiphon implements Pump {
private final Heater heater;
@Inject
Thermosiphon(Heater heater) {
this.heater = heater;
}
...
}
dagger 可以直接注入到属性中。下面这个例子包涵了一个 heater 属性的 Heater 实例，和一个 pump 属性的 Pump 实例。
class CoffeeMaker {
@Inject Heater heater;
@Inject Pump pump;
...
}
如果你的类中有使用@Inject注解的属性，但没有@Inject注解的构造器，Dagger会注入这些属性，但不会创建新的实例。添加@Inject注解到不带参数的构造器意味着Dagger有可能会创建新的实例
Dagger支持对方法进行注入，不过注入到 构造器跟属性 是推荐的方式。
不带 @Inject 注解的类，是无法被Dagger构造的
满足依赖 (Satisfying Dependencies)
默认情况下，正如上文提到的，Dagger依靠创建一个被需要的对象来满足各个依赖。当你需要一个 CoffeeMaker, 它会通过 new CoffeeMaker() 拿到一个新对象，并设置好需要注入的属性。
不过 @Inject 并不适合所有情况。
- 接口是不能构建的
- 不能注解的第三方类
- 必须是配置好的对象(Configurable objects must be configured!)
在这些情况下，@Inject 变得无效甚至还会出错，应使用 @Provides 注解好的方法来提供这些依赖。方法的返回值，决定了它要满足什么依赖。
比如，当需要一个Heater对象的时候，provideHeater()就会被调用：
@Provides static Heater provideHeater() {
return new ElectricHeater();
}
所有的 @Provides 方法都需要归属到一个 module。module 是那些添加了 @Module 注解的类。
@Module
class DripCoffeeModule {
@Provides static Heater provideHeater() {
return new ElectricHeater();
}
@Provides static Pump providePump(Thermosiphon pump) {
return pump;
}
}
我们约定，@Provides 方法命名时带一个provide前缀，@Module 类的命名带一个Module后缀。
构建依赖图谱 (Building the Graph)
The @Inject and @Provides-annotated classes form a graph of objects, linked by their dependencies. Calling code like an application’s main method or an Android Application accesses that graph via a well-defined set of roots.
那些被@Inject与@Provides注解好的类，都是对象图谱的一员，连接他们的，是他们的依赖关系。调用main方法或者 Android Application 访问这个图谱通过一个定义好的根的集合。在 Dagger 2，这个集合定义在一个接口上，这个接口定义了无需参数并返回所需类型的方法。在这种接口上添加@Component注解，然后传入 module 类型到 modules 参数中，Dagger 2 随后会完整地生成一个符合该接口的实现。
@Component(modules = DripCoffeeModule.class)
interface CoffeeShop {
CoffeeMaker maker();
}
生成的接口实现的命名都会带一个'Dagger'前缀。要获得一个新实例，调用接口实现的builder()方法，然后使用返回的builder来设置好依赖并build()出一个新实例。
CoffeeShop coffeeShop = DaggerCoffeeShop.builder()
.dripCoffeeModule(new DripCoffeeModule())
.build();
注意：如果你的 @component 不是一个顶级类(top-level type)，生成的 component 的命名会包涵封装它的类的名字，并用一个下划线连接起来，例如以下代码：
class Foo {
static class Bar {
@Component
interface BazComponent {}
}
}
会生成如下命名的 component: DaggerFoo_Bar_BazComponent
现在，我们的 coffeeApp 可以简单地是使用 Dagger 生成的 CoffeeShop 实现，来获得一个注入好的 CoffeeMaker 了。
public class CoffeeApp {
public static void main(String[] args) {
CoffeeShop coffeeShop = DaggerCoffeeShop.create();
coffeeShop.maker().brew();
}
}
现在依赖图谱已经构建好，入口注入了，我们运行一下我们的 coffee maker app。哈哈
$ java -cp ... coffee.CoffeeApp
~ ~ ~ heating ~ ~ ~
=> => pumping => =>
[_]P coffee! [_]P