初学者dagger2简明教程

本文更新于2017年11月15日
阅读本文大概需要三分半。

前言

dagger出来已经很长时间了，技术的更新日新月异。现在网上关于dagger2的搜索记录大部分还是16年及以前的。想着应该出一篇文章对一些好博客的精神做个总结，再就是更新。让现在要使用dagger2的朋友更简单的就能操作dagger2并理解它。

如果您对dagger2的概念，整个依赖注入框架还不清楚，可以先了解下系列文章：
Android：dagger2让你爱不释手-基础依赖注入框架篇
Android：dagger2让你爱不释手-重点概念讲解、融合篇
Android：dagger2让你爱不释手-终结篇
这三篇系列文章是全网知识点讲解的几乎最易懂明了的文章。

可以先看理论，再读本文实践印证。或者先读本文实践得到预期结果，再补系列理论。

文章的最后，提供了demo源码。 （不知道有没有读者看文章和我一样，不管什么长篇大论，先滑到最底，看文章多长，有没有提供demo。没有的话，扫几眼，如果写的不好更要关掉去看别的文章）

目录

正文内容分为以下三个部分：

• dagger框架出处及现在版本

• 从零开始按部就班配置及使用dagger2并过程内讲解主要知识点

• 梳理思路，概括性讲述注入流程

尽量废话少说，简明扼要

Now,start!!!

dagger框架出处及现在版本

Dagger2是Dagger的升级版，是一个依赖注入框架，现在由Google接手维护。截止写文目前，已经发布2.13版本。dagger2框架源码地址

从零开始按部就班配置及使用dagger2并过程内讲解主要知识点

• 添加依赖，只在module的gradle文件里导入即可，不再需要apt

compile 'com.google.dagger:dagger:2.13'
annotationProcessor 'com.google.dagger:dagger-compiler:2.13'

---

举个例子:

内容是通过向MainActivity注入一个Presenter，然后通过Presenter来设置TextView显示内容为user实体对象的属性name

其中User实体类的代码如下：

public class User {
    public String name;

    public User(String name) {
      this.name = name;
    }
}

MainPresenter的代码：

public class MainPresenter {
  MainActivity activity;
  User user;

  public MainPresenter(MainActivity activity, User user) {
    this.user = user;
    this.activity = activity;
  }

  public void showUserName() {
      activity.showUserName(user.name);
  }
}

都比较简单。

我们按编程操作思路来使用dagger，分为五步

• 首先我们在MainActivity里注入(Inject) MainPresenter （第一步）

   public class MainActivity extends AppCompatActivity {
     @Inject
     MainPresenter mainPresenter;
     ...
  
      @Override
      protected void onCreate(Bundle savedInstanceState) {
        ...
      }
  } 
  

---

注入之后呢，MainActivity会持有MainPresenter 的引用。MainPresenter被依赖，那么肯定会有new的过程，MainPresenter的构造方法有参数，怎么传参？谁传过去？这时，Module这个使者就出现了。

• 编写module，为注入时的实例化提供所需的参数 （第二步）

  @Module
  public class MainModule {
  
    private MainActivity mainActivity;
  
    public MainModule(MainActivity activity){ mainActivity = activity;}
  
    @Provides
    public MainActivity providesActivity(){ return mainActivity; }
  
    @Provides
    public User providesUser(){return new User("the user from MainModule"); }
  
    @Provides
    public MainPresenter providesMainPresenter(MainActivity activity,User user){
      return new MainPresenter(activity,user); 
    }
  }
  

首先我们需要明确一点，就是

Module的作用是用来提供生成依赖对象的

比如我要注入MainPresenter，那么这个Module的作用就是需要生成一个MainPresenter的对象，来让Dagger2注入到MainActivity中。

所以我们这里需要编写一个函数providesMainPresenter,这个函数可以从上面的代码看出，我们需要对这个函数使用@Provides注解，然后，我们这里需要传入两个参数，一个MainActivity引用，一个User对象。那么，这两个参数从何而来呢?

细心的同学可能会发现，我上面的代码中还定义了两个函数，分别为providesUser和providesActivity，没错，这里providesMainPresenter的两个参数就是通过这两个函数来获取的。如果没有声明这两个函数的话，编译期间会报错。

attention:

