Dagger依赖注入详解(二)

系列文章第一篇:
http://www.jianshu.com/p/33b739bd721a

  1. 概述
    上一期我们已经对Dagger的基本概念以及结构做了介绍。那么现在我们将对Dagger作深入探究,了解它究竟是怎么实现自动注入的,它在我们引用注解后做了哪些工作。

  2. 探究
    2.1 思路
    在古代,人们选择靠近水源的地点作为聚居地,很大一部分原因是我们需要水来灌溉庄稼。我们可以把步骤大概简化为:水源(提供水)——水车(获取水)——导管(引流)——农田。其实Dagger注入也是遵循这个过程,下面我们按照这个思路对dagger进行剖析。
    上篇我们说过,Module是专门提供依赖的,可以看作水源;Component是注入器,我们可以把它看成水车;Inject是被注入的对象,是农田和庄稼。
    2.2 Module
    在探究Module之前我们首先了解一下Module类的写法:

@Module
public class ApplicationModule {

    private final AndroidApplication mApplication;
    private final DaoSession mDaoSession;
    private final RxBus mRxBus;

    public ApplicationModule(AndroidApplication application, DaoSession daoSession, RxBus rxBus) {
        mApplication = application;
        mDaoSession = daoSession;
        mRxBus = rxBus;
    }

    @Provides
    @Singleton
    Context provideApplicationContext() {
        return mApplication.getApplication();
    }

    @Provides
    @Singleton
    RxBus provideRxBus() {
        return mRxBus;
    }

    @Provides
    @Singleton
    DaoSession provideDaoSession() {
        return mDaoSession;
    }
}

@Providers表示此处会提供依赖,而@Singleton表示提供的依赖对象将是单例形式。
好的,我们现在已经有了依赖提供者,就相当于有了一个农民伯伯为庄稼找到了水源,现在我们需要想办法将水源导出来,注入到种庄稼的田地里,也就是我们需要有一个踩水车,而我们的Component则是负责踩水车这个角色。
2.3 Component
首先我们看下Component类

@Singleton
@Component(modules = ApplicationModule.class)
public interface ApplicationComponent {
    Context getContext();
    RxBus getRxBus();
    DaoSession getDaoSession();
}

我们这里定义的是ApplicationComponent,我们在自己的Application类中实例化:

public App extends Applicaion{
      private static ApplicationComponent sAppComponent;
    ...//省略
      @Override
      public void onCreate() {
          super.onCreate();
          initConfig();
      }
     ...//省略
      private void initInjector() {
          sAppComponent = DaggerApplicationComponent.builder()
                  .applicationModule(new ApplicationModule(this, mDaoSession, mRxBus))
                  .build();
      }
     ...//省略
}

这里Dagger会根据相应的注解自动使用apt在/app/build/generated/apt/debug/中生成对应的DaggerApplicationComponent类。我们观察一下该类,也就是看下水车的结构。

public final class DaggerApplicationComponent implements ApplicationComponent {
  private Provider<Context> provideApplicationContextProvider;

  private Provider<RxBus> provideRxBusProvider;

  private Provider<DaoSession> provideDaoSessionProvider;

  private DaggerApplicationComponent(Builder builder) {
    assert builder != null;
    initialize(builder);
  }

  public static Builder builder() {
    return new Builder();
  }

  @SuppressWarnings("unchecked")
  private void initialize(final Builder builder) {

    this.provideApplicationContextProvider =
        DoubleCheck.provider(
            ApplicationModule_ProvideApplicationContextFactory.create(builder.applicationModule));

    this.provideRxBusProvider =
        DoubleCheck.provider(
            ApplicationModule_ProvideRxBusFactory.create(builder.applicationModule));

    this.provideDaoSessionProvider =
        DoubleCheck.provider(
            ApplicationModule_ProvideDaoSessionFactory.create(builder.applicationModule));
  }

  @Override
  public Context getContext() {
    return provideApplicationContextProvider.get();
  }

  @Override
  public RxBus getRxBus() {
    return provideRxBusProvider.get();
  }

  @Override
  public DaoSession getDaoSession() {
    return provideDaoSessionProvider.get();
  }

