1.什么是dagger2
简单来说,dagger2是一个依赖注入框架,代替你生成实例,管理各种实例的依赖关系的库。
2.为什么要使用dagger2?
假设有这样一个情景,你需要一个对象A,但是对象A需要一个B才能实例化,这样好办,先实例化一个B,在实例化A的时候将B对象作为参数传进去。但是如果B需要C才能实例化,C需要D才能实例化怎么办。在实际的项目中各种实例可能存在项目的各个类当中,当需要修改带码时,你将花费不小的精力用来维护各个实例间的依赖关系,重复的new对象和对象传递将使项目离高内聚低耦合的目标越来越远。
项目小,可能还体现不出来,但是在大型项目中,通过dagger2来代替你管理各种实例的依赖关系和作用域,可以大大提高项目的可维护性。
3.如何使用dagger2?
在Android Studio中使用dagger2
在app的gradle文件中添加如下两行依赖:
dependencies {
......
compile "com.google.dagger:dagger:2.10"
annotationProcessor "com.google.dagger:dagger-compiler:2.10"
}
如果需要在其他module中使用dagger2,那么也需要添加依赖。
@Inject的使用
在你要实例化的类的构造器上添加一个@Inject注解,例如
public class User {
......
@Inject
public User() {
}
public User(String name,String avatar) {
this.name = name;
this.avatar = avatar;
}
}
在你要注入到的目标类中声明一个@Inject修饰的变量。
public class MyActivity extends AppCompatActivity {
@Inject
User user;
......
}
这样,dagger2就能通过@Inject注解关联起需要实例化的类和需要注入的变量。
仅仅这样还不够,因为dagger2不知道如何给目标类注入实例。
我们回忆一下平常是如何使用butterKnife的,首先,要在目标类中进行绑定,
ButterKnife.bind(this);
然后注解需要实例化的View,
@BindView(R.id.button)
Button button;
通过这两步,butterKnife会帮助我们对View进行实例化.
读过butterKnife源码的同学肯定知道,butterKnife是通过注解处理器,生成一个代理类(代理findViewById),在代理类中通过传入的this进行this.view = findViewById动作对控件进行初始化的。
this.button= findViewById(R.id.button);
所以dagger2也不例外,需要生成一个代理类,再通过this.变量 = 实例化对象,来为变量赋值。
this.变量 = 实例化对象
这时,dagger2需要一个桥梁,一个类似butterKnife的绑定动作来连接目标类和实例化对象,然后对注解变量进行注入。
Component,就是这个扮演将对象注入到目标类中的角色。
@Component的使用
@Component
public interface UserComponent {
void inject(MyActivity activity);
}
声明一个接口或者抽象类,使用@Component注解,里面定义一个注入方法,参数为目标类。注解处理器最终会生成一个名为Dagger+component类名的代理类,调用代理类的inject方法,对目标类进行实例注入。
这里请注意,代理类需要rebuild才能被创建出来。
public class MyActivity extends AppCompatActivity {
@Inject
User user;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_my);
DaggerUserComponent.builder().build().inject(this);
}
}
这样就完成了一次实例注入的过程。
我们思考一下,如果有多个构造器都进行了注解,dagger2如何分辨是要通过哪个构造器实例化对象进行注入?
或者项目中引用到了第三方库,不能通过修改进行注解操作(如果是修改源码进行注解,是不是违背了这个框架的初衷)。
这个时候就要用到module了。
@Module和@provides的使用
创建一个用来生成对象的简单工厂类,使用@Module来注解这个类,创建一个方法,方法使用@provides注解,表明这是一个可以注入的实例,返回值为你要注入的实例化对象。
@Module
public class UserModule {
......
@Provides
User provideUser(){
return new User();
}
}
权限修饰符不能使用private,这很容易理解,注解处理器生成的代理类将会调用Module的创建实例方法获得实例,如果权限为private,此方法将不能在module外部调用,建议一律使用public,方便。
然后再为Component指明实例提供模块。
@Component(modules = {UserModule.class})
public interface UserComponent {
void inject(MyActivity activity);
}
修改注入代码
public class MyActivity extends AppCompatActivity {
@Inject
User user;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_my);
DaggerUserComponent.builder().userModule(new UserModule()).build().inject(this);
Log.i("-->>", "onCreate: " + user);
}
}
可以看出,DaggerUserComponent类使用了建造者模式,通过内部类builder来组装各个Module,通过inject来将实例注入给目标类。
这样,不管是多个构造器,还是第三方库的类,我们都可以注入其实例了。
Component依赖和@Subcomponent的使用
Compnent的实例提供模块除了可以是Module,还可以是其他Compnent。
@Component(dependencies = {UserComponent.class},modules = {ActivityModule.class})
public interface ActivityComponent {
void inject(MyActivity activity);
}
Component会获得被依赖Component中主动暴露出来的实例对象,不能获得未被暴露的实例对象。
@Component(modules = {UserModule.class})
public interface UserComponent {
void inject(MyActivity activity);
//Component通过方法返回值主动暴露实例
User getUser();
}
User对象就是被依赖Component主动暴露出的实例对象。
ActivityComponent 如果想直接获取父Component中的全部实例对象,那就必须使用@Subcomponent注解,
@Subcomponent(modules = {ActivityModule.class})
public interface ActivityComponent {
void inject(MyActivity activity);
}
将Subcomponent作为返回值声明在父Component中
@Component(modules = {UserModule.class})
public interface UserComponent {
void inject(MyActivity activity);
//当前Component主动暴露的实例对象
//User getUser();
//将Subcomponent作为返回值声明在父Component中
ActivityComponent getActivityComponent();
}
被@Subcomponent注解的接口或者抽象类,只能作为返回值声明在父Component中,不会直接生成类似DaggerUserComponent可以直接注入的代理类,只能通过父Component来获得Subcomponent对象。
public class MyActivity extends AppCompatActivity {
@Inject
User user;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_my);
// DaggerUserComponent.builder().userModule(new UserModule()).build().inject(this);
//需要通过父Component来获得Subcomponent对象
ActivityComponent activityComponent = DaggerUserComponent.builder()
.userModule(new UserModule()).build().plus();
activityComponent.inject(this);
Log.i("-->>", "onCreate: " + user);
}
}
@Scope的使用
实际项目中,有时候我们需要在不同的类中,使用同一个实例,这样的话,仅仅依靠上面这些注解还不能做到。
这时,我们需要用到@Scope注解。
Scope,就是范围的意思,这里引申为作用域,在dagger2中,注入是以component为单位的,相同component注入不同的目标类,如果有scope标识,那么注入的都会是同一个对象的,而不会额外再生成实例。
先自定义一个Scope
@Scope
@Retention(RetentionPolicy.RUNTIME)
public @interface UserScope {
}
首先,在component上添加这个注解
@UserScope
@Component(modules = {UserModule.class})
public interface UserComponent {
void inject(MyActivity activity);
}
然后,在module的方法上添加注解
@Module
public class UserModule {
//提供实例的方法必须使用@Provides注解
@Provides
@UserScope
protected User provideUser() {
return new User();
}
}
注入目标类
public class MyActivity extends AppCompatActivity {
@Inject
User user;
@Inject
User lastUser;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_my);
DaggerUserComponent.builder().userModule(new UserModule()).build().inject(this);
// Activity2Component activity2Component = DaggerUser2Component.builder()
// .userModule(new UserModule()).build().plus();
// activity2Component.inject(this);
Log.i("-->>", "user: " + user);
Log.i("-->>", "lastUser: " + lastUser );
}
}
运行项目可以看到两个变量的地址一样,这说明注入的是同一个对象的实例。
这里需要注意的是,每个Component最好使用不同的作用域注解,这也很好理解,不同的,与自定义Scope不同,自带的@Singleton只能作为最上层Component的作用域标识。
可以理解为@scope只是一个tag,拥有这个tag的实例在整个Component注入的目标类中是单例的。
Component类就像一个将军,实例对象是他手下的兵,如果将军下达了scope命令,那么每次去完成注入任务的都是同一个兵,如果没有scope命令,那么每次去的都是不一样的新兵。
总的来说,scope的作用就是用来保证实例在Component范围内单例的。
实战模拟
在项目中有个一个User 类,需要在三个不同activity中保证都是同一个实例对象,我们可以将User 对象单独使用一个component进行管理,然后每个activity用一个子component来进行管理,这样,既可以保证三个activity都能使用同一个user对象,而且也不影响三个页面私有实例的使用。
最后
写了这么多,也不知道有没有用,希望能对大家有所帮助。
感谢
Android:dagger2让你爱不释手-终结篇 - 简书
//www.greatytc.com/p/65737ac39c44
dagger 2 详解 - 简书
//www.greatytc.com/p/269c3f70ec1e
Dagger2从入门到放弃再到恍然大悟 - 简书
//www.greatytc.com/p/39d1df6c877d