原文链接:http://google.github.io/dagger/users-guide.html
从Why Dagger 2 is Different 开始翻译。
为什么Dagger2是不同的
依赖注入的框架在几年前就已经存在了,有许多中API实现了依赖和注入。为什么要重复造轮子呢?Dagger2是第一个实现了全部代码生成。它的目标原则是模仿用户那些手写的代码(实现依赖注入的代码)使依赖注入的过程实现起来更加简单。
使用Dagger2
我们将通过CoffeeMaker的例子证明Dagger的依赖注入。已经完成的代码可以从coffee example查看,并进行编译和运行。
声明依赖
使用Dagger为你的应用类构造实例,并且满足它们的依赖。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构建的
满意的依赖
默认情况下,Dagger通过构造请求类型对象的实例满足每一个依赖。像上面描述(例子)的那样,当你请求(需要)一个CoffeeMaker对象,你将通过调用new Caffee()对象获得一个对象,注入到可以注入的参数中。
但是@Inject不是任何对象都可以标记的
- interface是不能被构建的
- 第三方的类不能被注解
- 通过配置得到的对象,仍然必须通过配置得到(Builder模式构造的对象)
在这些情况下,@Inject是不足的(尴尬的),但是可以通过使用@Provide注解标注的方法来满足依赖,这个方法的返回值的来满足那些依赖。
就像下面这样:当需要一个Heater对象时provideHeater()方法会被执行。
@Provides
static Heater provideHeater() {
return new ElectricHeater();
}
@Provides同样可以为它自己提供依赖,当我们需要一个Pump对象时,下面这个例子返回一个Thermosiphon对象时
@Provides
static Pump providePump(Thermosiphon pump) {
return pump;
}
所有被标注了@Provides注解的方法必须要属于一个module类(模块),这仅仅需要一个类被@module注解标注。
@Module
class DripCoffeeModule {
@Provides
static Heater provideHeater() {
return new ElectricHeater();
}
@Provides
static Pump providePump(Thermosiphon pump) {
return pump;
}
}
注:通常@Provides标注的方法名都拥有provide前缀,@Module标注的类都有一个叫做Module的后缀。
构建对象关系图
@Inject注解和@Provides注解类由他们之间的依赖关系形成了对关系的图,通过一组定义好的关系图调用代码就像使用应用程序的main方法或者Android的应用程序访问。它的定义是通过一个接口:具备无参的方法和需要的返回值类型。通过使用@component注解去标注这样一个接口和通过module参数去配置module类型,Dagger2随后会生成一个符合的实现。
@Component(modules = DripCoffeeModule.class)
interface CoffeeShop {
CoffeeMaker maker();
}
Dagger2会自动为它生成实现类,实现的名字是具有Dagger的前缀加上接口的名称。通过使用builder方法获得实例。调用Builder方法配置依赖,调用build方法获得实例。
CoffeeShop coffeeShop = DaggerCoffeeShop.builder() .dripCoffeeModule(new DripCoffeeModule()) .build();