Dagger2 源码简析

Dagger2是首个使用生成代码实现完整依赖注入的框架,极大减少了使用者的编码负担。
我们去看看Dagger2 是如何为我们注入对象的。

假设我们需要在MainActivity中注入对象DataManager:

public class MainActivity extends AppCompatActivity {

    @Inject
    DataManager dataManager;

}

使用@Inject标志被注入的对象dataManager(注意dataManager不能为private)

Dagger2中,负责提供依赖的组件被称为Module。
创建Module类,如下:

@Module
public class AppModule {


    /**
     * 带@Provides 注解 ,说明该方法是提供依赖
     * @return
     */
    @Provides
    public DataManager provideManager() {
        return new DataManager();
    }

}

使用@Module注解来标识类型为module,并用@Provides标识提供依赖的方法。

Dagger2中,我们需要Component 来连接 Module 和 @Inject 来完成对象的注入:
创建 Component接口:


@Component(modules = {AppModule.class})
@Singleton
public interface AppComponent {

    void inject(MainActivity activity);
}

使用@Component注解来标识类型为Component,参数modules 可以依赖多个module。
接口中的inject方法需要该注入对象所在的类作为参数。注意:这里必须是注入对象所在的类MainActivity,而不可以写成其父类。

编译。

Dagger2 会生成一些辅助类。

带@Component注解 :生成 Dagger_(带@Component注解接口名称)。这里是AppComponent。因此会生成 Dagger_AppComponent;

带@Module 注解 :生成 (带@Mudule类名)_(带@Provides注解的方法名)Factory。这里是 AppModule_ProvideManagerFactory

带@Inject 注解:生成 (需要注入对象所在的类名)_MembersInjector。
这里是MainActivity_MembersInjector。

类图:

03.png

在MainActivity中会调用以下代码:


 DaggerAppComponent
                .builder()
                .appModule(new AppModule())
                .build()
                .inject(this);

去看看DaggerAppComponent源码:

05.png
  1. 调用build方法创建出DaggerAppComponent实例。
  2. 在创建DaggerAppComponent实例时,调用了initialize(builder),创建AppModule_ProvideManagerFactory 和MainActivity_MembersInjector 实例,调用了相对应create的方法。

MainActivity_MembersInjector 源码:

06.png
  1. 调用create的方法创建实例时 传入了 AppModule_ProvideManagerFactory 作为参数。

  2. 但 .inject(this)方法时,调用了injectMembers方法,看到这个方法,可以知道为什么datamanage 不能为private和为什么调用inject方法传参数时不能写父类了。

  3. dataManage 实例的创建调用了AppModule_ProvideManagerFactory的get方法。

看看AppModule_ProvideManagerFactory的源码:

04.png

可以看到,get方法其实调用了AppModule 的provideManager方法,而这个方法new DataManager();完成对象的注入。

这就是Dagger2 为我们注入对象处理的流程。

我们在MainActivity 再注入一个对象Person,看看Dagger2 生成了怎么样的辅助类。

修改如下:
MainActivity :


public class MainActivity extends AppCompatActivity {

    @Inject
    DataManager dataManager;

    @Inject
    Person person;
}

修改AppModule:


@Module
public class AppModule {


    /**
     * 带@Provides 注解 ,说明该方法是提供依赖
     * @return
     */
    @Provides
    public DataManager provideManager() {
        return new DataManager();
    }


    @Provides
    public Person providePerson(){
        return new Person();
    }


}

类图:

08.png

如果是多层依赖 又会生成什么辅助类?

添加 UserModule :


@Module
public class UserModule {


    @Provides
    public User provideUser(){
        return new User();
    }
}

修改AppComponent


@Component(modules = {AppModule.class,UserModule.class})
@Singleton
public interface AppComponent {

    void inject(MainActivity activity);
}

修改MainActivity


public class MainActivity extends AppCompatActivity {


    @Inject
    DataManager dataManager;


    @Inject
    Person person;


    @Inject
    User user;

}

类图:

09.png

可以看出

  1. Component 只是 Module 和 Inject 中间的桥梁
  2. Module 相当于简单工厂,提供了各种依赖

辅助类的生成规则:

带@Component注解 :生成 Dagger_(带@Component注解接口名称)。这里是AppComponent。因此会生成 Dagger_AppComponent;

带@Module 注解 :生成 (带@Mudule类名)_(带@Provides注解的方法名)Factory。这里是 AppModule_ProvideManagerFactory

带@Inject 注解:生成 (需要注入对象所在的类名)_MembersInjector。
这里是MainActivity_MembersInjector。

END。

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

推荐阅读更多精彩内容