Dagger2使用详解

Dagger2注解

Dagger2使用过程中我们通常接触到的注解主要包括：@Inject, @Module, @Provides, @Component, @Qulifier, @Scope, @Singleten。

@Inject：@Inject有两个作用，一是用来标记需要依赖的变量，以此告诉Dagger2为它提供依赖；二是用来标记构造函数，Dagger2通过@Inject注解可以在需要这个类实例的时候来找到这个构造函数并把相关实例构造出来，以此来为被@Inject标记了的变量提供依赖；

@Module：@Module用于标注提供依赖的类。你可能会有点困惑，上面不是提到用@Inject标记构造函数就可以提供依赖了么，为什么还需要@Module？很多时候我们需要提供依赖的构造函数是第三方库的，我们没法给它加上@Inject注解，又比如说提供以来的构造函数是带参数的，如果我们之所简单的使用@Inject标记它，那么他的参数又怎么来呢？@Module正是帮我们解决这些问题的。

@Provides：@Provides用于标注Module所标注的类中的方法，该方法在需要提供依赖时被调用，从而把预先提供好的对象当做依赖给标注了@Inject的变量赋值；

@Component：@Component用于标注接口，是依赖需求方和依赖提供方之间的桥梁。被Component标注的接口在编译时会生成该接口的实现类（如果@Component标注的接口为CarComponent，则编译期生成的实现类为DaggerCarComponent）,我们通过调用这个实现类的方法完成注入；

@Qulifier：@Qulifier用于自定义注解，也就是说@Qulifier就如同Java提供的几种基本元注解一样用来标记注解类。我们在使用@Module来标注提供依赖的方法时，方法名我们是可以随便定义的（虽然我们定义方法名一般以provide开头，但这并不是强制的，只是为了增加可读性而已）。那么Dagger2怎么知道这个方法是为谁提供依赖呢？答案就是返回值的类型，Dagger2根据返回值的类型来决定为哪个被@Inject标记了的变量赋值。但是问题来了，一旦有多个一样的返回类型Dagger2就懵逼了。@Qulifier的存在正式为了解决这个问题，我们使用@Qulifier来定义自己的注解，然后通过自定义的注解去标注提供依赖的方法和依赖需求方（也就是被@Inject标注的变量），这样Dagger2就知道为谁提供依赖了。----一个更为精简的定义：当类型不足以鉴别一个依赖的时候，我们就可以使用这个注解标示；

@Scope：@Scope同样用于自定义注解，我能可以通过@Scope自定义的注解来限定注解作用域，实现局部的单例；

@Singleton：@Singleton其实就是一个通过@Scope定义的注解，我们一般通过它来实现全局单例。但实际上它并不能提前全局单例，是否能提供全局单例还要取决于对应的Component是否为一个全局对象。

我们提到@Inject和@Module都可以提供依赖，那如果我们即在构造函数上通过标记@Inject提供依赖，有通过@Module提供依赖Dagger2会如何选择呢？具体规则如下：

步骤1：首先查找@Module标注的类中是否存在提供依赖的方法。
步骤2：若存在提供依赖的方法，查看该方法是否存在参数。
a：若存在参数，则按从步骤1开始依次初始化每个参数；
b：若不存在，则直接初始化该类实例，完成一次依赖注入。
步骤3：若不存在提供依赖的方法，则查找@Inject标注的构造函数，看构造函数是否存在参数。
a：若存在参数，则从步骤1开始依次初始化每一个参数
b：若不存在，则直接初始化该类实例，完成一次依赖注入。

Dagger2使用入门

前面长篇大论的基本都在介绍概念，下面我们看看Dagger2的基本应用。
Dagger2的依赖配置:

dependencies {
    implementation"com.google.dagger:dagger:2.14.1"
    annotationProcessor"com.google.dagger:dagger-compiler:2.14.1"
}

如果你使用的Android gradle插件2.2版本以下，可以到它的github主页下去查看官方教程https://github.com/google/dagger。

举个栗子

1、案例A

利用android中常见mvp模式做案例，MainActivity类是需求依赖方，依赖了MainPresenter类；MainPresenter类是依赖提供方，因此我们需要在它的构造函数上添加@Inject:

public class MainPresenter {

    @Inject
    public MainPresenter() {
        Log.i("Dagger2Demo", "MainPresenter:constructor >>>");
    }

    public void mainTest(long time){
        Log.i("Dagger2Demo", "MainPresenter:mainTest time " + time);
    }
}

需要在类变量MainPresenter上添加@Inject来告诉Dagger2来为自己提供依赖。

public class MainActivity extends AppCompatActivity {

    @Inject
    MainPresenter mainPresenter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Log.i("Dagger2Demo", "onCreate: mainPresenter = " + mainPresenter);
    }
}

现在执行mainPresenter是没有被初始化的：

测试结果

为什么没有呢，因为我们还需要创建一个用@Component标注的接口MainComponent，这个MainComponent其实就是一个注入器，这里用来将MainPresenter注入到MainActivity中:

@Component
public interface MainComponent {
    void inject(MainActivity mainActivity);
}

Ctrl+F9重新编译后，添加注入代码DaggerMainComponent.create().inject(this)：

public class MainActivity extends AppCompatActivity {

    @Inject
    MainPresenter mainPresenter;

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

        Log.i("Dagger2Demo", "onCreate: mainPresenter = " + mainPresenter);
        //两种方式注入 选一即可
        //DaggerMainComponent.builder().build().inject(this);
        DaggerMainComponent.create().inject(this);
        Log.i("Dagger2Demo", "onCreate: mainPresenter = " + mainPresenter);
        mainPresenter.mainTest(System.currentTimeMillis());
    }
}

最后查看输出结果：

测试输出结果

注入成功！

2、案例B

如果注解类的构造函数是带参数的呢？或者注解类是我们无法修改的呢？这时候就需要@Module和@Provide上场了。以Computer和cpu为例：

public class Computer {

    private String cpu;

    public Computer(String cpu) {
        this.cpu = cpu;
    }

    public String getCpu() {
        return cpu;
    }

    public void setCpu(String cpu) {
        this.cpu = cpu;
    }

    public void run(){
        Log.i("Dagger2Demo","Computer is run，cpu is " + cpu);
    }
}

写好Computer类，准备用Module类来生成依赖对象，前面介绍的@Module就是用来标准这个类的，而@Provide则是用来标注具体提供依赖对象的方法（这里有个不成文的规定，被@Provide标注的方法命名我们一般以provide开头，这并不是强制的但有益于提升代码的可读性）。

@Module
public class ComputerModule {

    @Provides
    public Computer proviedComputer(){
        return new Computer("Intel 酷睿i7 8代");
    }
}

之前的@Component注解是不带参数的，现在我们需要加上modules = {ComputerModule.class}，用来告诉Dagger2提供依赖的是ComputerModule这个类。

@Component(modules = {ComputerModule.class})
public interface ComputerComponent {
    void inject(MainActivity mainActivity);
}

Ctrl+F9重新编译，生成Dagger注入代码：在MainActivity中添加DaggerComputerComponent.create().inject(this)：

public class MainActivity extends AppCompatActivity {

    @Inject
    Computer computer;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        DaggerComputerComponent.create().inject(this);
        computer.run();
    }
}