Android之IOC依赖注入Dagger2

IOC(Inversion of Control)

是一中设计思想,解决业务之间的解耦,是将业务需要的对象交给容器去创建管理(new),而不是传统new获取

场景:Class-A 中用到了 Class-B中的对象b,一般传统情况下,需要A的代码中显示的new对象或者隐身传递参数,才能调用b,那么用IOC依赖注入的方式,可以把Class-B依赖注入到一个Container的容器里面,这样Class-A或者其他Class-X都是可以通过容器获取对象b。

IOC模型

在Android有俩个常用的ioc对象框架分别为 Dagger2Hilt

Dagger2

Dagger2 - Github Dagger2是基于Java注解并且在编译期完成的依赖注入,在编译阶段通过APT利用注解处理器来生成java代码

既然是ioc那么就需要:依赖提供方、依赖注入容器(桥梁)、依赖需求放。

Dagger2:

  • @Module 注解提供方
  • @Component 依赖同期
  • @Inject 注解变量对象需求方
  • @dependencies 组合容器,让多个容器组合成一个容器
  • @Provides 构造参数
  • @Singleton 单利模式
  • @Lazy<T> 懒加载需求,先需要通过get()获取对象函数
    implementation 'com.google.dagger:dagger:2.30.1'
    annotationProcessor 'com.google.dagger:dagger-compiler:2.30.1'

@Module

package com.example.dagger2app.object;

import dagger.Module;
import dagger.Provides;

//注册module提供方
@Module
public class HttpObject {


    private String url;

    public HttpObject() {
    }

    public HttpObject(String url) {
        this.url = url;
    }

    
//    @Provides
//    public HttpObject providesHttpObject() {
//        return new HttpObject();
//    }

    //构造Provides 需要返回当前对象, + 传参
    @Provides
    public HttpObject providesHttpObject(String url) {
        return new HttpObject(url);
    }

    //构造参数这里也需要+@Provides
    @Provides
    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }
}
package com.example.dagger2app.object;

import dagger.Module;
import dagger.Provides;

@Module
public class DbObject {

    
    private String name = "lss";
    private int age = 20;

    public DbObject() {
    }


    @Provides
    public DbObject providesDbObject() {
        return new DbObject();
    }


    public String getName() {
        return name;
    }

    public int getAge() {
        return age;
    }
}

Component

package com.example.dagger2app;

import com.example.dagger2app.object.DbObject;
import com.example.dagger2app.object.HttpObject;

import dagger.Component;

//容器
@Component(modules = {HttpObject.class, DbObject.class})
public interface MyComponent {

    void injectMainActivity(MainActivity activity);

}

Inject

package com.example.dagger2app;

import android.os.Bundle;
import android.util.Log;

import com.example.dagger2app.object.DbObject;
import com.example.dagger2app.object.HttpObject;

import javax.inject.Inject;

import androidx.appcompat.app.AppCompatActivity;
import dagger.Lazy;


public class MainActivity extends AppCompatActivity {


    private final String TAG = this.getClass().getSimpleName();

    @Inject
    HttpObject httpObject;

    @Inject
    DbObject dbObject;


    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);


        //方式一注解处理器帮忙new  所以注入的Module构造不能带参数
        DaggerMyComponent.create().injectMainActivity(this);

        //方式二适合构造传参 , 不建议使用,可以通过具体函数方法传参,create的最初目的是new对象
//        DaggerMyComponent.builder()
//                .httpObject(new HttpObject("www.google.com"))
//                .dbObject(new DbObject())
//                .build().injectMainActivity(this);


        Log.e(TAG, "onCreate: " + httpObject.toString());
        Log.e(TAG, "onCreate: " + httpObject.getUrl());


        Log.e(TAG, "onCreate: " + dbObject.toString());
        Log.e(TAG, "onCreate: " + dbObject.getName());
        Log.e(TAG, "onCreate: " + dbObject.getAge());
    }
}

@Singleton 局部单利

​ 关于Singleton 单例,只需要在 ModuleComponent 添加相应的标注


@Module
public class HttpObject {

//省略....

    @Singleton
    @Provides
    public HttpObject providesHttpObject() {
        return new HttpObject();
    }
}



