Dagger2 系列(三)Dagger2.Android使用详解

前言

前两篇文章我们介绍了dagger2的使用和基本原理,为了适用于android项目代码特点,更简洁的实现四大组件和Fragment的注入,dagger2团队为我们又进一步的封装,也就是我们要介绍的dagger2.android。对dagger2原理和使用不了解的朋友先移步看前两篇文章。

dagger2.android 产生的意义

上篇文章讲到了component的继承和依赖实现方式,在实际android项目的应用中,一个app对应多个activity,然后一个activity对应多个fragment。相应的activityComponent继承自appComponent,然后在acitivity中实现注入代码如下:

private void initInjector() {
      mComponent = getAppComponent()
          .mainActivityComponent()
          .activity(this)
          .build();
}

存在两个问题:

  • 上面模板码要在每个activitty重复出现。
  • 关键问题:上面模板代码中需要调用component里定义好的方法实现activity的注入,这违背了dagger设计思想,注入对象不应该关心注入过程。

dagger2.android 的产生可以解决以上两个问题。我们先看dagger2.android 如何使用,通过具体使用看看是怎么达到上面说的目的。

dagger2.android 使用详解

在dagger2的配置的基础上,添加:

compile 'com.google.dagger:dagger-android:2.11‘
compile 'com.google.dagger:dagger-android-support:2.11' 
annotationProcessor 'com.google.dagger:dagger-android-processor:2.11

代码中具体使用,无非就是对appComponent和继承他的subcomponent以及对应的module进行改造,我们分别看下具体代码:

component的改造
@Component(modules = {
        AndroidInjectionModule.class,
        AndroidSupportInjectionModule.class,
        AppModule.class,
        MainActivityModule.class,
})
public interface MyAppComponent {
    void inject(MyApplication application);
}

相对dagger2的代码修改:

  • Component中添加了 AndroidInjectionModule 和 AndroidSupportInjectionModule,这是两个dagger2.android的源码类,分别用来支持android四大组件和support包里fragment的注入使用的。
  • 声明注入方法inject,参数类型为Application
subComponent的改造

以activityComponent为例:

@Subcomponent(modules = {
        AndroidInjectionModule.class,
        MainActivitySubcomponent.SubModule.class
})
public interface MainActivitySubcomponent extends AndroidInjector<MainActivity> {

    @Subcomponent.Builder
    abstract class Builder extends AndroidInjector.Builder<MainActivity> {
    }

    @Module
    class SubModule {

        @Provides
        String provideName() {
            return MainActivity.class.getName();
        }
    }

相对dagger2的代码修改:

  • subComponent继承AndroidInjector<对应Activity >。
  • 其Builder继承AndroidInjector.Builder<对应Activity>。
subcomponent以及对应的module改造

以MainActivityModule为例:

@Module(subcomponents = MainActivitySubcomponent.class)
public abstract class MainActivityModule {

    @Binds
    @IntoMap
    @ActivityKey(MainActivity.class)
    abstract AndroidInjector.Factory<? extends Activity>
    bindMainActivityInjectorFactory(MainActivitySubcomponent.Builder builder);

}

相对dagger2的代码修改:

  • 这是一个新的接口module类,是用来绑定components 和subcomponents 的继承关系的。可以简单理解替代了之前继承 dependencies = AppComponent.class的写法。

相关配置代码如上,有人会想为什么要这么写,其实没有原因,就是dagger2.android框架定义的规范。必须按其规范编写,dagger2.android才会给你生成对应的注入代码。

调用注入代码

在调用activity的注入之前我们先要修改Application

public class MyApplication extends Application implements HasActivityInjector {

    @Inject
    DispatchingAndroidInjector<Activity> dispatchingAndroidInjector;

    @Override
    public void onCreate() {
        super.onCreate();
        DaggerMyAppComponent.create().inject(this);
    }
    @Override
    public AndroidInjector<Activity> activityInjector() {
        return dispatchingAndroidInjector;
    }
}
}

相对dagger2的代码修改:

  • 实现了 HasActivityInjector 以及对应的方法activityInjector()返回DispatchingAndroidInjector<Activity> ;
  • 调用 DaggerMyAppComponent.create().inject(this);

activity的注入代码:

@Override
protected void onCreate(@Nullable Bundle  savedInstanceState) {
        AndroidInjection.inject(this);
        super.onCreate(savedInstanceState);
 }

相对dagger2的代码修改:

  • 文章一开始我们讲到的注入代码,变成了一行 AndroidInjection.inject(this)。

这一行代码完全可以放在基类acitivity调用,这样就解决了我们说的两个问题。其他组件以及fragment同理都可以实现注入。

更精简的代码实现

问题来了,为了解决上面问题,又写了好多模板代码,如果项目acitivity多了会出现下面问题:

  • 大量的ActivityBindModule。类似上面的MainActivityModule 。
  • 大量的Subcomponent,类似上面的MainActivitySubcomponent 。
  • 越来越庞大的AppComponent ,注解会很长、很长。

所以有一种更精简的写法,还是来看component,Subcomponent,module三个类怎么修改的。
component,标注一个公共的activityModule,比如下面的AllActivitysModule。

@Component(modules = {
        AndroidInjectionModule.class,
        AndroidSupportInjectionModule.class,
        AllActivitysModule.class
})
public interface MyAppComponent {
    void inject(MyApplication application);
}

Subcomponent省略不用写,因为是模板代码,完全可以自动生成。
module改造是关键地方,看代码:

@Module
public abstract class AllActivitysModule {

    @ActivityScope
    @ContributesAndroidInjector(modules = MainActivityModule.class)
    abstract MainActivity contributeMainActivitytInjector();

    @ContributesAndroidInjector(modules = SecondActivityModule.class)
    abstract SecondActivity contributeSecondActivityInjector();

}

这样一个component和一个module即实现了activity的注入,简洁了很多。

至此dagger2.android的使用讲解完了,都是需要按照dagger2.android的规范实现,如果要将dagger2.android应用到实际项目中,需要熟悉dagger2.android的使用规范,了解其实现原理,使用不当会出现一些异常问题。如何使用讲解完,我们下篇来讲实现原理。

推荐阅读更多精彩内容