Dagger2快速入门

Dagger2简介(1分钟)

Dagger2是基于java规范，可以应用在java和android项目上的依赖注入框架

什么是依赖注入(5分钟)

所谓依赖注入，是指程序运行过程中，如果需要调用另一个对象时，无须在代码中创建被调用者，而是依赖于外部的注入，即可实现依赖对象的初始化。它是一种控制反转（IoC）的实现方式或方法。
啥又是控制反转呢？控制反转实际上是为了解决代码依赖耦合度的一种设计模式。当对象A依赖B时，那么A会在对象内部创建B对象，可以理解成B的生成受A的控制，这是一种正向控制；那么控制反转就是B的生成不受A的控制了。这就需要在A对象的外将其所依赖的对象B的引用传递给它。也可以说，依赖被注入到对象A中。
例如A依赖B的正向控制代码如下：

public class A {
  private B b;
  public A() {
    b = new B();
  }
  public B getB() {
    return b;  
  }
}

使用控制反转模式后的代码

public class A {
  private B b;
  public A(B b) {
    this.b = b;
  }
  public B getB() {
    return b;  
  }
}

而上面的代码正是最简单的依赖注入，因此，从上面的代码看出，我们经常都会用到控制反转模式，也会经常用到依赖注入这种方法或者技术。而Dagger2，则是帮助我们更方便的使用依赖注入的框架。

Dagger2 优点(1分钟)

1. 主要优点是严格遵循代码生成，没有反射，因此在Android上使用没有性能问题，且出错可追朔，方便断点调试
2. 依赖注入使用简单

Dagger2基本流程(2分钟)

Dagger2通过Component实现将依赖注入对象中；依赖的对象可以通过Module提供，也可以通过默认的构造器加上@Inject注解来提供依赖；注入后，对象中包含@Inject注解的变量，就会自动赋值。大致示意图如下：

image.png

Dagger2基本用法(19分钟)

1. 添加依赖
   Gradle方式:
   在build.gradle中添加如下依赖：

api 'com.google.dagger:dagger-android:2.28'
annotationProcessor 'com.google.dagger:dagger-compiler:2.28'

2. 概念介绍

• @Inject ：该注解在Dagger2中，用来标识Dagger2感兴趣的构造函数和字段。在构造方法上加入注解，表示Dagger2会使用它来创建一个类的实例。例如

class Thermosiphon implements Pump {
  private final Heater heater;

  @Inject
  Thermosiphon(Heater heater) {
    this.heater = heater;
  }

  ...
}

在字段上加入@Inject，表示由Dagger2注入时，为它赋值。例如：

class CoffeeMaker {
  @Inject Heater heater;
  @Inject Pump pump;

  ...
}

• @Module ：当依赖的对象没有办法在构造方法上添加@Inject注解时，可以通过@Module，自定义实现注入对象的生成方式，可以理解为对象工厂，通常用于第三方SDK对象的生成。
• @Provides ：@Provides通常用在@Module里面，它表示要提供的对象
• @Component ：Component可以理解为一个容器，它是对象和依赖对象之间的桥梁，可以为对象注入依赖。

3. 简单注入

• 增加一个依赖对象, 给构造方法加上@Inject注解

public class Logger {
    @Inject
    public Logger() {
    }
    public void log(String msg) {
        System.out.println(msg);
    }
}

• 增加一个Component，给需要依赖的对象提供一个注入接口

@Component
public interface CoffeeShopComponent {

    void inject(Street street);

}

• 在需要依赖的对象中，通过依赖注入后，可以使用该对象, 注入时，需要在CoffeeShopComponent类前加上Dagger, DaggerCoffeeShopComponent是自动生成的类。

public class Street {
    @Inject
    Logger logger;
    public Street() {
    }
    public void byCoffee() {
        DaggerCoffeeShopComponent.create().inject(this);
        logger.log("inject success");
    }
}

注意：如果Component不是顶级类，如下代码中BazComponent：

class Foo {
  static class Bar {
    @Component
    interface BazComponent {
    }
  }
}

则生成的Component为DaggerFoo_Bar_BazComponent
总结：Street中打印日志不再需要关心logger如何实例化，后期如果Logger升级后，都不会影响Street，这对于大量使用Logger的类，降低了对Logger构建的耦合。

使用Module代替构造方法+Inject(5分钟)

• 假如Logger是一个基础组件，无法在构造方法上加入@Inject注解，则需要通过Module来提供Logger对象。

@Module
public class SubModule {
    @Provides
    public Logger providerLogger() {
        return new Logger();
    }
}

• 修改Component，为它指定需要提供的Module

@Component(modules = SubModule.class)
public interface CoffeeShopComponent {

    void inject(Street street);

}

• 在生成Component前，需要提供相应的Module

public class Street {
    @Inject
    Logger logger;

    public Street() {
    }

    public void byCoffee() {
        DaggerCoffeeShopComponent.builder().subModule(new SubModule()).build().inject(this);
        logger.log("inject success");
    }
}