Android 使用dagger2进行依赖注入(基础篇)

0. 前言

Dagger2是首个使用生成代码实现完整依赖注入的框架,极大减少了使用者的编码负担, 本文主要介绍如何使用dagger2进行依赖注入。如果你不还不了解依赖注入,请看这一篇

1. 简单的依赖注入

首先我们构建一个简单Android应用。我们创建一个UserModel,然后将它显示到TextView中。这里的问题是,在创建UserModel的时候,我们使用了前文所说的hard init。一旦我们的UserModel的创建方式发生了改变(比如需要传入Context对象到构造函数),我们就需要修改所有创建UserModel的代码。而我们希望的是,对于UserModel的修改不影响其他模块的代码(比如这里的MainActivity)。

public class MainActivity extends ActionBarActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        UserModel user = new UserModel();
        ((TextView) findViewById(R.id.user_desc_line)).setText(user.id + "\n" + user.name + "\n" + user.gender);
    }
    ...
}

1.1 构建依赖

我们首先想到的是,将创建UserModel的代码独立出来,这样可以保证MainActivity的代码不被修改。dagger2中,这个负责提供依赖的组件被称为Module。我们构建的ActivityModule代码如下所示。

@Module
public class ActivityModule {

    @Provides UserModel provideUserModel() {
        return new UserModel();
    }
}

可以看到,我们使用@Module标识类型为module,并用@Provides标识提供依赖的方法。

1.2 构建Injector

有了提供依赖的组件,我们还需要将依赖注入到需要的对象中。连接提供依赖和消费依赖对象的组件被称为Injector。dagger2中,我们将其称为component。ActivityComponent代码如下:

@Component(modules = ActivityModule.class)
public interface ActivityComponent {
    void inject(MainActivity activity);
}

可以看到,Component是一个使用@Component标识的Java interface。interface的inject方法需要一个消耗依赖的类型对象作为参数。 注意:这里必须是真正消耗依赖的类型MainActivity,而不可以写成其父类,比如Activity。因为dagger2在编译时生成依赖注入的代码,会到inject方法的参数类型中寻找可以注入的对象,但是实际上这些对象存在于MainActivity,而不是Activity中。如果函数声明参数为Activity,dagger2会认为没有需要注入的对象。当真正在MainActivity中创建Component实例进行注入时,会直接执行按照Activity作为参数生成的inject方法,导致所有注入都失败。(是的,我是掉进这个坑了。)

1.3 完成依赖注入

最后,我们需要在MainActivity中构建Injector对象,完成注入。这部分代码如下所示。

public class MainActivity extends ActionBarActivity {
    private ActivityComponent mActivityComponent;

    @Inject UserModel userModel;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        mActivityComponent = DaggerActivityComponent.builder().activityModule(new ActivityModule()).build();
        mActivityComponent.inject(this);
        ((TextView) findViewById(R.id.user_desc_line)).setText(userModel.id + "\n" + userModel.name + "\n" + userModel.gender);
    }
    ...
}

首先,我们使用@Inject标志被注入的对象userModel(注意userModel不能为private),之后通过dagger2生成的实现了我们提供的ActivityComponent接口类DaggerActivityComponent创建component,调用其inject方法完成注入。

至此,我们使用dagger实现了最简单的依赖注入。

2. 多层依赖

除了上面这种最简单的形式,dagger2还可以使用component作为component的依赖,实现多层级的依赖注入。

2.1 构建依赖

我们新创建一个名为ShoppingCartModel的Domain Model。并按照1.1的方法构建其Module如下。

@Module
public class ContainerModule {
    @Provides ShoppingCartModel provideCartModel() {
        return new ShoppingCartModel();
    }
}

2.2 构建Injector

与1.2不同的是,我们的Injector提供的依赖不仅来自ContainerModule,我们还需要使用之前的ActivityComponent提供的UserModel依赖。

@Component(dependencies = ActivityComponent.class, modules = ContainerModule.class)
public interface ContainerComponent {
    void inject(MainActivity mainActivity);
}

