概述:基本的使用说明,附带详细的代码展示。按照流程自己操作一遍,使用肯定是没有问题的。
一 框架引入
- 在Module层级下的build.gradle中添加:
implementation"com.google.dagger:dagger:2.19"
annotationProcessor"com.google.dagger:dagger-compiler:2.19"
二 如何使用
需求:将Student类注入到MainActivity中
- 创建Student
public class Student {
@Inject
public Student() {
}
}
在Student的构造器上加入@Inject注解,这个注解表示,Student对象可以由Dagger2生成。
2.在MainActivity中使用
public class MainActivity extends AppCompatActivity {
@Inject
Student student;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
}
}
此时如果去打印student 对象会发现,对象为null,因为此时还缺少中间件MainComponent(注入器)。
第一步相当于告诉Dagger2由它来生成对象,第二步相当于告诉Dagger2, MainActivity需要引用这个Student
对象。但是没有中间件把生成的对象和需要引入的对象关联起来,而这个MainComponent(注入器)就是用来将两者关联起来,代码如下:
@Component
public interface MainComponent {
void inject(MainActivity activity);
}
然后进行编译下(Ctrl+F9),最后将这几行代码加入到MainActivity中:
public class MainActivity extends AppCompatActivity {
@Inject
Student student;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
DaggerMainComponent
.builder()
.build()
.inject(this);
}
}
相当于是将student生成的对象,注入到MainActivity中。
为了验证Student对象已经生成,加入以下代码,看引入的Student是否为空:
public class MainActivity extends AppCompatActivity {
@Inject
Student student;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
DaggerMainComponent
.builder()
.build()
.inject(this);
Log.d("student",student.toString());
}
}
可以看到控制台中,student已经被打印出来
D/student: com.example.learndragger.Student@26af1869
三 如果引用的类库无法更改怎么处理?
- Student类是我们自己创建的,我们可以在它的构造器上面加入@Inject注解,但是如果引入三方类库或者干脆是系统类,这些类库我们无法更改。该怎么注入对象。此时需要Dagger2提供的Module注解。
@Module
public class MainModule {
@Provides
static Student provideStudent(){
return new Student();
}
}
可以这么理解,MainModule类是一个模块,它里面的被@Provides注解的方法,可以提供需要的对象。也就是说在构造器上面加@Inject注解等价于在Module类的方法上面加@Provides注解。都表示,由Dagger2来生成目标类需要的对象。
此时我们可以把Student构造器的注解去掉
public class Student {
public Student() {
}
}
同时,得稍微改动下注入器
@Component(modules = MainModule.class)
public interface MainComponent {
void inject(MainActivity activity);
}
在@Component后面加上(modules = MainModule.class)。
意思是,需要把MainModule模块里面提供的对象,注入到MainActivity中。
最后我们再次运行程序,去打印Student对象,看是否为空。
结果:
D/student: com.example.learndragger.Student@26af1869
总结
Dagger2主要由三部分构成:
1.第一部分是用来提供对象,可以通过在构造器上加上@Inject注解或者通过@Module模块来提供需要的对象。
2.第二部分是在目标类中通过@Inject注解进行引用。
3.第三部分是通过@Component(注入器),来将提供的对象注入到目标类中。