Dagger2是Google基于Square公司的Dagger改造的一个依赖注入的一个框架。说到这,就想起了Java的Spring框架的三大核心Ioc(控制反转)、DI(依赖注入) 和 AOP(面向切面编程),但是Spring的话,需要xml,我们安卓的Dagger2优点还是有很大哈。可以说目前主流框架是MVP+Retrofit+RxJava+Dagger2了。
我们在编写后台代码初期,例如Dao,Service,我们通常都是使用接口,什么实现UserDao,实现UserService啊,这种方式是接口,但是这种需要编写更多的模块代码。构造注入,拓展能力又太弱鸡。为了懒,为了生产优质的代码,我们还是使用依赖注入吧
1、引入Dagger2
我使用的是Android Studio3.1.2,所以在app的build.gradle中添加依赖就行了
api 'com.google.dagger:dagger:2.4'
annotationProcessor 'com.google.dagger:dagger-compiler:2.4'
api 'org.glassfish:javax.annotation:10.0-b28'
Dagger是主要的工具库,dagger-compiler用于编译时生成相关的代码,打包的时候可以注释掉,javax.annotation是Java注解库。
2、入门Dagger2
-
创建一个Cat对象
package com.wj.daggerdemo; import android.util.Log; import dagger.Module; /** * Created by wj on 2018/5/7. */ public class Cat { public Cat() { Log.i("dagger2", "cat被创建"); } }
-
写一个Module类,管理Cat对象
package com.wj.daggerdemo; import dagger.Module; import dagger.Provides; /** * Created by wj on 2018/5/7. */ @Module public class MainModule { @Provides Cat newCat() { return new Cat(); } }
上面使用到了两个注解@Module和@Provides,@Module表示该类能够提供完成各种对象的实例化,@Provides表示该方法提供依赖对象。
-
创建沟通的桥梁,Component作为一个中介
package com.wj.daggerdemo; import dagger.Component; /** * Created by wj on 2018/5/7. */ @Component(modules = MainModule.class) public interface MainComponent { void inject(MainActivity mainActivity); }
@Component指名依赖的Module类,然后会完成调用者和依赖库之间中介的作用。此时需要ctrl+F9重新build一下项目。
- 调用
package com.wj.daggerdemo;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import javax.inject.Inject;
public class MainActivity extends AppCompatActivity {
@Inject
Cat cat;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
DaggerMainComponent
.create()
.inject(this);
}
}
@Inject声明注入的对象,创建中介者。
3、进阶Dagger2
Dagger2除了上面最基本的注解外,还有很多功能强大的注解,Dagger2我们需要理解的注解有
@Inject,@Module,@Provides,@Component,@Qulifier,@Scope,@Singleten。
@Qulifier 类似于方法的重载。一般情况下Module会根据@Provides标记的方法根据返回对象的类型返回我们需要的对象,当我们创建一个Dog类,我们需要一个BlackDog和一个YellowDog对象,那它怎么知道返回哪一个呢?
这里我们可以使用@Qulifier,通过自定义@Qulifier,告诉Dagger2去Module中找具体的依赖对象提供者。
-
创建一个Dog类
package com.wj.daggerdemo.demo2; import android.util.Log; /** * Created by wj on 2018/5/8. */ public class Dog { String name; public Dog(String name) { this.name = name; Log.i("dagger2", name + "被创建"); } }
自定义两个注解,并使用@Qualifier,通过自定义Qulifier,可以告诉Dagger2去寻找具体的依赖提供者
@Qualifier
@Retention(RetentionPolicy.RUNTIME)
public @interface ForBlack {
}
@Qualifier
@Retention(RetentionPolicy.RUNTIME)
public @interface ForYellow {
}
@Qualifier是给自定义注解注解的
- Module类
@Module
public class DogModule {
@Provides
@ForBlack
Dog createBlackDog() {
return new Dog("黑色的狗");
}
@Provides
@ForYellow
Dog createYellowDog() {
return new Dog("黄色的狗");
}
}
- 测试,DaggerMainComponent同上,只不过引入的module多添加一个DogModule
public class MainActivity extends AppCompatActivity {
@Inject
@ForYellow
Dog dog;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
DaggerMainComponent
.create()
.inject(this);
}
}
这里我们在声明对象的时候不仅需要@Inject而且还需要添加@ForYellow或者@ForBlack指明是那个对象
@Singleton是一种Scope注解,自带了Scope,使用它可以实现单例模式
-
@Singleton
@Module public class PigModule { @Singleton @Provides Pig createPig() { return new Pig(); } }
module也需要@Singleton注解
@Singleton
@Component(modules = {MainModule.class, DogModule.class, PigModule.class})
public interface MainComponent {
void inject(MainActivity mainActivity);
}
@scope比较难,这个后面再说