Dagger 2 ContributesAndroidInjector 为模块提供活动

Question

我正在尝试找出一种更少样板的方式来实现在我的所有应用程序活动中使用的ActivityModule。这是我目前的设置：

ActivityModule：

@Module
class ActivityModule(private val activity: Activity) {

    @Provides @ActivityScope
    fun providesActivity(): Activity = activity

    @Provides @ActivityContext @ActivityScope
    fun providesContext(): Context = activity

    @Provides @ActivityContext @ActivityScope
    fun providesLayoutInflater(): LayoutInflater = activity.layoutInflater

    @Provides @ActivityContext @ActivityScope
    fun providesResources(): Resources = activity.resources

}

AppActivityModule（为 AndroidInjectionModule 提供活动）

@Module(subcomponents = [
        AppActivityModule.WelcomeActivityComponent::class
    ])
    internal abstract class AppActivityModule {

        @Binds 
        @IntoMap 
        @ActivityKey(WelcomeActivity::class)
        abstract fun bindWelcomeActivityInjectorFactory(builder: WelcomeActivityComponent.Builder): AndroidInjector.Factory<out Activity>

        @ActivityScope
        @Subcomponent(modules = [(ActivityModule::class)])
        interface WelcomeActivityComponent : AndroidInjector<WelcomeActivity> {
        @Subcomponent.Builder abstract class Builder : AndroidInjector.Builder<WelcomeActivity>() {
            abstract fun activityModule(myActivityModule: ActivityModule): AndroidInjector.Builder<WelcomeActivity>

            override fun seedInstance(instance: WelcomeActivity) {
                activityModule(ActivityModule(instance))
            }
        }
    }
}

我希望 AppActivityModule 改为：

@Module
internal abstract class AppActivityModule {
    @ContributesAndroidInjector(modules = [(ActivityModule::class)])
    abstract fun contributeWelcomeActivityInjector(): WelcomeActivity
}

但是，很容易理解，这给了我一个错误/di/AppActivityModule_ContributeWelcomeActivityInjector.java:29: error: @Subcomponent.Builder is missing setters for required modules or subcomponents: [...di.modules.ActivityModule]

我的问题是 - 有没有更少样板的方式来实现我想要做的事情？我知道@Bind 和@BindsInstance（来自this answer），但这似乎只有在我有一个模块-每个活动并绑定我在这种情况下不想要的具体活动类型时才有效 - 我想要@987654329 @ 处理所有活动。

Answer 1

最小化样板文件的一种方法是制作一个通用的 ActivityModule，然后为每个 Activity 创建一个小的特定模块。

// Abstract class so you don't have to provide an instance
@Module
abstract class ActivityModule {

    // No need for ActivityScope: You're always binding to the same Activity, so
    // there's no reason to have Dagger save your Context instance in a Provider.
    @Binds @ActivityContext
    abstract fun providesContext(activity: Activity): Context

    // This doesn't *have* to be in a companion object, but that way
    // Android can do a static dispatch instead of a virtual method dispatch.
    // If you don't need that, just skip the constructor arguments and make these
    // normal methods and you'll be good to go.
    companion object {
        @Provides @ActivityContext
        fun providesLayoutInflater(activity: Activity): LayoutInflater = 
            activity.layoutInflater

        @Provides @ActivityContext
        fun providesResources(activity: Activity): Resources = activity.resources
    }
}

（在 2.26 之前的 Dagger 版本中，您可能需要在伴随对象上添加 @Module 并在 @Provides 方法上添加 @JvmStatic，如 this previous revision 中一样。由于 Dagger 2.26 在 2020 年 1 月，这些都不是必需的。谢谢阿雷科莱克！）

还有你的模块：

@Module
internal abstract class AppActivityModule {

    @Module
    internal interface WelcomeActivityModule {
      // The component that @ContributesAndroidInjector generates will bind
      // your WelcomeActivity, but not your Activity. So just connect the two,
      // and suddenly you'll have access via injections of Activity.
      @Binds fun bindWelcomeActivity(activity: WelcomeActivity) : Activity
    }

    @ContributesAndroidInjector(
        modules = [ActivityModule::class, WelcomeActivityModule::class])
    abstract fun contributeWelcomeActivityInjector(): WelcomeActivity
}

请注意，尽管这适用于 Activity、Service、BroadcastReceiver 等，但对于 Fragment，您可能不想这么快。这是因为 dagger.android 处理带有父片段的片段层次结构，因此在子组件中，您可能可以访问 YourApplication、YourActivity、YourParentFragment 和 YourChildFragment 以及它们的所有组件。如果 YourChildFragmentComponent 中的某些内容依赖于不合格的 Fragment，那么它是否真的需要 YourParentFragment 或 YourChildFragment 将是模棱两可的。也就是说，这种设计确实对活动和某些片段有意义，因此使用它是有意义的（谨慎）。

---

编辑：@ActivityContext 在这里做什么？

@ActivityContext这里是你定义的qualifier annotation，你可以用它来区分Dagger和其他DI框架中相同类型的绑定，大概是@ApplicationContext Context和@ActivityContext Context。将其排除在外尝试它会起作用，但我强烈建议保留它并避免绑定不合格的上下文：应用程序和活动上下文可能不同，特别是在多屏或自动环境中，并为您获取正确的资源和数据应该准确说明您使用的是哪个。可以以this one 为例。