Dagger2解析2-Component的依赖关系

如果还没入门的,可以先去搜搜基本用法,本系列主要偏向原理

Dagger版本:2.11

上文简单讲解了最基本的用法和生成的代码解析,这里再次总结为一张图

这图不关注生成代码的部分

Dagger2依赖注入的结构,必不可少的元素有三种(Module,Component,以及被注入的目标本身)

  • 被注入的目标本身,对应上文中例子的Target,Target所需要的元素,
    需要标记@Inject才能自动初始化,@Inject在Dagger2中一般标记构造方法和成员变量

  • Module可以说是原材料工厂,所有被注入元素的实现都是Module生成的,无论Target的依赖关系多复杂,只要原材料够,就能实现注入(例如图中MemberA的依赖A,B,C,由ModuleA和ModuleB一起才能够提供全),甚至这个原材料有多余的也不怕

  • 具体的注入执行由Component完成(准确的说是里面的Injector完成)

总而言之,对于需要注入的目标类,Component只要能够提供足够的素材(目标里的整个依赖树),就可以实现注入,dagger生成代码的部分可以去看Dagger2解析-1

1.Component的依赖关系

和需要注入的目标一样,Component也有依赖关系(本身就是代表依赖关系的组件),包括

  • 在@Module中,由@Provides注解的方法
  • 任何类型,被@Inject注解构造函数
  • 其他的组件

2.Component的依赖关系--Module

先来看看Module注解里的内容

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Module {
  /**
   * Additional {@code @Module}-annotated classes from which this module is
   * composed. The de-duplicated contributions of the modules in
   * {@code includes}, and of their inclusions recursively, are all contributed
   * to the object graph.
   * 就是Module还能再包括其他的Module
   */
  Class<?>[] includes() default {};

  /**
   * Any {@link Subcomponent}- or {@code @ProductionSubcomponent}-annotated classes which should be
   * children of the component in which this module is installed. A subcomponent may be listed in
   * more than one module in a component.
   *
   * @since 2.7
   * 其他子组件(实际上是继承该模块所在的组件,也就是父组件的依赖关系)
   */
  @Beta
  Class<?>[] subcomponents() default {};
}

简单的Module上一篇文章Dagger2解析-1已经提过

class Member @Inject constructor(val name: String)

@Module
class MemberModule {
    @Provides
    fun provideMember(): Member = Member("from module Module provider")
}

在这里例子中,你也能让这个Module的构造函数添加参数

@Module
class MemberModule(val name:String) {
    @Provides
    fun provideMember(): Member = Member(name)
}

这样的话,生成DaggerTargetComponent后,Builder需要传入的Module就得你自己创建了

val target = Target()
DaggerTargetComponent.builder()
            .memberModule(MemberModule("from module constructor"))
            .build()
            .inject(target)

这里需要注意的是,和之前不同,Module在Dagger无法帮你创建的情况下,如果创建Builder时不传入这个Module,就会在运行时崩溃

关于Module添加SubComponent,这种子组件必须是用@SubComponent注解的,而且它的内部也必须拥有一个被@SubComponent.Builder注解的,这部分以后再详细介绍

2.1.多Module的情况

不多说,上代码

class MemberB @Inject constructor(val name: String)

class MemberA @Inject constructor(val name: String)


@Module
class MemberAModule(val name: String) {
    @Provides
    fun provideMemberA(): MemberA = MemberA(name)
}


@Module
class MemberBModule(val name: String) {
    @Provides
    fun provideMemberB(): MemberB = MemberB(name)
}

@Component(modules = arrayOf(MemberAModule::class, MemberBModule::class))
interface TargetComponent {
    fun inject(target: Target)
}

class Target {
    
    @Inject
    lateinit var memberA: MemberA

    @Inject
    lateinit var memberB: MemberB
}

