Dagger2 极速入门

Github地址

Dagger是一个快速的依赖注入框架,供Android和Java开发使用。以前由Square维护,现在转交给Google,Github链接为:https://github.com/google/dagger

依赖注入

Dagger为依赖注入而生。什么是依赖?什么是注入?为什么要使用依赖注入?这是我们学习Dagger之前必须了解的。依赖就是一个类中要使用其他的类来完成某些工作,这样一个类就依赖了另外一个类。比如在MainActivity中必须使用一个User类的对象,那么MainActivity就依赖了User类。

public class MainActivity extends AppCompatActivity {

    User mUser;//MainActivity依赖User类

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mUser = new User();//初始化mUser
        setContentView(R.layout.activity_main);
    }
}

一般我们直接在MainActivity中直接初始化mUser对象,但如果有天User类的构造方法中增加了一个参数,比如用户名,那么所有调用User的无参构造方法的地方全部要修改,这显然不是我们希望看到的。于是我们思考可不可以提供一个User的工厂类或者容器类专门负责User对象的创建,这样User对象的创建就不会跟MainActivity发生耦合,不管User的构造方法如何变,都不会影响到MainActivity。那么代码可能是这样:

public class MainActivity extends AppCompatActivity {

    User mUser;//MainActivity依赖User类

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mUser = UserFactory.getUser()//通过工厂类注入mUser
        setContentView(R.layout.activity_main);
    }
}

那么mUser对象就不是在MainActivity创建,而是由UserFactory创建,设置给mUser对象,这就可以称之为mUser被注入了,这样MainActivity就不需要关心User对象是怎样创建出来,对User对象创建的修改就不会影响到MainActivity里面的代码,这就是依赖注入的好处的。这就好比我们打针,人体依赖药液来治疗疾病,但药液并不是人体自己生产的,而是医药公司生产然后通过注射器注入到人体,而我们人体根本就无需关心药液是如何被制造出来的。

Dagger的作用就是通过注解的方式,帮我们自动生成创建对象的工厂类。

Dagger 2使用

1. 添加依赖

可通过链接https://github.com/google/dagger/releases查找最新版本

dependencies {
    compile 'com.google.dagger:dagger:2.11'
    annotationProcessor 'com.google.dagger:dagger-compiler:2.11'
}

2. 添加注解@Inject

分别在MainActivity的User成员变量和User的构造方法上添加@Inject依赖。

public class MainActivity extends AppCompatActivity {

    //成员变量上添加注解
    @Inject
    User mUser;
}


public class User {

    String name;

    //构造方法上添加注解
    @Inject
    public User() {
        this.name  = "Leon";
    }

}

3. 创建Component类

事实上完成第二步后,MainActivity中成员mUser并没有调用构造方法完成初始化,还需要一个类来完成注入,这就是Component类。
我们创建一个MainComponent接口,提供一个inject方法,其参数为将被注入的类MainActivity

public interface MainComponent {

    void inject(MainActivity activity);
}

然后,我们在Android Studio下选择菜单build->Make Project,这时候,会在app模块下build/generated/source/apt/debug/包名/目录下生成三个文件DaggerMainComponentMainActivity_MembersInjectorUser_Factory。DaggerMainComponent即为接口MainComponent的实现类。

4. 注入

最后,我们可以使用生成的DaggerMainComponnet完成注入,成员变量mUser将被赋值。如果是老司机,是不是会觉得这跟ButterKnife.bind(this)有异曲同工之妙呢?

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    //注入,内部会调用User的构造方法完成成员变量mUser的初始化
    DaggerMainComponent.builder().build().inject(this);
    //打印结果,mUser不为null
    Log.d(TAG, "onCreate: " + mUser.name);
}

Module使用

假如我想在一个Activity里面注入一个TextView,如下:

public class MainActivity extends AppCompatActivity {

    @Inject
    TextView mTextView;
}

如果按照上述步骤,就需要找到TextView的构造方法,加上一个@Inject注解,这个显然是无法做到的。Module就是为了解决不能够通过注解构造方法来创建一个实例的问题。我们创建一个TextViewMoudle类,使用@Module注解。另外需要提供一个方法返回一个TextView实例,并且用@Provides注解。

@Module
public class TextViewModule {

    @Provides
    TextView provideTextView(Context context) {
        return new TextView(context);
    }
}

provideTextView方法有个Context参数,需要外界传入到TextViewModule,这里给TextViewModule提供一个带有Context参数的构造方法。另外还需要提供个provideContext方法返回上下文,因为Dagger框架调用provideTextView方法获取一个TextView实例时,发现要传一个Context类型的参数,这时候他会查找被@Provides注解并且返回值为Context类型的方法获取一个Context实例传入provideTextView方法。

@Module
public class TextViewModule {
    //保存一个上下文成员变量
    private Context mContext;

    //构造方法接收一个上下文
    public TextViewModule(Context context) {
        this.mContext = context;
    }

    @Provides
    TextView provideTextView(Context context) {
        return new TextView(context);
    }

    
    @Provides
    Context provideContext() {
        return mContext;
    }
}

接下来还需要在MainComponent接口上指定TextViewModule。然后点击菜单选项build->Make Project,这时又会在build/generated/source/apt/debug/包名/目录下生成两个新文件TextViewModule_ProvideContextFactoryTextViewModule_ProvideTextViewFactory

@Component(modules = TextViewModule.class)
public interface MainComponent {

    void inject(MainActivity activity);
}

最后在注入时创建一个TextViewModule传入,表示告诉Dagger框架可以从TextViewModule中获取TextView实例。

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

推荐阅读更多精彩内容

  • Dagger2 转载请注明原作者,如果你觉得这篇文章对你有帮助或启发,可以关注打赏。 前言本文翻译自Google ...
    轻云时解被占用了阅读 6,677评论 4 31
  • 注:本文是小生自学时做(fanyi)的笔记,可能含有少儿不宜的误导性内容,学习Dagger请移步原博。原博地址:h...
    乌龟爱吃肉阅读 530评论 0 0
  • 文章翻译自Dagger官网,翻译水平有限,见谅。 引入 引用官网的引入说明,上面的部分都好理解,就是简单的comp...
    one_cup阅读 623评论 0 0
  • 将一个可迭代/遍历的对象组成一个索引序列,利用他可以同时获得索引与值 可以指定索引起始值
    cctse阅读 284评论 0 0
  • 在我前一篇文章Log4j2 简单使用中介绍了一些Log4j2的简单使用方法。下面来做一些进阶介绍。 使用属性 在复...
    乐百川阅读 5,799评论 0 4