Dagger2 — 通过注解实现依赖注入一种方式

本片文章将介绍Dagger2的作用及使用方式。

什么是Dagger2?

  • Dagger2是在编译时期生成代码实现完整依赖注入的框架

Dagger 2 is a compile-time evolution approach to dependency injection. Taking the approach started in Dagger 1.x to its ultimate conclusion, Dagger 2.x eliminates all reflection, and improves code clarity by removing the traditional ObjectGraph/Injector in favor of user-specified @Component interfaces.

什么是依赖注入?

  • 依赖注入作用
    • 是实现控制反转(Inversion of Control)的最常见的方式之一

      控制反转 是一种面向对象编程中的一种设计原则,用来减低计算机代码之间的耦合度。其基本思想是:借助于“第三方”实现具有依赖关系的对象之间的解耦。

      简单说就是如果对象A依赖于对象B,那么对象A自己需要主动去创建对象B,无论是创建还是使用对象B,控制权都在自己手上。而控制反转的思想是对象A与对象B之间失去直接联系,当对象A需要对象B的时候,IOC容器会主动创建一个对象B注入到对象A需要的地方。

    • 目的在于解耦

      • 常见耦合场景:一个类中直接创建另一个类的对象的代码,这样的操作和硬编码一样,会导致耦合,我们把这种初始化方式称为硬初始化(hard init)。
      • 硬初始化的坏处:
        • 修改构造函数实现时,需要修改创建处的代码
        • 不便于测试,直接创建另一个类对象的类无法单独被测试,其行为和另一个类紧紧耦合在一起,同时,也会导致代码的可读性问题。
  • 依赖注入常见3种方式:
    • 构造函数注入
      public class MovieLister {
         private MovieFinder finder;
         public MovieLister(MovieFinder finder) {
           this.finder = finder;
           }
        ...
      }
      
    • setter注入
        public class MovieLister {
          ...
           public void setFinder(MovieFinder finder) {
             this.finder = finder;
          }
       }
      
    • 接口注入
        public interface InjectFinder {
          void injectFinder(MovieFinder finder);
        }
      
       class MovieLister implements InjectFinder {
           ...
          public void injectFinder(MovieFinder finder) {
             this.finder = finder;
           }
         ...
       }
      

使用Dragger2进行依赖注入

  • 常见的硬初始化代码
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);
    }
    ...
}

一但UserModel的构造发生改变那么我们要修改所有实例化UserModel的代码。

  • 使用Dagger2实现方式
    • 目标:对于依赖类的修改不影响使用该类实例的类代码
    • 步骤:
      • 构建依赖

        • 将创建对象的代码隔离起来,保证使用的类不受其后期更改影响
        • 负责提供依赖的组件被称为Module
           @Module
           public class ActivityModule {
            @Provides UserModel provideUserModel() {
                return new UserModel();
               }
            } 
        
        • 使用@Module标识该类为Module,并用@Provides标识提供依赖的方法。
      • 构建Injector

        • 将依赖注入到需要的对象中
        • 连接提供依赖和消费依赖对象的组件被称为Injector。Dagger2中,我们将其称为component。
          @Component(modules = ActivityModule.class)
              public interface ActivityComponent {
                  void inject(MainActivity activity);
              }
        
        • Component是一个使用@Component标识的Java 接口。接口的inject方法入参为需要该依赖的类型。
        • 注意:这里必须是真正消耗依赖的类型MainActivity,而不可以写成其父类,比如Activity。因为Dagger2在编译时生成依赖注入的代码,会到inject方法的参数类型中寻找可以注入的对象,但是实际上这些对象存在于MainActivity,而不是Activity中。所以如果函数声明参数为Activity,Dagger2在Activity中找不到要注入的对象,导致所有注入都失败。
      • 完成依赖注入:在需要依赖的地方创建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方法完成注入。

Dagger2通过将创建依赖类对象的代码独立起来,保证使用的类不受依赖类的构造改变而受到影响,同时通过注解在编译时动态生成代码注入到被依赖类中,实现依赖类和被依赖类解耦。

参考文献:

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

推荐阅读更多精彩内容

  • Dagger2是个什么东西呢?依赖注入,这是个啥玩意?嗯,在学这个东西的时候我们得了解一些知识点: 知识点呀 依赖...
    SHERLOCKvv阅读 1,189评论 0 6
  • 部分内容参考自:[Android]使用Dagger 2依赖注入 - DI介绍(翻译)[Android]使用Dagg...
    AItsuki阅读 47,207评论 66 356
  • 前言 使用Dagger2前你必须了解的一些设计原则Dagger2 最清晰的使用教程请先看以上两篇文章 dagger...
    SnowDragonYY阅读 1,023评论 0 3
  • 什么的依赖注入 在软件工程中,依赖注入是实现控制反转的方式之一。百度百科中对于控制反转的解释如下:控制反转(Inv...
    小甜李子阅读 1,668评论 5 3
  • 17号晚上10点到二姨家,舅舅一家在这里等我们相聚。今天除大姨和我爸爸没有在场,妈妈其他姊妹都在、很难得这么多亲人...
    蒋泳频阅读 69评论 0 0