@Singleton
@Component(modules = {HttpObject.class,DbObject.class})
public interface MyComponent {

    void injectMainActivity(MainActivity activity);

}

@Singleton 全局单利

​ 思考?为什么导致?在容器提供注册的时候有上下文活动Activity,导致对象不是同一个

​ 如果是要做全局的单利,那么容器的创建放到 Android - MyApplication 做全局

package com.example.dagger2app;
import android.app.Application;

public class MyApplication extends Application {

    private MyComponent myComponent;

    @Override
    public void onCreate() {
        super.onCreate();
   
        myComponent = DaggerMyComponent.create();
    }

    public MyComponent getMyComponent() {
        return myComponent;
    }
}

@dependencies 组合容器,让多个容器组合成一个容器

​ 副容器的写法修改下,不进行注入上下文,返回当期容器,给主容器使用

Module
package com.example.dagger2app.object;

import dagger.Module;
import dagger.Provides;

@Module
public class FileObject {

    @Provides
    public FileObject providesFileObject(){
        return new FileObject();
    }

}

Component(副,可以有多个)

package com.example.dagger2app;

import com.example.dagger2app.object.FileObject;

import dagger.Component;

@Component(modules = {FileObject.class})
public interface My2Component {

    //使用依赖关系
    FileObject getMy2Component();

}

Component(主,唯一) @dependencies 组合容器

package com.example.dagger2app;

import com.example.dagger2app.object.DbObject;
import com.example.dagger2app.object.HttpObject;

import dagger.Component;

//容器 modules,dependencies 组合容器, 
@Component(modules = {HttpObject.class, DbObject.class}, dependencies = {My2Component.class})
public interface MyComponent {

    void injectMainActivity(MainActivity activity);

}

原理分析

DaggerMyComponent.create().injectMainActivity(this);

通过进入生成的源码查看:

// Generated by Dagger (https://dagger.dev).
package com.example.dagger2app;

import com.example.dagger2app.object.DbObject;
import com.example.dagger2app.object.DbObject_ProvidesDbObjectFactory;
import com.example.dagger2app.object.HttpObject;
import com.example.dagger2app.object.HttpObject_ProvidesHttpObjectFactory;
import dagger.internal.Preconditions;

@SuppressWarnings({
    "unchecked",
    "rawtypes"
})
//方法名:Dagger+容器名ClassName   并且实现了容器接口  
public final class DaggerMyComponent implements MyComponent {
    
  //Module成了新Class的成员变量
    
  private final HttpObject httpObject;

  private final DbObject dbObject;

  private DaggerMyComponent(HttpObject httpObjectParam, DbObject dbObjectParam) {
    this.httpObject = httpObjectParam;
    this.dbObject = dbObjectParam;
  }

    //构建者模式
  public static Builder builder() {
    return new Builder();
  }

    //自动new
  public static MyComponent create() {
    return new Builder().build();
  }

    //依赖注册的活动上下文 ,又重新的生成xxx2的函数工厂
  @Override
  public void injectMainActivity(MainActivity activity) {
    injectMainActivity2(activity);
  }

    /**
    *工厂模式,Provides注册到活动页面,
    *如果在单例模式下面,Lazy<>  get 是双重检验机制
    */
  private MainActivity injectMainActivity2(MainActivity instance) {
    MainActivity_MembersInjector.injectHttpObject(instance, HttpObject_ProvidesHttpObjectFactory.providesHttpObject(httpObject));
    MainActivity_MembersInjector.injectDbObject(instance, DbObject_ProvidesDbObjectFactory.providesDbObject(dbObject));
    return instance;
  }

  public static final class Builder {
    private HttpObject httpObject;

    private DbObject dbObject;

    private Builder() {
    }

    public Builder httpObject(HttpObject httpObject) {
      this.httpObject = Preconditions.checkNotNull(httpObject);
      return this;
    }

    public Builder dbObject(DbObject dbObject) {
      this.dbObject = Preconditions.checkNotNull(dbObject);
      return this;
    }

    public MyComponent build() {
      if (httpObject == null) {
        this.httpObject = new HttpObject();
      }
      if (dbObject == null) {
        this.dbObject = new DbObject();
      }
      return new DaggerMyComponent(httpObject, dbObject);
    }
  }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容