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

0. 前言

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

1. 简单的依赖注入

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

1234567891011
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代码如下所示。

1234567
@Modulepublic class ActivityModule {

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

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

 

1.2 构建Injector

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

1234
@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对象,完成注入。这部分代码如下所示。

123456789101112131415
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如下。

123456
@Modulepublic class ContainerModule {    @Provides ShoppingCartModel provideCartModel() {        return new ShoppingCartModel();    }}

 

2.2 构建Injector

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

1234
@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。

修改后代码如下: 

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

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

 

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

12345678910111213141516171819202122
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
时间: 2024-11-10 12:31:50

Android 使用dagger2进行依赖注入(基础篇)的相关文章

[Android]使用Dagger 2依赖注入 - 图表创建的性能(翻译)

以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/5098943.html 使用Dagger 2依赖注入 - 图表创建的性能 原文:http://frogermcs.github.io/dagger-graph-creation-performance/ #PerfMatters - 最近非常流行标签,尤其在Android世界中.不管怎样,apps只需要正常工作就可以的时代已经过去了.现在所有的一切都应该是令人愉

[Android]使用Dagger 2依赖注入 - API(翻译)

以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/5092525.html 使用Dagger 2依赖注入 - API 原文:http://frogermcs.github.io/dependency-injection-with-dagger-2-the-api/ 这章是展示使用Dagger 2在Android端实现依赖注入的系列中的一部分.今天我会探索Dagger 2的基础并且学习这个依赖注入框架的所有的API

Android图片压缩上传之基础篇_Android

在android程序开发中我们经常见到需要上传图片的场景,在这里有个技术点,需要把图片压缩处理,然后再进行上传.这样可以减少流量的消耗,提高图片的上传速度等问题. 关于android如何压缩,网上的资料也是很多,但大多数都是代码片段,讲解压缩步骤,而没有一个实用的工具类库.那么如何将压缩算法封装成一个实用工具库呢?其中会遇到些什么问题,比如: 1.需要压缩的图片有多少 2.压缩后的图片是覆盖还是保存到另外的目录 3.如果是另存目录需要将原始图片删除吗 4.如果改变压缩后的图片的尺寸大小是按照原图

[Android]使用Dagger 2依赖注入 - 自定义Scope(翻译)

以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/5095426.html 使用Dagger 2依赖注入 - 自定义Scope 原文:http://frogermcs.github.io/dependency-injection-with-dagger-2-custom-scopes/ 这章是展示使用Dagger 2在Android端实现依赖注入的系列中的一部分.今天我会花点时间在自定义Scope(作用域)上面

[Android]使用Dagger 2依赖注入 - DI介绍(翻译)

以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/5092083.html 使用Dagger 2依赖注入 - DI介绍 原文:http://frogermcs.github.io/dependency-injection-with-dagger-2-introdution-to-di/ 不久之前,在克拉科夫的 Tech Space 的 Google I/O 扩展中,我 展示 了一些关于使用Dagger 2来进行依

Android图片压缩上传之基础篇

在android程序开发中我们经常见到需要上传图片的场景,在这里有个技术点,需要把图片压缩处理,然后再进行上传.这样可以减少流量的消耗,提高图片的上传速度等问题. 关于android如何压缩,网上的资料也是很多,但大多数都是代码片段,讲解压缩步骤,而没有一个实用的工具类库.那么如何将压缩算法封装成一个实用工具库呢?其中会遇到些什么问题,比如: 1.需要压缩的图片有多少 2.压缩后的图片是覆盖还是保存到另外的目录 3.如果是另存目录需要将原始图片删除吗 4.如果改变压缩后的图片的尺寸大小是按照原图

Guice框架-DI(依赖注入基础入门)

所谓的绑定就是将一个接口绑定到具体的类中,这样客户端不用关心具体的实现,而只需要获取相应的接口完成其服务即可. HelloWorld.java      public interface HelloWorld {         String sayHello();      } 然后是具体的实现,HelloWorldImpl.java      public class HelloWorldImpl implements HelloWorld {         @Override      

[Android]使用Dagger 2进行依赖注入 - Producers(翻译)

以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/6234811.html 使用Dagger 2进行依赖注入 - Producers 原文:http://frogermcs.github.io/dependency-injection-with-dagger-2-producers/ 本文是在Android中使用Dagger 2框架进行依赖注入的系列文章中的一部分.今天我们将探索下Dagger Producers

用Dagger2在Android中实现依赖注入

依赖注入这个模式(模式已经用烂了,这里再烂一次)是用来给应用的各部分解耦的.使应用开发更加可扩展,更容易维护.通过本文你会学到如何使用Dagger2来处理依赖. 简介 如果以对象需要另外的一个对象才能完成一个完整功能的话,那么这里就存在一个依赖.比如,悟空要用金箍棒才能三打白骨精,要筋斗云才能十万八千里.悟空有对金箍棒和筋斗云的依赖.你可以在悟空对象里初始化金箍棒,也可以用一个工厂方法批量生产金箍棒.使用依赖注入可以无需一个专门的类来初始化这些依赖对象.这样就实现了解耦. 本教程会使用最新的Da