Dagger2 in Android（四）.android 扩展库

问题

在之前我们讨论过，Dagger 在 Android 上普遍的结构是：定义一个全局的 AppComponent，其他组件依赖或继承它。假设现在有 AppComponent 与 ActivityComponent 两个，他们可能是这样编写的：

@Module(subcomponents = [ActivityComponent::class])
class AppModule(val context: Context) {

    @Provides
    @Singleton
    fun provideContext() = context
}

@Component(modules = [AppModule::class])
@Singleton
interface AppComponent {
    fun inject(app: MyApplication)
    
    fun activityComponent(): ActivityComponent.Builder
}

@Module
class ActivityModule {
    @Provides
    fun provideSp(context: Context) =
            context.getSharedPreferences("Cooker", Context.MODE_PRIVATE)
}

@SubComponent(modules = [ActivityModule::class])
interface ActivityComponent {
    
    fun inject(activity: MainActivity)

    @Subcomponent.Builder
    interface Builder {
        fun build(): ActivityComponent
    }
}

上面定义了这两个 Component 并且他们是包含关系。然后我们必须在 Appliction 中实例化 AppComponent 来保证单例：

class MyApplication: Application {
    lateinit var component: AppComponent
    override fun onCreate() {
        super.onCreate();
        component = DaggerAppComponent.builder().appModule(AppModule(this)).build();
    }
}

最后如果要在 Activity 中使用注入我们得这样写：

class MainAty : AppCompatActivity() {
    @Inject
    lateinit var sp: SharedPreferences

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        (application as MyApplication).component
            .activityComponent()
            .build()
            .inject(this)
}

这种做法有下面两个问题：

• 每个 Activity 都必须创建一个 Component 实例。这些代码是重复的，会被复制粘贴到很多 Activity。这将很难重构，而且随着时间的推移，甚至都没人知道这段代码究竟是干什么的，成为传说中的「祖传代码」。
• Activity 必须知道它所需的 Component 类型，这有悖于原则：被注入的类不应该关心依赖注入的细节。

解决

本节主要来源于 Dagger 官方文档。

Dagger.android 是一个 Dagger 扩展库，用于解决上面问题，让 Dagger 在 Android 上面的使用更加顺畅。要使用 Dagger.android，首先需要引入，在第一节已经讨论过这个问题了，需要额外依赖下面三个东西：

implementation "com.google.dagger:dagger-android:$dagger_version"
implementation "com.google.dagger:dagger-android-support:$dagger_version"
kapt "com.google.dagger:dagger-android-processor:$dagger_version"

这里以向 MainActivity 中注入对象为例，看看 .android 扩展库如何简化使用。

1. 首先需要在 AppComponent 中安装扩展库提供的 AndroidInjectionModule，这个 Module 提供了对 Android 系统组件的创建支持。例如 Activity、Fragment 等。

@Component(modules = [AppModule::class, AndroidInjectionModule::class]) // 注意这行
@Singleton
interface AppComponent {

    fun activityComponent(): ActivityComponent.Builder
}

2. 让 Activity 所需的子 Component 实现 AndroidInjector 接口。并且其 Builder 继承 AndroidInjector.Factory。（Builder 已经被标注为弃用）

@SubComponent(modules = [ActivityModule::class])
interface ActivityComponent : AndroidInjector {

    @Subcomponent.Factory
    interface Factory : AndroidInjector.Factory {} // 注意这里不用再写 build() 方法了
}

3. 新创建一个 Module，来绑定 Subcomponent 的 Factory，并把它添加到 AppComponent 中。

@Module(subcomponents = [ActivityComponent::class])
abstract class ActivityBindModule {
    @Binds
    @IntoMap
    @ClassKey(MainAty::class)
    abstract fun bindMainAtyInjectorFactory(
        factory: ActivityComponent.Factory): AndroidInjector.Factory<*>
}

@Component(modules = [AppModule::class, AndroidInjectionModule::class, ActivityBindModule::class]) // 注意这行
@Singleton
interface AppComponent {

    fun activityComponent(): ActivityComponent.Builder
}

提示：

如果子 Component 以及其 Factory(Builder) 没有其他函数，或继承除了步骤2所提到的之外的类，那么可以用注解 @ContributesAndroidInjector 来简化#2#3两步。

只需在 Module 里添加一个抽象方法，返回对应的 Activity 类型，然后用 @ContributesAndroidInjector 来注解它，并指定要加入子 Component 的模块。如果子 Component 拥有 Scope，那么将对应的 Scope 注解也应用到这个抽象方法。

@Module(subcomponents = [LocalWatchFaceComponent::class])
abstract class ActivityBindModule {

    @ActivityScope
    @ContributesAndroidInjector(modules = [ActivityModule::class])
    abstract fun activityInjector(): MainAty
}

// 别忘记加入 AppComponent 当中了

提示：

如有多个 Activity 可以写入同一个 Bind 抽象类中，没必要分别写一个。

4. 让 Application 类实现 HasActivityInjector 接口，并且注入一个 DispatchingAndroidInjector 类型的依赖作为 activityInjector() 函数的返回值。

class MyApplication: Application, HasActivityInjector {
    @Inject
    lateinit var dispatchingActivityInjector: DispatchingAndroidInjector
    
    override fun activityInjector() = dispatchingActivityInjector
    
    lateinit var component: AppComponent
    override fun onCreate() {
        super.onCreate();
        component = DaggerAppComponent.builder().appModule(AppModule(this)).build();
    }
}

5. 最后在 Activity 的 onCreate() 方法中，super.onCreate() 之前，调用 AndroidInjection.inject(this) 即可。

class MainAty : AppCompatActivity() {
    @Inject
    lateinit var sp: SharedPreferences

    override fun onCreate(savedInstanceState: Bundle?) {
        AndroidInjection.inject(this) // <----
        super.onCreate(savedInstanceState)
}

这样 Activity 中的注入被大大简化了，而且 Activity 不再需要知道 Component 的细节。