前面两篇：
Dagger2 使用总结（一）
Dagger2 使用总结（二）
主要针对Dagger2的基础库进行了简单的总结，这一篇会重点讲述Dagger2的Android支持库，它对Android组件进行了定制，使代码更加简洁。
简单用例
场景：向MainActivity中注入MainPresenter对象
- 导入相关库
implementation "com.google.dagger:dagger:2.11"
implementation "com.google.dagger:dagger-android:2.11"
implementation "com.google.dagger:dagger-android-support:2.11"
annotationProcessor "com.google.dagger:dagger-compiler:2.11"
annotationProcessor "com.google.dagger:dagger-android-processor:2.11"
MainPresenter类
public class MainPresenter {
@Inject //构造器注入
public MainPresenter() {
}
public void print() {
Log.d(TAG, "This is a MainPresenter");
}
}
- 核心代码
public class AppApplication extends DaggerApplication implements HasSupportFragmentInjector {
@Inject
DispatchingAndroidInjector<Fragment> fragmentSupportInjector;
@Override
protected AndroidInjector<? extends DaggerApplication> applicationInjector() {
return DaggerAppComponent.create();
}
@Override
public AndroidInjector<Fragment> supportFragmentInjector() {
return fragmentSupportInjector;
}
}
DaggerApplication来源于支持库且有两个：
dagger.android.DaggerApplication：支持普通组件，不支持扩展（v4，v7）组件
dagger.android.supportDaggerApplication：支持扩展组件，不支持普通组件
如果项目中需要支持两种类型的组件，可以采用上述代码中的形式，即：
继承dagger.android.DaggerApplication并实现HasSupportFragmentInjector接口。
@Component (modules = {
ActivityModule.class, // 用于绑定项目中的Activity
AndroidSupportInjectionModule.class, // 用于绑定扩展的组件，如v4
AndroidInjectionModule.class}) // 用于绑定普通的组件
public interface AppComponent extends AndroidInjector<AppApplication>{
}
// 注意这里用的是抽象类和抽象方法
@Module
public abstract class ActivityModule {
@ContributesAndroidInjector
abstract MainActivity mainActivity(); // 绑定MainActivity
}
这里写ActivityModule类只为了逻辑清晰，也可以将其内部实现直接写到AppComponent中。
以上代码是该例实现的重点，先不急去理解，因为其更像是模板化的代码，先知其然，再慢慢知其所以然。
现在我们已经实现了将MainActivity绑定到框架中，下面看一下怎么注入对象。
- 在
MainActivity中注入MainPresenter
public class MainActivity extends DaggerAppCompatActivity { // 继承定制的Dagger组件
@Inject //现在只要简单的声明即可注入
MainPresenter mainPresenter;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mainPresenter.print();
}
}
- 小结
可以这样理解，我们先用应用的AppApplication和AppComponent类搭好一个依赖注入的框架，而需要注入对象的组件，通过声明和继承绑定到框架中，即可注入对象。相比于普通的Dagger2使用，我们省略了以下步骤：
@Component
interface MainActivityComponent {
void inject(MainActivity activity);
}
...
DaggerMainActivity_MainActivityComponent.builder().build().inject(this);
@Binds
类似于@Provides，在使用接口声明时使用，区别是@Binds用于修饰抽象类中的抽象方法的，看下实例吧。
场景：将MainPresenter注入到MainActivity中
Presenter接口和MainPresenter
public interface Presenter {
void print();
}
public class MainPresenter implements Presenter {
@Inject // 构造器注入
public MainPresenter() {
}
@Override
public void print() {
Log.d(TAG, "This is MainPresenter");
}
}
- 添加一个
MainModule类来统一管理
// 注意也要用抽象类和抽象方法
@Module
public abstract class MainMoudle {
// 这个方法必须返回接口或抽象类，比如Presenter，不能直接返回MainPresenter
// 方法的参数就是这个方法返回的是注入的对象，类似@Provides修饰的方法返回的对象
// 这里的MainPresenter会通过上述声明的构造器注入自动构建
@Binds
abstract Presenter mainPresenter(MainPresenter mainPresenter);
}
@Component (modules = {
ActivityModule.class, // AppComponent这里要加上ActivityModule
AndroidSupportInjectionModule.class,
AndroidInjectionModule.class})
public interface AppComponent extends AndroidInjector<AppApplication>{
}
- 在
MainActivity中自动注入对象
public class MainActivity extends DaggerAppCompatActivity {
@Inject // 属性注入即可，声明的是接口
Presenter mainPresenter;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mainPresenter.print();
}
}
- 小结
将上述的
@Binds
abstract Presenter mainPresenter(MainPresenter mainPresenter);
换成
@Provides
static Presenter mainPresenter(MainPresenter mainPresenter) {
return new mainPresenter();
}
也是可以的，使用@Binds相比@Provides的好处是，更有效率。
- 扩展
要给MainPresenter加两个int参数id，type：
// 修改MainMoudle，使用@Provides提供注入，@Qualifier区分两个参数
public abstract class MainMoudle {
@Qualifier
@Retention(RetentionPolicy.RUNTIME)
public @interface MainPresenterId{}
@Qualifier
@Retention(RetentionPolicy.RUNTIME)
public @interface MainPresenterType{}
@Provides
@MainPresenterId
static int getMainPresenterId() { // 注意是静态方法
return 100; // 这里就简单返回int值
}
@Provides
@MainPresenterType
static int getMainPresenterType() {
return 200;
}
@Binds
abstract Presenter mainPresenter(MainPresenter mainPresenter);
}
public class MainPresenter implements Presenter {
private int id;
private int type;
//参数对应之前的@Qualifier声明的注解
@Inject
public MainPresenter(@MainMoudle.MainPresenterId int id, @MainMoudle.MainPresenterType int type) {
this.id = id;
this.type = type;
}
@Override
public void print() {
Log.d(TAG, "This is MainPresenter id = " + id
+ " type = " + type);
}
}
