Dagger 2 完全解析（一），Dagger 2 的基本使用

依赖注入

什么是依赖

依赖注入是一种面向对象的编程模式，它的出现是为了降低耦合性，所谓耦合就是类之间依赖关系，所谓降低耦合就是降低类和类之间依赖关系。可能有的人说自己之前并没有使用过依赖注入，其实真的没有使用过吗？当我们在一个类的构造函数中通过参数引入另一个类的对象，或者通过set方法设置一个类的对象其实就是使用的依赖注入。

如果在 Class A 中，有 Class B 的实例，则称 Class A 对 Class B 有一个依赖。例如 Man 中有用到一个 Car 对象，即 Man 对 Car 有一个依赖。

public class Man {
    Car car;
    public Man() {
        car = new Car();
    }
    ...
}
image

上面这种写法是最常见的写法，但是在下面几个场景中存在一些问题：

  1. 如果要修改 Car 的构造函数，例如需要使用car = new Car(name)的方式构造时，还要修改 Man 的代码；

  2. 如果想测试不同的 Car 对 Man 的影响会很困难，例如单元测试中使用 mock 的 car 测试 Man。

解决上面的问题可以通过依赖注入的方法修改

image

依赖注入就是将对象实例传入到一个对象中去（Denpendency injection means giving an object its instance variables）。依赖注入是一种设计模式，降低了依赖和被依赖对象之间的耦合，方便扩展和单元测试。

其实在平常编码的过程中，已经不知觉地使用了依赖注入

  • 基于构造函数，在构造对象时注入所依赖的对象。
public class Man {
    Car car;
    public Man(Car car) {
        this.car = car;
    }
    ...
}
  • 基于 set 方法，使用 setter 方法来让外部容器调用传入所依赖的对象。
public class Man {
    ...
    public void setCar(Car car) {
        this.car = car;
    }
}
  • 基于接口，使用接口来提供 setter 方法。
public interface CarInjector {
    void injectCar(Car car);
}

public class Man implements CarInjector {
    ...
    @Override
    public void injectCar(Car car) {
        this.car = car;
    }
}
  • 基于注解，Dagger 2 依赖注入框架就是使用@Inject完成注入。
public class Man {
    @Inject
    Car car;
    ...
}

下面介绍一下我们的主角 Dagger 2

Dagger 2

Dagger 2 是 Java 和 Android 下的一个完全静态、编译时生成代码的依赖注入框架，由 Google 维护，早期的版本 Dagger 是由 Square 创建的。

Dagger 2 是基于 Java Specification Request(JSR) 330标准。利用 JSR 注解在编译时生成代码，来注入实例完成依赖注入。

下面是 Dagger 2 的一些资源地址：

Github：https://github.com/google/dagger

官方文档：https://google.github.io/dagger//

API：http://google.github.io/dagger/api/latest/

Dagger 2 的基本使用

上面介绍了依赖注入和 Dagger 2，下面由简单的示例开始一步一步地展示 Dagger 2 的基本使用。

引入 Dagger 2

在app/build.gradle中添加依赖：

dependencies {
    ...
    compile 'com.google.dagger:dagger:2.11'
    annotationProcessor 'com.google.dagger:dagger-compiler:2.11'
}

如果 Android gradle plugin 的版本低于2.2，还需要引入 android-apt 插件。

使用 @Inject 标注需要注入的依赖

学习Dagger2 是为了在android中使用，咱们换个例子，用Activity作为主题来演示讲解：

public class MainActivity extends AppCompatActivity {
    @Inject
    Car car;
    ...
 }

使用javax.inject.Inject注解来标注需要 Dagger 2 注入的依赖，注意 @Inject标注的成员属性不能是private的，不然无法注入，后边会讲为什么不能是private的。

创建所依赖对象的实例

用@Inject标注构造函数时，Dagger 2 会完成实例的创建。

public class Car {
    @Inject
    public Car() {}
}

依赖注入是依赖的对象实例-->需要注入的实例属性，上面完成两步，通过 Dagger 2 生成的代码代码可以知道，生成了MainActivity 的成员属性注入类和 Car的工厂类，接下来需要的就是新建工厂实例并调用成员属性注入类完成car 的实例注入。完成这个过程的桥梁就是dagger.Component。

Component 桥梁

@Component可以标注接口或抽象类，Component 桥梁可以完成依赖注入过程，其中最重要的是定义注入接口，调用注入接口就可以完成 MainActivity 所需依赖的注入。

@Component
public interface MainActivityComponent {
    void injectMainActivity(MainActivity mainActivity);  // 参数是需要注入的目标类
}

接口的名字叫什么都可以，但是推荐以Component结尾，方法的名字也没有要求，但是推荐以inject开始，参数就是需要注入的目标类（也就是你想把Car注入到哪个类里面），注意不能是目标类的子类或父类！

接下来需要先把项目 build 一下，完了在 MainActivity 中调用injectMainActivity方法就能完成注入。

public class MainActivity extends AppCompatActivity {
    @Inject
    Car car;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        DaggerMainActivityComponent.create().injectMainActivity(this);
        Log.e("123",car.toString());
    }
}

