Dagger2的使用

引入Dagger2

首先,我们需要将Dagger2的依赖写入我们的gradle中,具体配置如下

android {
    ...
}

dependencies {
    ...
    compile "com.google.dagger:dagger:2.8"
    annotationProcessor "com.google.dagger:dagger-compiler:2.8"
    provided 'javax.annotation:jsr250-api:1.0'
    compile 'javax.inject:javax.inject:1'
    ...
}

配置好之后就可以使用dagger2了。

注解

这里先讲讲四种基础的注解,他们分别是:

  • @Inject Inject主要有两个作用,一个是使用在构造函数上,通过标记构造函数让Dagger2来使用(Dagger2通过Inject标记可以在需要这个类实例的时候来找到这个构造函数并把相关实例new出来)从而提供依赖,另一个作用就是标记在需要依赖的变量让Dagger2为其提供依赖。
  • @Provides 用Provides来标注一个方法,该方法可以在需要提供依赖时被调用,从而把预先提供好的对象当做依赖给标注了@Injection的变量赋值。Provides主要用于标注Module里的方法
  • @Module 用Module标注的类是专门用来提供依赖的。有的人可能有些疑惑,看了上面的@Inject,需要在构造函数上标记才能提供依赖,那么如果我们需要提供的类构造函数无法修改怎么办,比如一些jar包里的类,我们无法修改源码。这时候就需要使用Module了。Module可以给不能修改源码的类提供依赖,当然,能用Inject标注的通过Module也可以提供依赖
  • @Component Component一般用来标注接口,被标注了Component的接口在编译时会产生相应的类的实例来作为提供依赖方和需要依赖方之间的桥梁,把相关依赖注入到其中。

example

我们想在activity中调用Car。下面是car类

public class Car {

    @Inject
    public Car() {
    }

    public String run() {
        return "car run ";
    }
}

给car的构造方法添加Inject注解,Dagger2通过Inject注解可以在需要Car这个类实例的时候来找到这个构造函数并把相关实例new出来。

接下来需要一个Component,代码如下:

@Component
public interface CarComponent {
    void inject(CarActivity activity);
}

添加完CarComponent类后,先build一下,会生成一个DaggerCarComponent的类。DaggerCarComponent是CarComponent的一个实现类。DaggerCarComponent的作用是把需要注入的对象注入到CarActivity里面。

然后在Activity里注入这个Car,代码如下:

@Inject
Car mCar;
private CarComponent mCarComponent;

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_car);
    mCarComponent = DaggerCarComponent.builder().build();
    mCarComponent.inject(this);
    TextView text = findViewById(R.id.text);
    text.setText(mCar.run());
}

运行代码,效果如下:

上面的例子只是用到了Inject和Component,下面介绍一下另外两个注解的用法。

假设Car这个类事第三方的类,而且我们没有办法修改这个类(就是不能在这个类的构造函数上加上@Inject的注解),这个时候就需要用到Provides和Module。先把Car的构造函数上的@Inject给去掉,

public class Car {

    public Car() {
    }

    public String run() {
        return "car run ";
    }
}

然后创建一个Module类,来提供Car的实例,代码如下:

@Module
public class CarModule {

    @Provides
    public Car provide(){
        return new Car();
    }
}

@Provides表明这个是一个提供实例的方法,Dagger2在实例化被注入的对象的时候,会先去找有没有被@Provides标记的提供对象实例的方法,如果没有就会去找有没有背@Inject标记的构造方法。

接下来把Module与Component关联起来,修改CarComponent,添加modules = CarModule.class,代码如下:

@Component(modules = CarModule.class)
public interface CarComponent {
    void inject(CarActivity activity);
}

这里再说明一个问题,我们有两种方式可以提供依赖,一个是注解了@Inject的构造方法,一个是在Module里提供的依赖,那么Dagger2是怎么选择依赖提供的呢,规则是这样的:

  • 步骤1:查找Module中是否存在创建该类的方法。
  • 步骤2:若存在创建类方法,查看该方法是否存在参数
  • 步骤2.1:若存在参数,则按从步骤1开始依次初始化每个参数
  • 步骤2.2:若不存在参数,则直接初始化该类实例,一次依赖注入到此结束
  • 步骤3:若不存在创建类方法,则查找Inject注解的构造函数,看构造函数是否存在参数
  • 步骤3.1:若存在参数,则从步骤1开始依次初始化每个参数
  • 步骤3.2:若不存在参数,则直接初始化该类实例,一次依赖注入到此结束

然后运行一下代码,效果和上一个一样。

下面介绍一个注入TextView的例子:

新建一个TextViewModule,代码如下:

@Module
public class TextViewModule {
    private Context mContext;

    public TextViewModule(Context context) {
        mContext = context;
    }

    @Provides
    public TextView provideTextView() {
        return new TextView(mContext);
    }
}

provideTextView用于提供TextView。然后把这个Module和Component关联起来。代码如下:

@Component(modules = {CarModule.class, TextViewModule.class})
public interface CarComponent {
    void inject(CarActivity activity);
}

在modules中再加一个TextViewModule.class就好。然后把TextView注入到CarActivity中,最后再把这个TextView添加到Activity的content view里面。代码如下:

public class CarActivity extends Activity {

    @Inject
    Car mCar;
    @Inject
    TextView mTextView;

    private CarComponent mCarComponent;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_car);
        mCarComponent = DaggerCarComponent.builder().textViewModule(new TextViewModule(this)).build();
        mCarComponent.inject(this);

        ViewGroup root = findViewById(android.R.id.content);
        root.addView(mTextView);
        mTextView.setText("added TextView");
        TextView text = findViewById(R.id.text);
        text.setText(mCar.run());
    }
}

这里要说一下textViewModule(new TextViewModule(this))这句代码,这里是给Component添加一个TextViewModule的实例,每当Component关联一个Module的时候,Component的实现类都会增加一个传入Module实例的方法,DaggerCarComponent中就会有如下两个方法。

public Builder carModule(CarModule carModule) {
  this.carModule = Preconditions.checkNotNull(carModule);
  return this;
}

public Builder textViewModule(TextViewModule textViewModule) {
  this.textViewModule = Preconditions.checkNotNull(textViewModule);
  return this;
}

那我们为啥不用掉carModule来传入一个CarModule对象呢?因为CarModule有一个无参数的构造方法,Dagger会默认去掉这个无参数的构造方法,而TextViewModule则没这种构造方法,这需要在用的时候调运textViewModule(new TextViewModule(this))。

下面来看一下运行效果:

代码地址

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

推荐阅读更多精彩内容

  • 这篇文章是对Dagger2使用的一个总结,参考了许多内容,会在下面把参考的资料列出来 什么是Dagger2 1.D...
    石器时代小古董阅读 1,240评论 4 9
  • 本篇的内容不涉及Dagger2的源码,只是为了更好的使用. 想进一步了解的话可以阅读以下文章:dagger2让你爱...
    李庆雪阅读 988评论 0 3
  • 部分内容参考自:[Android]使用Dagger 2依赖注入 - DI介绍(翻译)[Android]使用Dagg...
    AItsuki阅读 47,207评论 66 356
  • Dagger2 入门 2016-12-21 更新:添加@Subcomponent注解以及Lazy与Provider...
    fxzou阅读 28,523评论 77 331
  • 夜深了,可是我不想睡。 今天早晨五点多起来去爬山,和先生一起,约上三五好友,感觉真好。上山的过程挺辛苦的,毕竟很久...
    佩盈阅读 489评论 0 1