AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

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

2015-11-03 1156
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 0. 前言 Dagger2是首个使用生成代码实现完整依赖注入的框架，极大减少了使用者的编码负担，本文主要介绍如何使用dagger2进行依赖注入。如果你不还不了解依赖注入，请看这一篇。 1. 简单的依赖注入 首先我们构建一个简单Android应用。

0. 前言

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();
 }
}


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

 

1.2 构建Injector

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

1
2
3
4
 
@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对象，完成注入。这部分代码如下所示。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
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如下。

1
2
3
4
5
6
 
@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
4
5
 
@Component(modules = ActivityModule.class)
public interface ActivityComponent {
// void inject(MainActivity activity);
 UserModel userModel();
}


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

 

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
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
文章标签：
Android开发
关键词：
Android依赖注入
Android Dagger
Android基础
Android dagger2
炉火纯青
目录
相关文章
游客zllgslqrsw3f6
|
12月前
|
API Android开发 iOS开发
掌握安卓与iOS应用开发中的依赖注入技术
本文探讨了在安卓和iOS应用开发中，如何有效利用依赖注入技术来提升代码的模块化、可测试性和可维护性。通过对比分析两种平台下依赖注入的实现方式与工具，本文旨在为开发者提供一套清晰、实用的依赖管理策略，助力打造高质量软件产品。
游客zllgslqrsw3f6
236 18
Ant.Dream
|
编译器 Android开发 开发者
带你了解Android Jetpack库中的依赖注入框架：Hilt
本文介绍了Hilt，这是Google为Android开发的依赖注入框架，基于Dagger构建，旨在简化依赖注入过程。Hilt通过自动化的组件和注解减少了DI的样板代码，提高了应用的可测试性和可维护性。文章详细讲解了Hilt的主要概念、基本用法及原理，帮助开发者更好地理解和应用Hilt。
Ant.Dream
415 8
晴天小庭
|
Java 数据库 Android开发
使用Hilt完成依赖注入，让你的安卓代码层次有几层楼那么高（三）
使用Hilt完成依赖注入，让你的安卓代码层次有几层楼那么高（三）
晴天小庭
319 0
jjczqyjxgdegi
|
Java Android开发
程序与技术分享：Android使用Dagger注入的方式初始化对象的简单使用
程序与技术分享：Android使用Dagger注入的方式初始化对象的简单使用
jjczqyjxgdegi
247 0
林栩link
|
Java 测试技术 API
Android-Jetpack依赖注入框架 - Hilt 入门指南
林栩link
6665 0
Android-Jetpack依赖注入框架 - Hilt 入门指南
梦笔生花伟
|
搜索推荐 Java Linux
Android基础入门教程
Android是一种基于Linux的自由及开放源代码的操作系统，Android 分为四个层，从高层到低层分别是应用程序层、应用程序框架层、系统运行库层和Linux内核层。
梦笔生花伟
327 0
晴天小庭
|
Android开发
使用Hilt完成依赖注入，让你的安卓代码层次有几层楼那么高（四）
使用Hilt完成依赖注入，让你的安卓代码层次有几层楼那么高（四）
晴天小庭
394 0
晴天小庭
|
Android开发 容器
使用Hilt完成依赖注入，让你的安卓代码层次有几层楼那么高（二）上
使用Hilt完成依赖注入，让你的安卓代码层次有几层楼那么高（二）
晴天小庭
201 0
petterp
|
XML 存储 安全
Android四大组件全面解析，夯实基础。（下）
Android四大组件 lay a solid foundation 夯实基础
petterp
283 0
FranzLiszt1847
|
测试技术 数据库 Android开发
Android Jetpack 浅析Hilt依赖注入
首先，某个类的成员变量称为依赖，如若此变量想要实例化引用其类的方法，可以通过构造函数传参或者通过某个方法获取对象，此等通过外部方法获取对象实例的称为依赖注入；而依赖注入又可以简单分为`手动注入`和`自动注入`两种方式；`Hilt`就是基于Dagger进行`场景化优化`的一个依赖注入库，Hilt是Google专门为Android平台打造的一个依赖注入库，在使用上极大程度进行啦简化(与dagger相比)
FranzLiszt1847
526 1

热门文章

最新文章

  • 1
    手机脚本录制器， 脚本录制器安卓，识图识色屏幕点击器【autojs】
  • 2
    Android自定义ProgressBar，实现漂亮的进度提示框
  • 3
    Kotlin 语言形式实现 Android 当中的 MVP
  • 4
    使用Android新式LruCache缓存图片，基于线程池异步加载图片
  • 5
    Android官方入门文档[12]启动一个活动
  • 6
    自行修改android.jar使其包含隐藏api
  • 7
    android 制作.9.png图片
  • 8
    为Android添加一门新语言
  • 9
    Android中使控件保持固定宽高比的几种方式
  • 10
    《Android和PHP开发最佳实践》一第1章　学 前 必 读
  • 1
    手机脚本录制器， 脚本录制器安卓，识图识色屏幕点击器【autojs】
    152
  • 2
    微信抢红包脚本安卓插件，微信xposed抢红包模块， magisk微信抢红包模块
    447
  • 3
    在Android开发中实现两个Intent跳转及数据交换的方法
    143
  • 4
    三色过人脸虚拟摄像头，安卓免root虚拟摄像头， 安卓虚拟摄像头过人脸
    956
  • 5
    批量发送短信的平台，安卓群发短信工具插件脚本，批量群发短信软件【autojs版】
    175
  • 6
    Android API Level 到底是什么？和安卓什么关系？应用发布如何知道自己的版本？优雅草卓伊凡
    385
  • 7
    安卓版快捷指令，加了AI语音可以一句话操作v0.2.7
    198
  • 8
    安卓虚拟摄像头模块， 手机vcam虚拟摄像头模块，虚拟摄像头替换手机摄像头
    326
  • 9
    手机微信虚拟视频聊天，安卓免root虚拟摄像头，免root虚拟hook相机
    302
  • 10
    安卓虚拟摄像头免root版，虚拟摄像头替换真实摄像头，jar代码开源分享
    476

    • 相关课程

    更多
  • 开源Android容器化框架Atlas开发者指南

    • 相关电子书

    更多
  • 58同城Android客户端Walle框架演进与实践之路
  • Android组件化实现
  • 蚂蚁聚宝Android秒级编译——Freeline
    • 下一篇
    阿里云 EMR Serverless Spark 版开启免费公测