框架深入| Dagger2深入浅出 Part1_使用操作

  • 什么是Dagger2?
    Dagger2是Dagger的升级版,是一个依赖注入框架,第一代由大名鼎鼎的Square公司共享出来,第二代则是由谷歌接手后推出的,现在由Google接手维护。
    google / dagger [GitHub地址]
  • 什么是依赖注入?
    依赖注入是面向对象编程的一种设计原则,其目的是为了降低程序耦合,这个耦合就是类之间的依赖引起的。

Dagger2专题

框架深入| Dagger2深入浅出 Part1_使用操作
框架深入| Dagger2深入浅出 Part2_源码分析

如何使用Dagger2

0. 导入Dagger2

// Add Dagger dependencies
dependencies {
  compile 'com.google.dagger:dagger:2.x'
  annotationProcessor 'com.google.dagger:dagger-compiler:2.x'
}

1. 关键的注解

@Inject
这个注解是用来说明该注解下方的属性或方法需要依赖注入。(如果使用在类构造方法上,则该类也会被注册在DI容器中作为注入对象。很重要,理解这个,就能理解Presenter注入到Activity的步骤!)

@Module
带有此注解的类,用来提供依赖,里面定义一些用@Provides注解的以provide开头的方法,这些方法就是所提供的依赖,Dagger2会在该类中寻找实例化某个类所需要的依赖。

@Provider
在@Module注解的类中,使用@Provider注解,说明提供依赖注入的具体对象

@Component
简单说就是,可以通过Component访问到Module中提供的依赖注入对象。假设,如果有两个Module,AModule、BModule,如果Component只注册了AModule,而没有注册BModule,那么BModule中提供的对象,无法进行依赖注入!

@SubComponent
该注解从名字上就能知道,它是子Component,会完全继承父Component的所有依赖注入对象!

@Sigleton
被注解的对象,在App中是单例存在的!

@Scope
用来标注依赖注入对象的适用范围。

@Named(@)
因为Dagger2 的以来注入是使用类型推断的,所以同一类型的对象就无法区分,可以使用@Named注解区分同一类型对象,可以理解为对象的别名!

2. 注入步骤

1) 简单注入(通过构造函数)

  1. 将我们需要注入的对象的类的构造参数使用@Inject标注,表示dagger2可以实例化这个类


    构造测试类
  2. 编写Component接口使用@Component进行标注,里面的void indect()的参数表示要将依赖注入到的目标位置


    Component接口
  3. 使用Android Studio的build编译项目,使它自动生成我们编写的Component所对应的的类,生成的类的名字格式为“Dagger+我们所定义的Component的名字”
  4. 在需要注入的类中使用@Inject标注要注入的变量;然后调用自动生成的Component类的方法create()或builder().build(),然后inject到当前类;在这之后就可以使用这个@Inject标注的变量了


    实例化

    Log输出

事实上Component就是注入者与被注入者之间联系的桥梁,有了它dagger2才知道要把谁注入到什么地方,所以它是十分重要且不可缺少的。

2) 使用Module的注入

刚才通过@Inject就可以完成依赖,为什么还要用Module类来提供依赖?之所以有Module类主要是为了提供那些没有构造函数的类的依赖,这些类无法用@Inject标注,比如第三方类库,系统类,以及我们在MVP模式中编写的View接口。

  1. 编写Module类并使用@Module标注这个类,编写方法返回值为我们需要inject的类型并使用@Provides标注这个方法;

拓展情况:Module中其中一个依赖又要依赖另外一个依赖。(如下图)
如果被@Provides标注的方法带有参数,dagger2会自动寻找本Module中其他返回值类型为参数的类型的且被@Provides标注的方法,否则会去看这个类的构造函数是否被@Inject标注了

module标注
  1. 编写Component接口,使用@Component标注这个接口,并使用modules=的方法链接上第一步中编写的Module类;

    Component标注

  2. 之后和不使用module注入的步骤一样,使用AS进行编译,生成对应component类,接着标注需要注入的对象,并调用自动生成的component类的builder()或create()方法。这里注意:在Module的构造函数带有参数且参数被使用的情况下,所生产的Component类就没有create()方法了。

    调用

    打印log

通过上面这种方式,我们就能配合mvp进行使用dagger2了,比如将presenter注入到view层;值得一提的是谷歌不推荐直接将presenter的构造参数添加注解,更加推荐的是将presenter放到Module里进行管理,因为这样代码更加容易管理。

3. Component依赖

1) Component的依赖(dependencies属性)

当一个Component和另一个Component所提供的的依赖对象有重复的时候,我们没有必要完全再写一遍。Component可以通过dependencies属性依赖另一个Component,这种写法类似类的继承

  1. 父Component中显式的写出需要暴露可提供给子Component的依赖;


    父Component
  2. 子Component在注解中使用dependencies=来连接父Component;


    dependencies属性
  3. 子Component实例化


    子Component实例化

2) SubComponent的依赖|Part1

  1. 先定义子Component,使用@Subcomponent标注(不可同时再使用@Component
    子Component
  2. 子Component在注解中使用dependencies=来连接父Component;


    父Component
  3. 子Component实例化


    实例化

3) SubComponent的依赖|Part2(子Component构建时传入参数)

  1. 在子Component,定义一个借口或抽象类(通常定义为xxBuilder),使用@Subcomponent.Builder标注:
    • 编写返回值为xxBuilder,方法的参数为需要传入参数的Module;
    • 编写返回值为当前子Component的无参方法;
  2. 父Component中定义获得子Component.Builder的方法;

4. Scope作用域(单例)

只需提供依赖的类及Component都添加@Singelton标注即可

  1. Component必须添加@Singleton标注


    Singleton标记Component类
  2. 给Module中@provides标注的方法再标注上@Singleton,如果是无module的注入方式,则给注入类的构造方法标注@Singleton


    Singleton标记module
  3. 实例化对象


    实例化

    测试log输出,结果为同一对象


    Log测试

注意:如果使用@Singleton标注了构造参数,或者只标注了提供依赖的类而没有标注Component,在编译的时候分别会报如下两种错误:

@Singleton错误用法报错

5. 使用规范

在使用dagger2的过程中,在定义一些类或方法的名字的时候,要遵守一些谷歌提出的固定标准,以方便代码阅读与维护:

  1. 定义的Component和Module的名字是无所谓的,但是一般遵照以Component或Module结尾的名称;
  2. Module中用@Provides标注的方法的方法名是无所谓的,返回值是最重要的,但是一般遵照以provide开头的方法名;
  3. Component中返回值为void且有参的方法,方法名是无所谓的,参数是最重要的代表的是要注入的目标位置,但是方法名一般为inject;
  4. Component中返回值不为void且无参的方法,方法名是无所谓的,返回值是最重要的代表的是暴露给子Component使用的依赖或者是获取的子Component的类型。
  5. 编译后生成的Component实现类的名称是Dagger+我们所定义的Component接口的名称。

推荐阅读

从小白最易上手的角度 + 最新dagger.android
Dagger2从入门到放弃再到恍然大悟
相见恨晚的apt
Android APT 技术浅谈

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

推荐阅读更多精彩内容