Dagger2 小记

0x00 开始

以最无趣的 “Hello World” 开始吧。

public class Hello {
    
    public String greeting(){
        return "Hello World.";
    }
    
}

然后在 TextView 中显示,常规的方法是:

Hello hello = new Hello();
textViewHello.setText(hello.greeting());

那么,如果使用 Dagger2 进行依赖注入,我们使用 @Inject 将 Hello 实例注入:

@Inject Hello hello;

...

textViewHello.setText(hello.greeting());

这里存在一个问题:要怎么实例化 Hello 呢? Dagger2 提供 @Inject 标注,在构造函数中标注后,当需要实例化时,Dagger2 就会调用这个构造函数:

@Singleton
public class Hello {

    @Inject public Hello() {}
    
    public String greeting(){
        return "Hello World.";
    }
    
}

PS: 加入 Hello 也需要注入其他类呢? @Inject 同样轻松搞定,构造函数参数以及类成员属性均可轻松注入。

这时依然无法工作,如果你运行程序,会产生悲伤的 NullPointerException,那么还差什么呢?

我们需要创建一个Component,Component是Provider和Injector之间的桥梁。

@Singleton
@Component
public interface DemoComponent {

    void inject(MainActivity activity);

}

Dagger2 会自动生成一个 DaggerDemoComponent,在 Activity 中调用注入:

DaggerDemoComponent.create().inject(this);

打完收工!

当然,你还需要通过 gradle 引入 Dagger2:

...
apply plugin: 'com.neenbedankt.android-apt'

buildscript {
    repositories {
        jcenter()
    }

    dependencies {
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.4'
    }
}

...

dependencies {
    ...
    provided 'javax.annotation:javax.annotation-api:1.2'
    apt 'com.google.dagger:dagger-compiler:2.0.2'
    compile 'com.google.dagger:dagger:2.0.2'
}

0x01 进阶

如上所述,我们自己写的代码可以通过 @Inject 实例化并注入,但若是第三方库提供的类呢?

这时需要用到 @Module, @Provide:

@Module

Module 是拥有可以提供依赖的函数的类,我们定义一个类,标注为 @Module,然后 Dagger2 就知道哪里可以找到构建一个对象所需要的依赖啦。而且 Module 被设计为可以被分割和组合的模式,有益于模块的划分。

@Provide

在标注为 @Module 的类中的函数可以标注为 @Provide, 标示可以提供相应的依赖,函数的前缀必须为 provides.

@Module
public class DemoModule {

    @Provides @Singleton
    public GithubService provideGithubService() {
        return new GithubService();
    }

}

然后我们要告知 Component 使用这个 Module:

@Singleton
@Component(modules = {DemoModule.class})
public interface DemoComponent {

    void inject(MainActivity activity);

}

@Component 可以通过 dependencies 申明依赖依他的 @Component。

@Singleton

这是标示一个单例的注释,可以和 @Provide 共同标注一个函数,标示这个函数返回的对象都是单例的,也可以和 @Component 一起标注一个Component,标示这个 Component 的 Scope 是全局的。

@Scope

Scopes 非常的有用,Dagger2 可以通过自定义注解限定注解作用域。

@Qualifier

当类的类型不足以鉴别一个依赖的时候,我们就可以使用这个注解标示。

例如:在Android中,我们会需要不同类型的 Context,所以我们就可以定义 Qualifier 注解 @ForApplication 和 @ForActivity,这样当注入一个 Context 的时候,我们就可以告诉 Dagger 我们想要哪种类型的 Context。

0x02 参考

Dagger 2

Tasting Dagger 2 on Android

Dependency injection with Dagger 2 - the API

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

推荐阅读更多精彩内容