类必须用@Module标注

用@Provides注解的函数需要以provides开头，然后后面接什么内容都可以，看自己喜欢，事实上，经过我的测试，我把providesActivity()改成providesA()同样是可以注入成功的。

因为，这里是根据 返回值类型 来标识的，方法名并不重要，只需要保证以provides开头即可。

---

前面说，@Inject 做的是将依赖对象注入到目标中，@Module 提供依赖对象。它们两个之间的联系谁来搭建呢? Component就出现了。

• 编写Component，搭建@Inject和@Module的桥梁 （第三步）

  @Component(modules = MainModule.class)
  public interface MainComponent {
    void inject(MainActivity activity);//参数要写成对应的activity，不能错
  }
  

说明：

· Component要用@Component注解来标识，并通过(modules = xxx.class)绑定对应module

· 声明一个inject方法，之后在MainActivity会用到。（因为Component还需要建立与@Inject的联系）

· Component的作用就是搭建@Inject和@Module的桥梁，从@Module中获取依赖并将依赖注入给@Inject。

所以,mdules= xxx.class的xxx和inject方法的参数是我们每次对不同的activity建立不同的component要更改的代码。

• 接下来，需要编译。AndroidStudio -> Build -> Make Project （第四步）

编译后，MainComponent生成一个DaggerMainComponent类，这个类就是我们最后一步在MainActivity里要画上句点 用到的。

• 在对应Activity的onCreate方法里编写build代码，完成注入。（最后）

  public class MainActivity extends AppCompatActivity {
  
    @Inject
    MainPresenter mainPresenter;
  
    @Override
    protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      ...
      //build代码开始
      DaggerMainComponent.builder()
            .mainModule(new MainModule(this))//DaggerMainComponent与MainActivityModule的实例绑定
                                            //mainModule该方法名和MainModule是有关的，编译时生成
            .build()
            .inject(this);//该方法就是MainComponent接口的inject(),传入当前MainActivity的引用
      //build代码结束
      ...
    
      mainPresenter.showUserName();
    }
  

  }

MainComponent指定的module是MainModule，DaggerMainComponent就会有一个名为mainModule的方法，我们需要调用它，并传入参数，这里我们直接new了一个MainModule进去。

---

到这里代码就全部结束了。上面的代码运行起来的结果就是在MainActivity的TextView中显示了一串字符串"user form MainModule",虽然例子简单，但是基本上实现了简单依赖注入，希望对于Dagger2的入门有点启发。

---

梳理思路，概括性讲述注入流程

上面是按照编程的顺序书写的，最后我们按依赖注入的流程梳理下思路。

• 创建Component(桥梁)，并调用注入方法。

  // 构造桥梁对象
  MainComponent component = DaggerMainComponent.builder().mainModule(new MainModule()).build();
  
  //注入
  component.inject(this);
  

• Dagger框架查找当前类中带有@Inject的成员变量。

  @Inject   //标明需要注入的对象
  MainPresenter MainPresenter;
  

• 根据成员变量的类型从Module中查找哪个有@Provides注解的方法返回值为当前类型。

  @Provides // 关键字，标明该方法提供依赖对象
  MainPresenter providesMainPresenter(){
    //提供MainPresenter对象
    return new MainPresenter();
  }
  

---

最后的最后，回答个很多网友的疑问：

Q: 如果被依赖的类构造函数需要多传一个参数，那每个注入的类中，不都得改变吗?

A: Dagger会自己找到需要的新的依赖，Module 在创建的时候应该要求最低限度的参数，比如当前Context，而不是传入所有需要的参数，不然的话 Dagger系统就没有意义了，我们还是手动维护依赖。比如现在我们在MainPresenter增加一个构造方法多传一个参数（C c)。 你只需要修改MainModule，首先创建个providesC()指明如何创建C实例，return c;再创建个providesPresenter2(...参数省略) return MainPresenter(activity,user,c)即可。MainActivity 是不需要做任何改变的。

demo源码
只提供了基本原型。杜绝花哨，没有封装。让想要快速了解答案的读者少走弯路。
只有亲手做的封装才是自己的。

感谢
Dagger2从入门到放弃再到恍然大悟
Android：dagger2让你爱不释手-终结篇
Dagger2 这次入门就不用放弃了