如何在 Dagger 2 中高效提供 Android 上下文？

Android

2024-03-15 03:38:00

Dagger 2 中提供上下文的最佳实践

问题：Dagger 中的 ContextModule

在 Dagger 中使用模块进行依赖注入时，有时需要向模块提供 Android 上下文。然而，这可能会导致 "Missing setters for required modules" 异常，阻碍我们正确注入上下文。

解决方案：分步指南

为了解决此问题，我们需要遵循以下步骤：

创建 ContextModule： 创建一个 Dagger 模块来提供上下文。该模块应该有一个接受 Android 上下文作为参数的构造函数，并提供一个返回上下文的函数。
将 ContextModule 添加到 AppComponent： 在 AppComponent 中添加 ContextModule，使其成为依赖注入图的一部分。
在 AppController 中创建 AppComponent： 在 AppController 的 onCreate() 方法中创建 AppComponent，并使用 ContextModule 实例对其进行配置。
在需要的模块中注入上下文： 在需要上下文的模块中，使用 @Inject 注释一个构造函数参数以注入上下文。

示例代码

以下示例代码展示了如何实现每个步骤：

ContextModule.kt

class ContextModule(val context: Context) {
    @Provides
    fun context(): Context {
        return context
    }
}

AppComponent.kt

@Component(modules = [
    ApiModule::class,
    ViewModelModule::class,
    AndroidSupportInjectionModule::class,
    ContextModule::class
])
interface AppComponent {
    ...
}

AppController.kt

class AppController : Application() {
    ...
    override fun onCreate() {
        super.onCreate()
        DaggerAppComponent.Builder()
            .application(this)
            ...
            .contextModule(ContextModule(this))
            .build()
            .inject(this)
    }
    ...
}