Android 使用dagger2进行依赖注入(基础篇)
2016-11-29 11:38
537 查看
Android 使用dagger2进行依赖注入(基础篇)
原文地址:http://www.cnblogs.com/pangguoming/p/4934615.html0. 前言
Dagger2是首个使用生成代码实现完整依赖注入的框架,极大减少了使用者的编码负担,本文主要介绍如何使用dagger2进行依赖注入。如果你不还不了解依赖注入,请看这一篇。
1. 简单的依赖注入
首先我们构建一个简单Android应用。我们创建一个UserModel,然后将它显示到TextView中。这里的问题是,在创建UserModel的时候,我们使用了前文所说的hard init。一旦我们的UserModel的创建方式发生了改变(比如需要传入Context对象到构造函数),我们就需要修改所有创建UserModel的代码。而我们希望的是,对于UserModel的修改不影响其他模块的代码(比如这里的MainActivity)。1 2 3 4 5 6 7 8 9 10 11 | 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代码如下所示。1 2 3 4 5 6 7 | @Module public class ActivityModule { @Provides UserModel provideUserModel() { return new UserModel(); } } |
1.2 构建Injector
有了提供依赖的组件,我们还需要将依赖注入到需要的对象中。连接提供依赖和消费依赖对象的组件被称为Injector。dagger2中,我们将其称为component。ActivityComponent代码如下:1 2 3 4 | @Component(modules = ActivityModule.class) public interface ActivityComponent { void inject(MainActivity activity); } |
注意:这里必须是真正消耗依赖的类型MainActivity,而不可以写成其父类,比如Activity。因为dagger2在编译时生成依赖注入的代码,会到inject方法的参数类型中寻找可以注入的对象,但是实际上这些对象存在于MainActivity,而不是Activity中。如果函数声明参数为Activity,dagger2会认为没有需要注入的对象。当真正在MainActivity中创建Component实例进行注入时,会直接执行按照Activity作为参数生成的inject方法,导致所有注入都失败。(是的,我是掉进这个坑了。)
1.3 完成依赖注入
最后,我们需要在MainActivity中构建Injector对象,完成注入。这部分代码如下所示。1 2 3 4 5 6 7 8 9 10 1112 | public class MainActivity extends ActionBarActivity { |
至此,我们使用dagger实现了最简单的依赖注入。
2. 多层依赖
除了上面这种最简单的形式,dagger2还可以使用component作为component的依赖,实现多层级的依赖注入。2.1 构建依赖
我们新创建一个名为ShoppingCartModel的Domain Model。并按照1.1的方法构建其Module如下。1 2 3 45 | @Module public class ContainerModule { @Provides ShoppingCartModel provideCartModel() { return new ShoppingCartModel(); } } |
2.2 构建Injector
与1.2不同的是,我们的Injector提供的依赖不仅来自ContainerModule,我们还需要使用之前的ActivityComponent提供的UserModel依赖。1 2 3 4 | @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。修改后代码如下:
1 2 3 45 | @Component(modules = ActivityModule.class) public interface ActivityComponent { // void inject(MainActivity activity); UserModel userModel(); } |
最后,MainActivity中进行依赖注入的代码如下。
1 2 3 4 5 6 7 8 9 10 1112 | 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更深入的特性的分析,还需要在大量使用后再做出总结。相关文章推荐
- Android 使用dagger2进行依赖注入(基础篇)
- Android中使用Dagger2进行依赖注入
- [Android]使用Dagger 2进行依赖注入 - Producers(翻译)
- 「Android」使用Dagger 2进行依赖注入 - Producers
- 使用Dagger 2进行依赖注入 - API介绍
- Android项目使用Dagger2进行依赖注入
- Android项目使用Dagger2进行依赖注入
- Android中的依赖注入:Dagger函数库的使用(一)
- [Android]使用Dagger 2依赖注入 - DI介绍(翻译)
- Android:dagger2让你爱不释手-依赖注入框架基础篇
- Android快速依赖注入框架Dagger2使用1
- 使用Dagger 2进行依赖注入
- 使用dagger2进行依赖注入--简单入门,红色文字部分有意义
- [Android]使用Dagger 2依赖注入 - 图表创建的性能(翻译)
- [Android]使用Dagger 2依赖注入 - API(翻译)
- Android依赖注入Dagger的使用和源码解析
- Android 依赖注入框架 Dagger2使用
- [Android]使用Dagger 2依赖注入 - 自定义Scope(翻译)
- [Android]在Dagger 2中使用RxJava来进行异步注入(翻译)
- Android快速依赖注入框架Dagger2使用2