Dagger2 使用教程(一)简单案例

一、不使用Dagger2

1、编写一个类:

public class Test3 {
    public Test3() {
    }
    public void sayHelloWorld(){
        Log.d("Test3","Hello World");
    }
}

2、在MainActivity中使用Test3这个类

public class MainActivity extends AppCompatActivity {
    Test3 test3;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        setContentView(R.layout.activity_main);
        test3 = new Test3();
    }
}

3、成功运行代码,可用看到控制台输出了日志信息:

2022-11-12 14:47:12.411  2973-2973  Test3                   com.example.dagger2application       D  Hello World

二、使用Dagger2

1、添加依赖
dependencies {
...代码省略...
//dagger2依赖
api 'com.google.dagger:dagger:2.44'
annotationProcessor 'com.google.dagger:dagger-compiler:2.44'
}

2、编写一个类,添加注解@Inject,使得Dagger2能找到它。

public class Test3 {
    //添加Dagger2注解
    @Inject
    public Test3() {
    }
    public void sayHelloWorld(){
        Log.d("Test3","Hello World");
    }
}

3、新增一个接口,添加@Singleton和@Component注解和inject方法。

//用这个标注标识是一个单例
@Singleton
//用这个标注标识是一个组件
@Component()
public interface MainActivityComponent {
    //这个组件要注入的对象。这个inject标注的意思是
    //后面的参数对象里面有被@Inject标注的属性,需要这个连接器来进行依赖注入。
    void inject(MainActivity activity);
}

4、在MainActivity中使用Test3这个类。

public class MainActivity extends AppCompatActivity {

    @Inject
    Test3 test3;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        //使用组件进行构造、注入
        DaggerMainActivityComponent.builder().build().inject(this);
        test3.sayHelloWorld();
    }
}

5、成功运行代码,可用看到控制台输出了日志信息:

2022-11-12 14:47:12.411  2973-2973  Test3                   com.example.dagger2application       D  Hello World

三、查看使用Dagger2新增了那些临时类

打开build/generated/ap_generaed_sources/debug/out/com/example/dagger2application目录:


image.png

可以发现该目录新增了三个类,分别是DaggerMainActivityComponent、MainActivity_MembersInjector和Test3_Factory,这三个类是Dagger2框架帮我们自动生成的。分别来看下这三个类的源码详情。

1、DaggerMainActivityComponent类的全部代码:

package com.example.dagger2application;

import dagger.internal.DaggerGenerated;

@DaggerGenerated
@SuppressWarnings({
    "unchecked",
    "rawtypes"
})
public final class DaggerMainActivityComponent {
  private DaggerMainActivityComponent() {
  }

  public static Builder builder() {
    return new Builder();
  }

  public static MainActivityComponent create() {
    return new Builder().build();
  }

  public static final class Builder {
    private Builder() {
    }

    public MainActivityComponent build() {
      return new MainActivityComponentImpl();
    }
  }

  private static final class MainActivityComponentImpl implements MainActivityComponent {
    private final MainActivityComponentImpl mainActivityComponentImpl = this;

    private MainActivityComponentImpl() {


    }

    @Override
    public void inject(MainActivity activity) {
      injectMainActivity(activity);
    }

    private MainActivity injectMainActivity(MainActivity instance) {
      MainActivity_MembersInjector.injectTest3(instance, new Test3());
      return instance;
    }
  }
}

2、MainActivity_MembersInjector 类的全部代码:

package com.example.dagger2application;

import dagger.MembersInjector;
import dagger.internal.DaggerGenerated;
import dagger.internal.InjectedFieldSignature;
import dagger.internal.QualifierMetadata;
import javax.inject.Provider;

@QualifierMetadata
@DaggerGenerated
@SuppressWarnings({
    "unchecked",
    "rawtypes"
})
public final class MainActivity_MembersInjector implements MembersInjector<MainActivity> {
  private final Provider<Test3> test3Provider;

  public MainActivity_MembersInjector(Provider<Test3> test3Provider) {
    this.test3Provider = test3Provider;
  }

  public static MembersInjector<MainActivity> create(Provider<Test3> test3Provider) {
    return new MainActivity_MembersInjector(test3Provider);
  }

  @Override
  public void injectMembers(MainActivity instance) {
    injectTest3(instance, test3Provider.get());
  }

  @InjectedFieldSignature("com.example.dagger2application.MainActivity.test3")
  public static void injectTest3(MainActivity instance, Test3 test3) {
    instance.test3 = test3;
  }
}

3、Test3_Factory类的全部代码:

// Generated by Dagger (https://dagger.dev).
package com.example.dagger2application;

import dagger.internal.DaggerGenerated;
import dagger.internal.Factory;
import dagger.internal.QualifierMetadata;
import dagger.internal.ScopeMetadata;

@ScopeMetadata
@QualifierMetadata
@DaggerGenerated
@SuppressWarnings({
    "unchecked",
    "rawtypes"
})
public final class Test3_Factory implements Factory<Test3> {
  @Override
  public Test3 get() {
    return newInstance();
  }

  public static Test3_Factory create() {
    return InstanceHolder.INSTANCE;
  }

  public static Test3 newInstance() {
    return new Test3();
  }

  private static final class InstanceHolder {
    private static final Test3_Factory INSTANCE = new Test3_Factory();
  }
}

四、总结

1、结合Dagger2框架新增的三个类我们可以发现,在MainActivity的onCreate方法中,Dagger2框架实现依赖注入的流程如下所示:

image.png

2、MainActivity的onCreate方法关键代码:

public class MainActivity extends AppCompatActivity {
    ...代码省略...
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        ...代码省略...
        DaggerMainActivityComponent.builder().build().inject(this);
    }
}

3、DaggerMainActivityComponent的builder方法关键代码:

public final class DaggerMainActivityComponent {
  public static Builder builder() {
    return new Builder();
  }
}

4、DaggerMainActivityComponent_Builder的builder方法关键代码:

public final class DaggerMainActivityComponent {
  public static final class Builder {
    ...代码省略...
    public MainActivityComponent build() {
      return new MainActivityComponentImpl();
    }
  }
}

5、MainActivityComponentImpl的inject方法会进一步调用injectMainActivity方法:

  private static final class MainActivityComponentImpl implements MainActivityComponent {
    ...代码省略...
    @Override
    public void inject(MainActivity activity) {
      injectMainActivity(activity);
    }

    private MainActivity injectMainActivity(MainActivity instance) {
      MainActivity_MembersInjector.injectTest3(instance, new Test3());
      return instance;
    }
  }

6、MainActivity_MembersInjector的injectTest3方法如下所示

public final class MainActivity_MembersInjector implements MembersInjector<MainActivity> {
  ...代码省略...
  @InjectedFieldSignature("com.example.dagger2application.MainActivity.test3")
  public static void injectTest3(MainActivity instance, Test3 test3) {
    instance.test3 = test3;
  }
}

经过上面代码的调用流程分析,基本可以明白Daggger2是如何实现依赖注入的原理了。

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

推荐阅读更多精彩内容