依赖注入:
当一个类的实例需要另一个类的实例协助时,在传统的程序设计过程中,通常有调用者来创建被调用者的实例。然而采用依赖注入的方式,创建被调用者的工作不再由调用者来完成,因此叫控制反转,创建被调用者的实例的工作由IOC容器来完成,然后注入调用者,因此也称为依赖注入。依赖注入是为了 降低耦合性,即降低耦合就是降低类和类之间依赖关系。
Dagger2用到的依赖注入的标识:
- @Inject: 在需要依赖的地方使用这个注解。这样,Dagger2就会构造一个这个类的实例并满足他们的依赖。
- @Module: Modules类里面的方法专门提供依赖,因此当定义一个类,用@Module注解,这样Dagger2在构造类的实例的时候,就知道从哪里去找到需要的 依赖。
- @Component: 用来为“被注入方“提供其所需要的注入类。是@Inject和@Module的桥梁,它的主要作用就是连接这两个部分。Components接口提供了所有定义的类型的实例。
- @Provide: 在Modules类中,我们定义的方法是用这个注解,以此来告诉Dagger2我们想要构造对象并提供这些依赖。
- @Scope: Dagger2可以通过自定义注解限定注解作用域。
- Qualifier: 当类的类型不足以鉴别一个依赖的时候,我们就可以使用这个注解标示。
- @Singleton: 当前提供的对象将是单例模式 ,一般配合@Provides
一起出现。
使用Dagger 2
- 由于 Dagger 使用 apt 生成代码,因此添加apt插件
dependencies {
classpath 'com.android.tools.build:gradle:2.1.2'
//添加apt插件
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
- 在build.gradle添加如下
//应用apt插件
apply plugin: 'com.neenbedankt.android-apt'
...
dependencies {
...
provided 'org.glassfish:javax.annotation:10.0-b28'
compile 'com.google.dagger:dagger:2.5'
compile 'com.google.dagger:dagger-compiler:2.5'
}
- 创建登录的LoginActivity
public class LoginActivity extends AppcompatActivity implemets ILoginView,View.OnClickListener{
private Button mLogin;
...
// 利用注解,Activity 持有了Presenter 的引用并且创建了该对象
@Inject
ILoginPresenterCompl loginPresenter;
@Override
protected void onCreate(Bundle saveInstanceState) {
...
DaggerMainComponent
.builder()
.mainModule(new MainModule(this))
.build()
.inject(this);
}
...
}
- 实现LoginPresenter接口的LoginPresenterCompl
public class LoginPresenterCompl implemets LoginPresenter{
private ILoginView mLoginView;
private User usr;
@Inject
public LoginPresenterCompl(ILoginView loginView){
this.mLoginView = loginView;
this.usr = new User("mm", "123");
}
...
}
- 创建MainModule,设置ILoginView的引用,让LoginActivity与 LoginPresenter解耦
@Module
public class MainModule {
private final ILoginView mLoginView;
public MainModule(ILoginView mLoginView){
this.mLoginView = mLoginView;
}
@Provides
ILoginView provideILoginView(){
return mLoginView;
}
}
- 创建MainComponent接口,连接MainModule与inject
@Component(modules = MainModule.class)
public interface MainCompenent{
public void inject(LoginActivity mLoginActivity );
}
分析:
LoginActivity 中需要 LoginPresenterCompl 的实例,所以在 LoginActivity 中定义了该对象并且通过 @Inject 将其注解,同时到 LoginPresenterCompl 的构造方法中也通过 @Inject 将其注解, 表明这些是需要依赖注入的。
因为在 LoginPresenterCompl 的构造方法需要 ILoginView 类型的参数,所以需要通过依赖将获取这些参数,所以就需要带有 @Module 注解的 MainModule 类用于获取需要的参数,在 @Module 注解的类中通过被 @Provides 注解的以 provide 开头的 provideILoginView 方法对外提供需要的参数,一般而言有几个参数就需要有几个带有 @Provides 的方法。
而带有 @Component 的 MainComponent 接口或抽象类就起到连接@inject 和 @Module 的桥梁的作用。注解中有一个 module 的值,这个值指向需要依赖的 Module 类,同时其中有一个抽象方法 inject(),其中的参数就是我们需要在哪个类中实例化 LoginPreserentCompl,因为我们需要在 LoginActivity 中实例化,所以参数类型就是 LoginActivity 类型。
当我们 rebuild 的一下项目,在项目的 build/generated/source/apt/debug/项目包名/dragger 目录下生成对应的包其中包含 DaggerMainComponent 类,这个类名其实不是固定的,是根据我们上面写的 MainComponent,加了 Dagger 前缀生成的 DaggerMainComponent。