02.对注解的分类讲解——Inject部分

关于Dagger2

前言

本文将通过对注解的分类讲解来交代Dagger2的进阶用法。

关于Dagger的注解,简单将它们分成三类:

  • Component部分
  • Module部分
  • Inject部分
注解分类

来对应Dagger完成依赖注入的三部分内容,首先先从Inject注入部分看起。

Inject部分注解

@Inject

@Inject用于注解构造函数或成员变量。

作用于成员变量时:
Dagger2根据该注解及成员变量的类型,从Moudle中得到相应实例,或者根据使用了@Inject标注的无参构造函数的类,获取该类的实例。

注意:成员变量的访问修饰符不能是private

作用于构造函数时:
一般为无参数的一般构造函数,可以直接在其它类中通过依赖注入的方式进行注入。

@Inject 不适用的情况:

  • 不具有构造函数的接口
  • 远程引入的三方库中的类无法被添加注解
  • 通过建造者模式等方式可配置化的进行构造的对象

(使用@Provides可以处理这些问题)

@Named

我们可以通过@Inject注解来注入实例,但是在注入过程中会出现比如相同的类确却是不同的实例,这时候应该怎么办呢?

Dagger2提供了@Named注解用于在区别不同的实例对象创建。

// namedAnnotationsDevelop 和 namedAnnotationsRelease 是两个不同的实例对象
NamedAnnotations namedAnnotationsDevelop = new NamedAnnotations();
NamedAnnotations namedAnnotationsRelease = new NamedAnnotations();

使用@Named注解来定义两个不同实例:

@Module
public class NamedAnnotationsModule {

    // 定义这个提供的依赖对象为develop
    @Named("develop")
    @Provides
    NamedAnnotations providerNamedAnnotationsDevelop() {
        return new NamedAnnotations();
    }

    // 定义这个提供的依赖对象为release
    @Named("release")
    @Provides
    NamedAnnotations providerNamedAnnotationsRelease() {
        return new NamedAnnotations();
    }
}

定义Component:

@Component(modules = NamedAnnotationsModule.class)
public interface NamedAnnotationsComponent {
    void inject(NamedAnnotationsActivity activity);
}

在Activity 中调用两个不同对象:

public class NamedAnnotationsActivity extends AppCompatActivity {

    // 依赖对象要通过 @Named 标注注明对象的名称
    @Named("develop")
    @Inject
    NamedAnnotations mNamedAnnotationsDevelop;

    @Named("release")
    @Inject
    NamedAnnotations mNamedAnnotationsRelease;

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

        DaggerNamedAnnotationsComponent.create().inject(this);

        Log.d("Dagger测试", "mNamedAnnotationsDevelop: " + mNamedAnnotationsDevelop);
        Log.d("Dagger测试", "mNamedAnnotationsRelease: " + mNamedAnnotationsRelease);
    }
}

测试结果:


打印结果

可以看到我们所引入的两个对象确实是两个不同的对象。

@Qualifier

@Qualifier注解是用来区分同一纬度下两种不同的创建实例的方法,什么叫同一纬度呢?

  • 通过用Inject注解标注的构造函数来创建(以下简称Inject维度)
  • 通过Module中的Provides注解或者Binds等注解来创建(以下简称Module维度)

比如我们在Module提供两种不同的创建实例的方法,但是创建的实例又是同一个,这时候应该怎么操作呢?可以通过@Qualifier注解创建两个不同的注解来实现:

@Module
public class QualifierAnnotationsModule {

    @Provides
    QualifierAnnotations providerQualifierAnnotationsDevelop() {
        return new QualifierAnnotations("develop");
    }

    @Provides
    QualifierAnnotations providerQualifierAnnotationsRelease() {
        return new QualifierAnnotations("release");
    }
}

这两个povider方法中所提供的对象都是Food只是其中的创建方式不同,这种情况下Dagger是不知道应该创建哪一个对象的。

所以我们将通过@Qualifier创建两个新的注解:

@Qualifier
public @interface Develop {
}
@Qualifier
public @interface Release {
}

然后修改一下我们提供依赖注入的方法:

@Module
public class QualifierAnnotationsModule {

    @Provides
    @Develop        // 加入新增的注解
    QualifierAnnotations providerQualifierAnnotationsDevelop() {
        return new QualifierAnnotations("develop");
    }

    @Provides
    @Release        // 加入新增的注解
    QualifierAnnotations providerQualifierAnnotationsRelease() {
        return new QualifierAnnotations("release");
    }
}

在Activity中获取对象:

public class QualifierAnnotationsActivity extends AppCompatActivity {

    @Develop
    @Inject
    QualifierAnnotations mQualifierAnnotationsDevelop;

    @Release
    @Inject
    QualifierAnnotations mQualifierAnnotationsRelease;

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

        DaggerQualifierAnnotationsComponent.create().inject(this);

        mQualifierAnnotationsDevelop.log();
        mQualifierAnnotationsRelease.log();

    }
}

打印一下结果:


打印结果

细心的大家会发现其实@Qualifier注解和@Named注解很相像,@Named的内部实现就是通过@Qualifier注解,所以一般的我们通过@Named注解就可以实现上述操作啦,了解@Qualifier的目的是为了在自定义注解的时候使用。

来看一下@Named的源码:

@Qualifier          // @Qualifier注解哦
@Documented
@Retention(RUNTIME)
public @interface Named {

    /** The name. */
    String value() default "";
}

这下是不是理清楚它们之间的关系啦,接下来在讲解Component部分之前先来温故一下常用的那些Module部分的部分注解吧。

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

推荐阅读更多精彩内容