关于Dagger2
- Dagger基础用法
- 对注解的分类讲解——Inject部分
- 对注解的分类讲解——Module部分（一）
- 对注解的分类讲解——Component部分
- 对注解的分类讲解——Module（二）
- 对注解的分类讲解——Module（三）
- 对Dagger中几个类的说明
- Dagger-Android的使用
前言
本文将通过对注解的分类讲解来交代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部分的部分注解吧。