美文网首页AndroidWorld技术Android Testing
Android:dagger2让你爱不释手-重点概念讲解、融合篇

Android:dagger2让你爱不释手-重点概念讲解、融合篇

作者: 牛晓伟 | 来源:发表于2016-03-27 12:39 被阅读36327次

    前言

    Android:dagger2让你爱不释手-基础依赖注入框架篇这篇讲解了Inject,Component,Module,Provides是如何构成dagger2整个依赖注入框架

    component_module_inject.png

    因为dagger2的整个依赖注入框架已经构建完成,所以dagger2中剩下的Qualifier(限定符)、Singleton(单例)、Scope(作用域),SubComponent概念基本都是在对整个依赖注入框架进行细节上的完善。
    我还是依然从抽象概念的角度讲解,讲解每个概念在整个依赖注入框架中到底起了什么作用,因为dagger2本身不容易上手,只有真正的了解了每个概念的作用,在使用时才会得心应手,大家别急,后面的章节会有dagger2的sample。

    本节内容

    • Qualifier(限定符)、Singleton(单例)、Scope(作用域)、Component的组织方式概念讲解
    • dagger2能带来哪些实惠?
      在讲解时,我还依然沿用上一节的讲解方式,由简入难不断深入的进行。

    Qualifier(限定符)是什么鬼?

    上一节已经提到,Component是一个注入器(Injector),同时也起着桥梁的作用,一端是创建类实例端(创建类实例即负责生产类实例,下面会用该词来指代),另一端是目标类端(目标类需要进行依赖初始化的类,下面都会用目标类一词来指代),请看下图:

    新的关系.png

    创建类实例有2个维度可以创建:

    • 通过用Inject注解标注的构造函数来创建(以下简称Inject维度)
    • 通过工厂模式的Module来创建(以下简称Module维度)

    这2个维度是有优先级之分的,Component会首先从Module维度中查找类实例,若找到就用Module维度创建类实例,并停止查找Inject维度。否则才是从Inject维度查找类实例。所以创建类实例级别Module维度要高于Inject维度。

    现在有个问题,基于同一个维度条件下,若一个类的实例有多种方法可以创建出来,那注入器(Component)应该选择哪种方法来创建该类的实例呢?如下图,基于Inject维度:

    Qualifier_迷失.png

    我把上面遇到的问题起个名字叫依赖注入迷失
    那么可以给不同的创建类实例的方法用标识进行标注,用标识就可以对不同的创建类实例的方法进行区分(标识就如给不同的创建类实例方法起了一个id值)。同时用要使用的创建类实例方法的标识目标类相应的实例属性进行标注。那这样我们的问题就解决了,提到的标识就是Qualifier注解,当然这种注解得需要我们自定义。

    Qualifier(限定符)就是解决依赖注入迷失问题的。
    注意
    dagger2在发现依赖注入迷失时在编译代码时会报错。

    Scope(作用域)你真是挺坑的一个东东

    我们暂且不介绍Singleton,因为它是Scope的一个默认实现,理解了Scope自然就理解Singleton了。
    为什么要说Scope比较坑呢,在刚开始接触Scope的时候,看了网上各种关于Scope的介绍,总结Scope的作用是:

    Dagger2可以通过自定义Scope注解,来限定通过Module和Inject方式创建的类的实例的生命周期能够与目标类的生命周期相同。或者可以这样理解:通过自定义Scope注解可以更好的管理创建的类实例的生命周期。

    网上也有各种例子比如:自定义一个PerActivity注解,那创建的类实例就与Activity“共生死“
    或者用Singleton注解标注一个创建类实例的方法,该创建类实例的方法就可以创建一个唯一的类实例。

    我对PerActivity和Singleton这些魔法性的注解产生了好奇,同时也产生了迷惑?迷惑是:

    • 自定义Scope注解到底是怎么工作的
    • 自定义的注解应该怎么定义名字,是不是定义一个名字就可以达到相应名字的效果。比如Singleton就可以实现单例,PerActivity就可以创建的类实例与Activity“共生死“,是不是我定义一个PerFragment的注解,同样可以达到创建的类实例就与Fragment“共生死“。大家别对我这幼稚的想法千万别见笑,当时我就把dagger2的Scope注解想的如此神通广大了

    于是乎我在网上进行各种搜索,并且分析源码,最后的得到的结果也是让我大吃一惊。自定义的Singleton、PerActivity注解根本就没有这些功能。所以也可以说我被Scope坑了,或者是由于自己没有对Scope有一个深入的理解,被自己坑了。这先卖个关子,后面会具体介绍Scope。

    Component组织方式重点中的重点

    为什么说Component组织方式是重点中的重点呢?因为前面的各种概念都是在做铺垫工作,现在我们会从一个app的角度来把这些概念融合在一起。

    一个app中应该根据什么来划分Component?

    假如一个app(app指的是Android app)中只有一个Component,那这个Component是很难维护、并且变化率是很高,很庞大的,就是因为Component的职责太多了导致的。所以就有必要把这个庞大的Component进行划分,划分为粒度小的Component。那划分的规则这样的:

    • 要有一个全局的Component(可以叫ApplicationComponent),负责管理整个app的全局类实例(全局类实例整个app都要用到的类的实例,这些类基本都是单例的,后面会用此词代替)
    • 每个页面对应一个Component,比如一个Activity页面定义一个Component,一个Fragment定义一个Component。当然这不是必须的,有些页面之间的依赖的类是一样的,可以公用一个Component。

    第一个规则应该很好理解,具体说下第二个规则,为什么以页面为粒度来划分Component?

    • 一个app是由很多个页面组成的,从组成app的角度来看一个页面就是一个完整的最小粒度了。
    • 一个页面的实现其实是要依赖各种类的,可以理解成一个页面把各种依赖的类组织起来共同实现一个大的功能,每个页面都组织着自己的需要依赖的类,一个页面就是一堆类的组织者。
    • 划分粒度不能太小了。假如使用mvp架构搭建app,划分粒度是基于每个页面的m、v、p各自定义Component的,那Component的粒度就太小了,定义这么多的Component,管理、维护就很非常困难

    所以以页面划分Component在管理、维护上面相对来说更合理。

    Singleton没有创建单例的能力

    为什么要谈到创建单例呢?因为上面谈到一个app要有一个全局的Component(我们暂且叫ApplicationComponent),ApplicationComponent负责管理整个app用到的全局类实例,那不可否认的是这些全局类实例应该都是单例的,那我们怎么才能创建单例?

    上一节提到过Module的作用,Module和Provides是为解决第三方类库而生的,Module是一个简单工厂模式,Module可以包含创建类实例的方法

    现在Modlule可以创建所以类的实例。同时

    Component会首先从Module维度中查找类实例,若找到就用Module维度创建类实例,并停止查找Inject维度。否则才是从Inject维度查找类实例。所以创建类实例级别Module维度要高于Inject维度。

    所以利用以上2点,我们就可以创建单例。

    • 在Module中定义创建全局类实例的方法
    • ApplicationComponent管理Module
    • 保证ApplicationComponent只有一个实例(在app的Application中实例化ApplicationComponent)

    dagger2中正真创建单例的方法就是上面的步骤,全局类实例的生命周期也和Application一样了,很关键的一点就是保证ApplicationComponent是只初始化一次。那估计有朋友就会问Singleton那岂不是多余的?
    答案当然是 no no no。Singleton有以下作用:

    • 更好的管理ApplicationComponent和Module之间的关系,保证ApplicationComponent和Module是匹配的。若ApplicationComponent和Module的Scope是不一样的,则在编译时报错。
    • 代码可读性,让程序猿更好的了解Module中创建的类实例是单例。

    组织Component

    我们已经把一个app按照上面的规则划分为不同的Component了,全局类实例也创建了单例模式。问题来了其他的Component想要把全局的类实例注入到目标类中该怎么办呢?这就涉及到类实例共享的问题了,因为Component有管理创建类实例的能力。因此只要能很好的组织Component之间的关系,问题就好办了。具体的组织方式分为以下3种:

    依赖方式
    一个Component是依赖于一个或多个Component,Component中的dependencies属性就是依赖方式的具体实现

    包含方式
    一个Component是包含一个或多个Component的,被包含的Component还可以继续包含其他的Component。这种方式特别像Activity与Fragment的关系。SubComponent就是包含方式的具体实现。

    继承方式
    官网没有提到该方式,具体没有提到的原因我觉得应该是,该方式不是解决类实例共享的问题,而是从更好的管理、维护Component的角度,把一些Component共有的方法抽象到一个父类中,然后子Component继承。

    Scope真正用武的时候了

    前面也提到Scope的一些基本概念,那Scope的真正用处就在于Component的组织。

    • 更好的管理Component之间的组织方式,不管是依赖方式还是包含方式,都有必要用自定义的Scope注解标注这些Component,这些注解最好不要一样了,不一样是为了能更好的体现出Component之间的组织方式。还有编译器检查有依赖关系或包含关系的Component,若发现有Component没有用自定义Scope注解标注,则会报错。
    • 更好的管理Component与Module之间的匹配关系,编译器会检查 Component管理的Modules,若发现标注Component的自定义Scope注解与Modules中的标注创建类实例方法的注解不一样,就会报错。
    • 可读性提高,如用Singleton标注全局类,这样让程序猿立马就能明白这类是全局单例类。
    app的结构.png

    总结

    关于dagger2概念性的东西基本都已经介绍完毕,剩下的比如Lazy、Provide等注解就不做介绍了,它们太简单了。同时也着重介绍了Scope,Qualifier等概念。还从整个app的角度来分析Component的组织方式。希望对大家能有帮助,因为dagger2上手还是比较复杂的,其实关键一点就是对于各种概念性的东东不了解,不知道它们到底有啥用途。所以我希望能帮到初学者对dagger2有一个整体性概念性的了解,然后在看网上的例子时能神清气爽。

    Android:dagger2让你爱不释手-终结篇

    个人简介
    本人是一名android开发工程师,开发android多年,若有志同道合的朋友想联系我,可以加我的:qq/微信: 704451290

    欢迎各位多多交流,转载请标明出处。

    本人微信:704451290

    本人公众账号

    相关文章

      网友评论

      • 09d818a5a0f6:虽然没有详细讲解用法,细节上的东西,但是终于弄懂了,感谢LZ
      • 背锅TV丶伴奏大师:能有实例代码就更好了,我建议要多贴合代码讲解更容易理解,只说概念太抽象
      • c1788e13b409:楼主辛苦了,后面讲的多个component依赖关系,如果有代码示例展示说明就更好了。
      • f86f976115c3:如果需要注入第三方框架,源码又不能改动.那么如何@Inject第三方框架的构造方法我在使用第三方框架时使用Dagger2就出现这个问题了.目前还是不知道咋解决
        阿泰尔弋:写Module,@Provider provideXXX()方法提供该第三方库的实例
      • 黑白咖:签到
      • d8184ca3c970:楼主不但自己会,还会都教,不当老师可惜了。虽然我也用了dragger2,但是还是感觉dragger2没什么屌用,还要多写一大堆代码。:relieved: 是不是没领悟精髓。
      • ximencx:那个单例 必须绑定application才能生效么??为什么和别的blog说的不一样,他们就是加个Singleton就说单例了
      • SingorZhu:Inject 优先级,这个之前看的文章也有疑问,首次在这里得到了答案。还有就是理清了@Qualifier 和 @Scope 。赞
      • 29778cb33978:这是我看到的Dagger2讲解最详细的了,感谢博主的这篇文章,看了你的Dagger2所有的讲解后,自己终于明白了怎么使用Dagger2。不知道博主能不能对Rxjava2的详细的使用,特别是的他的操作符和线程切换,还有就是与Retrofit想结合使用,怎么来封装一个框架。非常期待你的文章。大神,膜拜。
        牛晓伟:@乐乐00000 谢谢您的支持,有充裕的时间可以写下
      • 阿V很简单:确实说的很好,dagger研究多了都会用,但是很难短时间从整个架构方面来考虑
      • chen_666:楼主写的通俗易懂,牛逼牛逼, :+1:
      • android_la_baby:非常喜欢
      • 风中追风_:写的太好了,通俗易懂,看了那么多,就你的写的最明白了
      • 533be7ba33fe:非常好,谢谢
      • DoAndKeep:真的犀利...感激!继续打赏! :stuck_out_tongue:
        牛晓伟: @DoAndKeep 多谢
      • flykule:请问,既然自定义scope注解实现的是和singleton一样的功能,那么有什么必要进行自定义?
      • 工程师milter:LZ文章讲的很好,但是scope的作用还是没有讲对。我补充一点:
        首先我们自定义一个scope注解,假如名为MyScope。假如一个component B前面加了@Myscope注解,那么对于B管理的Modules,每个module里面有许多provideXXX方法,假设某个module中有一个这样的方法: ClassA provideObjectA(){ return new ClassA();}
        下面就是见证奇迹的时刻,如果你为这个方法加上@Myscope注解,那么Dagger2会在第一次使用该方法创建ObjectA时将它缓存起来,下次再需要提供ObjectA时,就直接使用缓存的对象
        ,而不会再次创建新的ObjectA,如果没有加@Myscope注解,则会每次都创建一个新的ObjectA对象。
        工程师milter: @牛晓伟 建议lz再完善下文章内容哈,不然很多新人看了会更迷惑的
        牛晓伟:@milter 对的,scope也可理解为在一定scope为,该实例是单例的
        工程师milter:@milter 所以说,认为Scope仅仅是组织component,是不对的。
      • flyrun1:所以类 是打错了么,应该是什么
      • c730e67cc751:是不是可以理解为:@Singleton可以换成其他自定义的scope,用于对ApplicaitonComponent修饰,也同样可以实现单例?
        UsherBaby:Module维度和Inject维度顺序有点错误。文章说的顺序条件是在同一个Component中。假如在父子Component环境中,是没有顺序之分的,照样会出现依赖迷失,这个时候也是需要Qualifier的,如A componnet是B component的父component,A module提供了Foo类的provide方法,并且Foo类构造函数有@inject,那么在使用B component的类中inject Foo类时,就会出现依赖迷失。
        c730e67cc751:@牛晓伟 好的,非常感谢您 :grin:
        牛晓伟:@_王剑锋 是的,就是给注解起了一个有意义的名字,
      • c730e67cc751:你好,看完了之后,我大概有点了解Scope的工作原理,但是还有一点疑问。据你所说,ApplicationComponent 如果是单例的,Scope(Singleton)是为了更好组织Component和Moudle之间的关系,真正实现单例的功能是因为在Application中实例化ApplicationComponent。现在场景是这样的,假设我的ActivityComponent依赖了这个ApplicationComponent,然后ActvityComponent是需要添加Scope的,不然会报错。请问这个ActivityComponent中提供的依赖注入是如何实现和Activity的生命周期一致,而不是单例的?
        牛晓伟:@_王剑锋 是的,内部实现一句话两句话说不清
        c730e67cc751:@牛晓伟 这样的嘛,如果在fragment注入就和fragment生命周期一致吗,内部是如何实现的,看apt生成的代码看不出来
        牛晓伟:@_王剑锋 和application道理是一样的,ActivityComponent是在Activity中实例化的,
      • 5ebab1017057:楼主好人 :heart_eyes:
      • 接地气的二呆:博主 Scope 这个还是没讲啊 ~~ 后面的文章也没看到Scope的讲解
        牛晓伟: @接地气的二呆 scope其实主要是用来起可读性,其次是编译器会检查对象的适用范围。自己动手写写,就会有感觉了
        接地气的二呆:@牛晓伟 :sweat: 我的理解能力比较差 还是不知道咋用的,搜了好多文章总感觉 scope 这块都讲的不清楚
        牛晓伟: @接地气的二呆 第二篇里面有
      • WYWT:概念讲的真棒
      • fe9fe0de7b28:好好好好好
      • 一斤十六两:原创文章,必须支持~~~
      • shunxir:写的真好,感谢。。 :stuck_out_tongue_closed_eyes: 。。
        牛晓伟: @shunxir 谢谢支持
      • e236fc2be846:挺好 :+1:
      • fov:写的简直太棒了,自从看了你的讲解后,困扰我好久的问题终于解决了.
        牛晓伟: @fov 多谢
      • shijunxing:很棒,看一遍能看懂
        牛晓伟: @shijunxing 谢谢
      • _Fanly:不错!!!学习了 :smile:
      • 程序亦非猿:火钳留个名 以后看你的来学dagger2
      • HelloVass:棒,把几个最重要的让初学者都会搞错的地方讲清楚了。尤其是关于 component 的划分粒度,这个很多文章都没有提到。导致,每个用 dagger2 的项目都五花八门的分法。我那时候差点走火入魔,按页面划分,这个可以的。但是最好再具体点,因为 activity 还可以包含多个 fragment,这里的 component 设计,可以再详细讲讲
        牛晓伟:@HelloVass 谢谢支持,没问题完全可以再详细些

      本文标题:Android:dagger2让你爱不释手-重点概念讲解、融合篇

      本文链接:https://www.haomeiwen.com/subject/kxmclttx.html