Dagger2 @Inject @Provide @Module @Component简单使用

本文适合于Dagger2 零基础学习。本次阅读需要五分钟。

Dagger2 主要提供了6种注解,这里我主要讲其中的四种
@Inject @Provide @Module @Component

Dagger2是通过依赖注入完成类的初始化。

**这个过程需要三部分:
依赖提供方,依赖注入容器,依赖需求方
**

  1. @Inject Inject主要有两个作用
    1.作为依赖注提供方使用:在构造函数上,通过标记构造函数让Dagger2来使用(Dagger2通过Inject标记可以在需要这个类实例的时候来找到这个构造函数并把相关实例new出来)从而提供依赖
    2.作为依赖需求方:标记在需要依赖的变量Dagger2会帮助初始化,被我们使用。

  2. @Provide 用Provide来标注一个方法,该方法可以在需要提供依赖时被调用,从而把预先提供好的对象当做依赖给标注了@Inject的变量赋值。provide主要用于标注Module里的方法

  3. @Module 用Module标注的类是专门用来提供依赖的。注意Module类是提供依赖的一个集合,通常它自身是需要被依赖的。而真正被依赖的都是通过@Provide标注的方法提供,所以@Module和@Provide是联合使用的。

  4. @Component Component一般用来标注接口,被标注了Component的接口在编译时会产生相应的类的实例来作为提供依赖方和需要依赖方之间的桥梁,把相关依赖注入到其中。


    图片来自于[Maydaaa](https://dreamerhome.github.io/2016/07/11/dagger%20for%20code/)

**对上述内容请记住依赖注入过程需要三部分:
依赖提供方,依赖注入容器,依赖需求方
**
对上述描述不清楚的,请先看下面的案例,再去理解上面的内容。

案例

常规做法
我们要在TestUser 中创建一个User

public class User {
    String userName;
    int age;
}

如果我们想使用User 我们需要new出来然后使用

 public class TestUser {
    User user;
    public static void main(String[] arg) {
        TestUser testUser = new TestUser();
        testUser.user = new User();
        testUser.user.userName = "name";
    }
}

在上述例子中我们如果希望使用User我们需要new一个User然后才能使用

下面我们通过Dragger2去完成上述过程

  • 依赖注入方
    通过@Inject和@Module&&@Provide可以去完成依赖注入方
    先讲@Module&&@Provide
    我们在TestUser 中想使用User那么我们需要一个Model我们的@Model是用在类上的。
    我们创建了一个@Module TestUserModule

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

我们通过上述代码就完成的依赖注入方。这里解释一下@Module是一个依赖提供方的合集,本身一般是不作为内容被提供的。User才是我们需要提供的内容
比如我们现在希望TestUserModule 同时提供一个Account
@Module
public class TestUserModule {
@Provides
User provideUser(){
return new User();
}
@Provides
Account provideAccount(){
return new Account();
}
}

  • 依赖注入容器
    依赖注入容器只是一个接口,用来描述被注入的对象TestUser 需要哪些modules = TestUserModule.class
    @Component(modules = TestUserModule.class)
    public interface TestUserComponent {
    void inject(TestUser testUser);
    }
    注入容器本身只是一个接口interface
  • 依赖需求方
    public class TestUser {
    @Inject
    User user;
    public static void main(String[] arg) {
    TestUser testUser = new TestUser();
    DaggerTestUserComponent.builder().build().inject(testUser);
    System.out.println(testUser.user.name);
    }
    }
    我们要打印出name System.out.println(testUser.user.name);
    在使用User前要做两件事情
  1. DaggerTestUserComponent.builder().build().inject(testUser);
    DaggerTestUserComponent是在编译后编译器帮我们生成的。生成的格式是Dagger+我们自定义的容器
  2. @Inject
    User user;
    通过我们刚刚的DaggerTestUserComponent.builder().build().inject(testUser);Dagger2会帮我们把user初始化。

注意事项
@Module
Dagger2是怎么选择依赖提供的呢,规则是这样的:

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

推荐阅读更多精彩内容

  • 部分内容参考自:[Android]使用Dagger 2依赖注入 - DI介绍(翻译)[Android]使用Dagg...
    AItsuki阅读 46,849评论 65 356
  • 本文的分析基于dagger2的2.7版本。 谷歌开发维护的Dagger2出来有很长时间了,目前在很多开源项目上也能...
    sososeen09阅读 13,549评论 31 108
  • 几个问题 看到Dagger2这个词的时候,相信很多人会有很多的疑问如下:Dagger2如何使用在例子中?Injec...
    codeHoward阅读 6,939评论 4 10
  • 文/夫子闲云 雾锁青山雨浸夜,虫蛙无声鸟停歇。 林间自在忘金笼,恰如曹公思乔色。 天若伤身雷如烈,亭间鱼戏藕摇曳。...
    夫子闲云孙宁富阅读 168评论 0 0
  • 「 那大概不是爱情。 那大概不是友情。 那大概也不是亲情。 那是一种超越这一切的感情。 那一年,是他来到这个世界之...
    想说_H阅读 196评论 0 0