依赖注入框架dagger2学习笔记

  1. 基本介绍

dagger2 是一款基于Java注解来实现的完全在编译阶段完成依赖注入的开源库,主要用于模块间解耦、提高代码的健壮性和可维护性。

1.1 在android中如何使用

使用Gradle 引用dagger2依赖库就可以

// Add Dagger dependenciesdependencies 
{
 compile 'com.google.dagger:dagger:2.x' 
annotationProcessor 'com.google.dagger:dagger-compiler:2.x'
}

2. 学习中的几个疑惑

2.1 dagger2中的Inject,Component,Module,Provides等等都是什么东东,有什么作用?

Dagger2 通过注解来生成代码,定义不同的角色,主要的注解如下:
@Module: Module类里面的方法专门提供依赖,所以我们定义一个类,用@Module注解,这样Dagger在构造类的实例的时候,就知道从哪里去找到需要的依赖。
**@Provides: **在Module中,我们定义的方法是用这个注解,以此来告诉Dagger我们想要构造对象并提供这些依赖。
**@Inject: **通常在需要依赖的地方使用这个注解。换句话说,你用它告诉Dagger这个类或者字段需要依赖注入。这样,Dagger就会构造一个这个类的实例并满足他们的依赖。
**@Component: **Component从根本上来说就是一个注入器,也可以说是@Inject和@Module的桥梁,它的主要作用就是连接这两个部分。将Module中产生的依赖对象自动注入到需要依赖实例的Container中。
@Scope: Dagger2可以通过自定义注解限定注解作用域,来管理每个对象实例的生命周期。
**@Qualifier: **当类的类型不足以鉴别一个依赖的时候,我们就可以使用这个注解标示。例如:在Android中,我们会需要不同类型的context,所以我们就可以定义 qualifier注解“@perApp”和“@perActivity”,这样当注入一个context的时候,我们就可以告诉 Dagger我们想要哪种类型的context。

2.2 dagger2到底能带来哪些好处?

最大的好处就是模块间解耦

下面举个简单的例子:
如果在 Class A 中,有 Class B 的实例,则称 Class A 对 Class B 有一个依赖。如果不用Dagger2的情况下我们应该这么写:

 public class A {
  ... 
 B b;
  ... 
 public A() {
    b = new B(); 
 }
}

上面例子面临着一个问题,一旦某一天B的创建方式(如构造参数)发生改变,那么你不但需要修改A中创建B的代码,还要修改其他所有地方创建B的代码。
有了dagger2 后,代码风格变成这样了

public class A{
    @InjectB b;
}

2.3 怎样把dagger2应用到具体项目中?

3. dagger2 demo代码

3.1 初始化User对象

这个很简单, 就是创建一个普通的class

public class User {
    private String name;
    private int age;
    public User(String name ,int age){
        this.name = name;
        this.age = age;
    }

    @Override
    public String toString() {
        return "user:" + name + ",age:" + age;
    }
}

3.2 生成UserModule 对象

/**
 *
 * module类就是给user初始化并且提供外部调用的类,这里类中我们需要给user初始,并且返回给dagger一个可调用的对象
 * @Module  真正提供依赖的类,以表明该类是Module类,这样Dagger2才能识别 ,Dagger在构造类的实例的时候,就知道从哪里去找到需要的依赖。
 * @Provides 就是写在Module中某些方法上,表示这个方法提供依赖
 *
 */
@Module
public class UserModule {
    @Provides
    User providerUser(){
        return new User("卡卡",20);
    }
}

3.3 生成Component对象

/**
 * 有了提供依赖的组件(module),我们还需要将依赖注入到需要的对象中。连接提供依赖和消费依赖对象的组件被称为Injector。Dagger2中我们将这个对象其称为component。
 *
 * @Component  也可以说是@Inject和@Module的桥梁,它的主要作用就是连接这两个部分 , 将Module中产生的依赖对象自动注入到需要依赖实例的Container中。
 */
@Component(modules = UserModule.class)
public interface UserComponent {
    /**
     * 这里必须是真正消耗依赖的类型MainActivity,而不可以写成其父类,比如Activity。
     *
     * 因为Dagger2在编译时生成依赖注入的代码,会到inject方法的参数类型中寻找可以注入的对象
     * @param activity
     */
    void inject(MainActivity activity);

}

3.4 完成依赖注入

public class MainActivity extends AppCompatActivity {

    /**
     * 使用@Inject标志被注入的对象User (注意User 不能为private)
     *
     * 换句话说,你用它告诉Dagger这个类或者字段需要依赖注入 ,这样,Dagger就会构造一个这个类的实例并满足他们的依赖
     */
    @Inject
    User user;// 不能是private

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        TextView tv = (TextView) findViewById(R.id.user);

        UserComponent component = DaggerUserComponent.builder().userModule(new UserModule()).build();
        component.inject(this);

        tv.setText(user.toString());
    }
}

注意:
这里的DaggerUserComponent不是我们自己创建的,是dagger自动在build时(可手动make project)创建的,后边的userModule也是更具你在Component设置的module对象生成的方法-如果不成功需先clean工程,再make project 一遍

4、小结

这两天在网上看了不少有关dagger2的文章,现在虽然对它有了初步的认识,但是还有很多疑惑。
一个是还没有领悟到这个框架的独到之处,虽然它能起到一定解耦的效果,但是现在是感觉有点繁琐。
还有一点就是,在实际项目中怎么用?现在还是一头雾水、无从下手。

参考文档

1、官方文档
2、dagger2 — 基础篇
3、daager2 — 初认识一
4、dagger2详解 — 从代码分析其原理
5、github 地址

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

推荐阅读更多精彩内容