所以如代码所示,我们在component后增加ActivityComponent了dependencies参数,使得一个Component成为了另一个Component的依赖。

2.3 低级Component提供依赖

目前的ActivityComponent代码如下所示。可以看到其只提供了inject方法,而没有提供需要的UserModel依赖。我们需要的是将ActivityModule提供的UserModel传递给依赖ActivityComponent的ContainerComponent。

修改后代码如下:

@Component(modules = ActivityModule.class)
public interface ActivityComponent {
//    void inject(MainActivity activity);
    UserModel userModel();
}

可以看到,我们为接口增加了提供UserModel依赖的方法,同时,如果不需要使它直接进行注入,可以去掉其inject方法,此时该Component只作为一种依赖的组织模块。

最后,MainActivity中进行依赖注入的代码如下。

public class MainActivity extends ActionBarActivity {
    private ActivityComponent mActivityComponent;

    @Inject
    UserModel userModel;

    @Inject
    ShoppingCartModel cartModel;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        mActivityComponent = DaggerActivityComponent.builder().activityModule(new ActivityModule()).build();
        ContainerComponent containerComponent = DaggerContainerComponent.builder().activityComponent(mActivityComponent).containerModule(new ContainerModule()).build();

        containerComponent.inject(this);

        ((TextView) findViewById(R.id.user_desc_line)).setText(userModel.id + "\n" + userModel.name + "\n" + userModel.gender + "\n" + cartModel.total);
    }
    ...
}

3. 最后

本文试图用最简单的例子介绍Android中如何使用dagger2进行依赖注入,因此有很多dagger2的特性并未涉及,比如@Scope注释,以及dagger2自动生成代码的分析调试。关于dagger2更深入的特性的分析,还需要在大量使用后再做出总结。

参考

  1. Dagger 2
  2. Tasting Dagger 2 on Android
  3. Dependency injection with Dagger 2 - the API

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Scott_Mr 个人专栏

React Native 系列(六) -- PropTypes

3519
来自专栏Android机动车

Dagger2系列——实例解析

这篇文章会分享一下实际应用中的Dagger2如何使用,以及Dagger2通过apt插件如何给我们生成代码,以及生成的代码之间的关联。

752
来自专栏从零开始学 Web 前端

从零开始学 Web 之 Vue.js(二)过滤器,按键修饰符,自定义指令

在这里我会从 Web 前端零基础开始,一步步学习 Web 相关的知识点,期间也会分享一些好玩的项目。现在就让我们一起进入 Web 前端学习的冒险之旅吧!

472
来自专栏开发之途

Android DataBinding 从入门到进阶

1393
来自专栏刘望舒

Android深入理解JNI(一)JNI原理与静态、动态注册

前言 JNI不仅仅在NDK开发中应用,它更是Android系统中Java与Native交互的桥梁,不理解JNI的话,你就只能停留在Java Framework层...

2637
来自专栏腾讯Bugly的专栏

Kotlin扩展函数与实现机制探索

2017年Google IO大会宣布使用Kotlin作为Android的官方开发语言,Kotlin作为一种新式的函数式编程语言,也有人称之为Android平台的...

4286
来自专栏vue学习

小程序 — 实现左滑删除效果②

(1)在上一章中,我们给movable-view绑定了一个bindchange事件,事件名为onChange,这个事件是干吗的呢?

712
来自专栏云瓣

深入React组件生命周期

上篇博文使用React开发的一些注意要点对React开发的一些重点进行了简单的罗列总结,虽然也提到了React生命周期,但只略微小结,在此单独写篇React生命...

3377
来自专栏Kevin-ZhangCG

[ SSH框架 ] Struts2框架学习之三(OGNL和ValueStack值栈学习)

2086
来自专栏前端小叙

react如何监听路由url变化

使用这些生命周期钩子可以监听到路由相同,参数不同的变化,但是监听不到完全不相同的url的变化。即使路由不同,componentDidMount组件内容所更新的东...

3041

扫码关注云+社区