  public static final class Builder {
    private ApplicationModule applicationModule;

    private Builder() {}

    public ApplicationComponent build() {
      if (applicationModule == null) {
        throw new IllegalStateException(
            ApplicationModule.class.getCanonicalName() + " must be set");
      }
      return new DaggerApplicationComponent(this);
    }

    public Builder applicationModule(ApplicationModule applicationModule) {
      this.applicationModule = Preconditions.checkNotNull(applicationModule);
      return this;
    }
  }
}

代码不多,但是比较混杂,我们慢慢撸:
我们观察到Dagger使用在生成相应的DaggerApplicationComponent 类时采用了建造者模式,其构造方法私有意味着并不能直接new出来,而是需要通过建造者类Builder。而Builder类是DaggerApplicationComponent 中的公共静态内部类,其构造方法中会传入ApplicationModule 并持有它。
那么这样就清楚了,首先我们通过建造者类将ApplicationModule 传入并持有引用,其次将建造者类作为DaggerApplicationComponent 构造方法的参数传入DaggerApplicationComponent 类中,这样DaggerApplicationComponent 就持有了ApplicationModule ,也就是持有了依赖提供者。这时候我们可以理解为我们成功建造了水车,并且接入了水源。
现在我们仔细分析一下DaggerApplicationComponent 类。
首先Dagger获取被@Providers注解的方法的返回值,使用Provider结构包裹返回值,生成相应的Provider的私有字段,然后在initialize方法中,拿到建造者类Builder中持有的applicationModule。
于此同时在/app/build/generated/apt/debug/生成被@Providers注解方法的返回值的对应的工厂类,例如ApplicationModule_ProvideApplicationContextFactory。
我们顺着工厂类看下去:

public final class ApplicationModule_ProvideApplicationContextFactory implements Factory<Context> {
  private final ApplicationModule module;

  public ApplicationModule_ProvideApplicationContextFactory(ApplicationModule module) {
    assert module != null;
    this.module = module;
  }

  @Override
  public Context get() {
    return Preconditions.checkNotNull(
        module.provideApplicationContext(),
        "Cannot return null from a non-@Nullable @Provides method");
  }

  public static Factory<Context> create(ApplicationModule module) {
    return new ApplicationModule_ProvideApplicationContextFactory(module);
  }
}

我们看到工厂类实现了Factory<T>接口,其实在深入一层的话,我们会发现Factory是继承自Provider接口的,所以Factory实际上也是提供者,使用Factory的原因在于利于更好的拓展性。在Factory中传入相应的module,并在get方法中拿取到被@Provider注解的方法返回的具体的对象(详见:module.provideApplicationContext())。
我们继续返回上层的DaggerApplicationComponent 的initialize方法。我们发现从工厂类中获取的对象直接就赋值给了相应的Provider字段。
至此,DaggerApplicationComponent 实现了获取ApplicationModule中被@Provider注解的相应方法的返回对象并使用Provider持有该对象DaggerApplicationComponent 重写ApplicationComponent 的方法中直接从Provider字段中get相应的对象就行。就相当于我们的水车已经顺利的水源取水了。

3.总结
总而言之,Dagger根据@Provider直接生成相应的工厂类和DaggerApplicationComponent 类,DaggerApplicationComponent 类持有Module和相应的工厂类字段,实现了从水源取水这一过程。
第二篇比较枯燥,全是代码的解读和分析。下一篇我们将关注@Inject是怎样实现注入的。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,830评论 25 707
  • 你走在深夜里, 在昏黄的路灯下, 遥远的星和月在污浊的天空里, 更加遥远。 偶尔吹起的晚风, 让不安分的浮尘在灯光...
    简客子阅读 197评论 0 0
  • 上海的今天是风雨交加的,再不写点东西我觉得自己已经综述能力越来略差了 好想记录下生活的点点滴滴,好想记录下自己那一...
    向往温暖阅读 411评论 1 2
  • 今天看了喜欢的电影《Begin Again》,中途竟然两次哽咽~ 当第一个镜头里,凯拉.奈特莉忧郁的眼神出现时,我...
    这天气很晴朗阅读 219评论 0 1