先看下日志打印结果，发现已经把car的地址打印出来了


日志.png

有的同学可能有疑问DaggerMainActivityComponent这个类是从哪里来的？其实这个类是通过apt插件生成的，有的同学也发现很眼熟，其实这个是就是咱们上面创建的MainActivityComponent接口前面固定加了一个Dagger前缀而已。

但是需要注意的是这种方式的依赖类一定要有一个没有参数的构造函数，不然会编译的时候就会报如下错误，这个也可以理解因为Dagger2 在生成代码的时候没有办法给构造函数传递参数。后边会讲如果有构造函数的想这样用需要怎么修改。

com.xx.xx cannot be provided without an @Inject constructor or from an @Provides-annotated method. This type supports members injection but cannot be implicitly provided.

Module

使用@Inject标注构造函数来提供依赖的对象实例的方法，不是万能的，在以下几种场景中无法使用：

  1. 接口没有构造函数

  2. 第三方库的类不能被标注

  3. 构造函数中的参数必须配置

比如上面的例子，如果这个car是第三方的类就可以用@Provides标注的方法来提供依赖实例，方法的返回值就是依赖的对象实例，@Provides方法必须在Module中，Module即用@Module标注的类。所以 Module 是提供依赖的对象实例的另一种方式。

@Module
public class CarModule {
    @Provides
    static Car provideCar() {
        return new Car();
    }
}

约定俗成的是@Provides方法一般以provide为前缀，Moudle 类以Module为后缀，一个 Module 类中可以有多个@Provides方法。

接下来，需要把可以提供依赖实例的 Module 告诉 Component：

@Component(modules = CarModule.class)
public interface MainActivityComponent {
    void injectMainActivity(MainActivity mainActivity);  // 参数是需要注入的目标类
}

如果是多个Module可以这么写

@Component(modules = {CarModule.class,CarModule1.class})

同样这种方式也需要先build一下，看下这种方式怎么注入

public class MainActivity extends AppCompatActivity {
    @Inject
    Car car;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        DaggerMainActivityComponent.builder().carModule(new CarModule()).build().injectMainActivity(this);
        Log.e("123",car.toString());
    }
}

学会了这种方式之后，我们来看看上面提到的那种如果有构造函数的需要怎么注入，上面的Car需要CarKey，看下2个类

Car
public class Car {
    private final CarKey carKey;
    public Car(CarKey carKey) {
        this.carKey = carKey;
    }
    public CarKey getCarKey() {
        return carKey;
    }
}
CarKey
public class CarKey {
    private final String str;
    public CarKey(String str) {
        this.str = str;
    }
    public String getString() {
        return "我是" + str + "的车钥匙！";
    }
}

可以看到Car是需要依赖CarKey的，可能最先想到的办法就是这样:

    @Provides
    static Car provideCar() {
        CarKey carKey = new CarKey("跑车");
        return new Car(carKey);
    }

直接在方法中创建一个CarKey不就得了，但是你有没有发现，这样操作就又耦合了啊，怎么把CarKey也注入到Car中呢，Dagger2提供了这样的功能,我们只要在·provideCar·方法中添加CarKey参数，Dagger2就会像帮依赖需求方找依赖对象一样帮你找到该方法依赖的CarKey实例,所以我们代码可以这样改：

@Module
public class CarModule {
    @Provides
    static Car provideCar(CarKey carKey) {
        return new Car(carKey);
    }
    @Provides
    static CarKey provideCarKey() {
        return new CarKey("跑车");
    }
}

MainActivity里面的注入的方法不用改变，添加如下日志：

Log.e("123", "car.getCarKey().toString()" + car.getCarKey().toString());
Log.e("123", "car.toString()" + car.toString());
Log.e("123", "car.getCarKey().getString()" + car.getCarKey().getString());

发现CarKey的对象地址和getString方法都能打印，说明CarKey注入成功。

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

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

总结

现在再来看 Dagger 2 最核心的三个部分：

  1. 需要注入依赖的目标类，需要注入的实例属性由@Inject标注。

  2. 提供依赖对象实例的工厂，用@Inject标注构造函数或定义Module这两种方式都能提供依赖实例，Dagger 2 的注解处理器会在编译时生成相应的工厂类。Module的优先级比@Inject标注构造函数的高，意味着 Dagger 2 会先从 Module 寻找依赖实例。

  3. 把依赖实例工厂创建的实例注入到目标类中的 Component。

下面再讲述上面提到的在 Dagger 2 种几个注解的用法：

  • @Inject 一般情况下是标注成员属性和构造函数，标注的成员属性不能是private，Dagger 2 还支持方法注入，@Inject还可以标注方法。

  • @Provides 只能标注方法，必须在 Module 中。

  • @Module 用来标注 Module 类

  • @Component 只能标注接口或抽象类，声明的注入接口的参数类型必须和目标类一致。

参考文章，感谢！
JohnnyShieh
Dagger2 入门,以初学者角度.

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 204,732评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 87,496评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,264评论 0赞 338
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,807评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,806评论 5赞 368
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,675评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,029评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,683评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 41,704评论 1赞 299
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1赞 332
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,413评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,016评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2赞 350
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2赞 343