还是比较简单的,这里提下需要注意地方

  • components所依赖的所有module里不能有重复的@Provides方法(重载,或者同返回类型的),这里还包括后面讲到的依赖的其他的Component也不能有重复的,因为Dagger无法判断你究竟想要那个作为依赖(也就是依赖迷失
强行弄多一个提供MemberB的方法

那么等待你的将会是无尽的编译错误
  • 无用的依赖会生成过时的代码


    强行多依赖一个MemberCModule

3.Component的依赖关系--Component

同样的,先看Component注解里的内容

@Retention(RUNTIME) // Allows runtimes to have specialized behavior interoperating with Dagger.
@Target(TYPE)
@Documented
public @interface Component {
  /** 包含的module模块 */
  Class<?>[] modules() default {};

  /** 依赖的其他component组件 */
  Class<?>[] dependencies() default {};

  /** 关于builder的注解,这里先不关注它 */
  @Target(TYPE)
  @Documented
  @interface Builder {}
}

可以看出Component不光能依赖Module,甚至还能依赖其他的组件,那么开始代码

class MemberA @Inject constructor()

/** 这里要让MemberB必须由其他组件提供,构造函数就不标注@Inject了 */
class MemberB constructor(val name: String)

class Target {

    @Inject
    lateinit var memberA: MemberA

    @Inject
    lateinit var memberB: MemberB
}

弄多一个组件SubComponent用来提供MemberB

@Module
class MemberBModule {
    @Provides
    fun provideMemberB(): MemberB = MemberB("memberB")
}

@Component(modules = arrayOf(MemberBModule::class))
interface SubComponent {
    // 这里不用injectXxx()方法了,因为这个组件是作为TargetComponent的依赖组件存在的
    // 定义这种返回MemberB类型的方法,其实就有点类似把Component当做Module用了,只不过不需要标注@Provides罢了
    fun provideMemberB(): MemberB
}

然后是TargetComponent

@Component(dependencies = arrayOf(SubComponent::class))
interface TargetComponent {
    fun inject(target: Target)
}

编译后,生成的DaggerTargetComponent



实际上就是按照依赖组件SubComponent中的方法生成的Provider<方法返回类型>(当然必须是SubComponent的依赖关系所能够提供的类型)

注入的代码:

val target = Target()
val subComponent = DaggerSubComponent.builder().build()
DaggerTargetComponent.builder().subComponent(subComponent).build().inject(target)

之前提过,依赖关系里只要能够提供足够的"材料",就可以完成注入,那么SubComponent里已经有了能够提供MemberB的MemberBModule了,是否可以不写那个fun provideMemberB(): MemberB呢?把它注释掉试试

@Component(modules = arrayOf(MemberBModule::class))
interface SubComponent {
    // fun provideMemberB(): MemberB
}

然而却并不可以

在这个例子中,TargetComponent并不能够拿到SubComponent里的MemberBModule,而且它本身的依赖关系中又无法或者不足以提供MemberB的Provider,所以就挂了

反过来说,就算TargetComponent里有别的module能够提供MemberB创建所依赖的元素,甚至是直接提供MemberB的方法,例如下面这个, 结果也是不能编译通过的

@Module
class MemberNameModule {
   
    @Provides
    fun provideMemberName(): String = "name from parent component"
   
    @Provides
    fun provideMemberB(): MemberB = MemberB(provideMemberName())
}

提示cannot be provided without an @Inject constructor or from an @Provides-annotated method.
或者是提示前面那种依赖迷失

这就表示依赖组件Component里面的依赖关系与组件是相互隔离的,或者说他们互是不可见的,这就好像两家公司合作生产一款产品一样,除非有约定,否则他们之间的供应商是不可能共同提供原材料生产的

依赖关系图

说到隔绝,前面提到Module里也是可以包含Component的,那么结果会是怎样呢,下篇再细说

4.总结:

本篇主要还是上篇的一点扩展,从Component依赖关系的角度,分为Module和Component两个维度:

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

推荐阅读更多精彩内容