dagger2 user guide

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

推荐阅读更多精彩内容

  • 文章翻译自Dagger官网,翻译水平有限,见谅。 引入 引用官网的引入说明,上面的部分都好理解,就是简单的comp...
    one_cup阅读 592评论 0 0
  • Dagger2 转载请注明原作者,如果你觉得这篇文章对你有帮助或启发,可以关注打赏。 前言本文翻译自Google ...
    轻云时解被占用了阅读 6,566评论 4 31
  • 几个问题 看到Dagger2这个词的时候,相信很多人会有很多的疑问如下:Dagger2如何使用在例子中?Injec...
    codeHoward阅读 6,920评论 4 10
  • 官方文档链接:https://google.github.io/dagger/users-guide.html 1...
    lanceJin阅读 828评论 0 4
  • 活蹦乱跳的它突然蔫儿了,有气无力,还特别黏人。躺在别人膝盖上,希望有人陪它。你去哪它就跟着,离开了,它就找个角落蹲...
    猫原阅读 200评论 0 0