Dagger官方文档

Dagger

为Android和Java打造的依赖注入框架

简介

使用Dagger

我们将使用一个咖啡机的例子来展示依赖注入和Dagger。

声明依赖

Dagger创建一个你的应用的实例并且满足他们的依赖。它使用javax.inject.Inject 注解来标明哪个构造函数或者成员属性是它感兴趣的。
使用@Inject来注解一个Dagger用来创建一个实例的构造方法。当一个新的实例被申请的时候,Dagger就会获取到请求参数值并且调用构造方法。

class Thermosiphon implements Pump {
  private final Heater heater;

  @Inject
  Thermosiphon(Heater heater) {
    this.heater = heater;
  }

  ...
}

Dagger也可以直接注入属性。下面这个例子直接为pump属性和heater属性分别获取了一个实例。

class CoffeeMaker {
  @Inject Heater heater;
  @Inject Pump pump;

  ...
}

如果你的类只有被 @Inject 标注的属性,但是却没有被其标注的构造方法,Dagger将使用无参构造方法(如果它存在的话)。缺少@Inject标注的类不能被Dagger构建。
Dagger不支持方法注入。

满足依赖

一般来讲,Dagger会使用上述方式来构造一个对应请求类型的实例,以此来满足依赖。当你请求了一个CofferMaker,将会调用new CofferMaker()并把它关联到属性中。

但是 @Inject 不能在以下情况工作:

  • 接口不能被构造
  • 第三方类不能被构造
  • 要注册的对象必须已经标注过!

在这种情况下尴尬的情况下,可以使用 @Provides 注解一个方法来满足依赖。方法的返回值定义了它将满足的依赖。
举个例子,provideHeater()将在Heater被请求时调用:

@Provides Heater provideHeater() {
  return new ElectricHeater();
}

被@Provides标注的方法也有可能有他们自己的依赖。当请求一个Pump的时候,这个方法返回一个 Thermosiphon 。

@Provides Pump providePump(Thermosiphon pump) {
  return pump;
}

所有的 @Provides的方法属于module。这是一个被@Module标注的类:

@Module
class DripCoffeeModule {
  @Provides Heater provideHeater() {
    return new ElectricHeater();
  }

  @Provides Pump providePump(Thermosiphon pump) {
    return pump;
  }
}

依照惯例,@Provides方法一般会有一个provide前缀,Module类一般会有一个Module后缀。

创建图

被@Inject 和 @Provides标注的类之间的依赖关系,可以使用一个对象图来表示。可以使用ObjectGraph.create()来获取这个图,其可以接收一个或者多个module。

ObjectGraph objectGraph = ObjectGraph.create(new DripCoffeeModule());

为了这个图能使用,我们需要去引导注入(bootstrap injection)。一般会在命令行程序中的main类中,或者在一个Android App的Activity中请求注入。在我们咖啡机的示例程序中,CoffeeApp类被用来启动依赖注入。我们让图来提供一个注入的示例:

class CoffeeApp implements Runnable {
  @Inject CoffeeMaker coffeeMaker;

  @Override public void run() {
    coffeeMaker.brew();
  }

  public static void main(String[] args) {
    ObjectGraph objectGraph = ObjectGraph.create(new DripCoffeeModule());
    CoffeeApp coffeeApp = objectGraph.get(CoffeeApp.class);
    ...
  }
}

只剩一件事还没做了,那就是图还不知道CoffeeApp类。我们需要像注册一个module一样显示地注册它:

@Module(
    injects = CoffeeApp.class
)
class DripCoffeeModule {
  ...
}

注入操作将会在编译期就让图生效。以此来发现一些问题。(Detecting problems early speeds up development and takes some of the danger out of refactoring.)
现在图已经被建立起来,而且根对象也被注入了,我们来运行一下我们的咖啡机。好玩吧。

$ java -cp ... coffee.CoffeeApp
~ ~ ~ heating ~ ~ ~
=> => pumping => =>
 [_]P coffee! [_]P
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,504评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,434评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,089评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,378评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,472评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,506评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,519评论 3 413
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,292评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,738评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,022评论 2 329
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,194评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,873评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,536评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,162评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,413评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,075评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,080评论 2 352

推荐阅读更多精彩内容