具有不同范围模块的 Dagger 2 组件

Question

上下文

我有两个 Dagger 2 模块：

1. NetworkModule，具有 @Singleton 范围，提供 HTTP 客户端；
2. ApiModule，具有自定义 @UserScope 范围，使用 HTTP 客户端为 Github 的 API 创建使用者。

然后，我创建一个 Dagger 2 组件，以提供 Retrofit 客户端。

NetworkModule.kt

@Module
class NetworkModule {
    @Provides
    @Singleton
    fun provideHttpClient(): OkHttpClient = OkHttpClient.Builder().build()
}

ApiModule.kt

@Module(includes = [NetworkModule::class])
class ApiModule(private val user: String) {

    @Provides
    @UserScope
    fun provideApi(httpClient: OkHttpClient): GithubApi = Retrofit.Builder()
            .baseUrl("https://api.github.com/")
            .client(httpClient)
            .build()
            .create(GithubApi::class.java)
}

ApiComponent.kt

@Component(modules = [ApiModule::class])
@UserScope
interface ApiComponent {
    fun inject(target: GithubRetriever)
}

问题

当我尝试构建应用程序时，如果我将@UserScope 范围添加到ApiComponent，则会收到以下错误消息：

e: ApiComponent.java:4: error: ApiComponent scoped with @UserScope may not reference bindings with different scopes:
e: 
e: @dagger.Component(modules = {ApiModule.class})
e: ^
e:       @org.jetbrains.annotations.NotNull @Singleton @Provides okhttp3.OkHttpClient NetworkModule.provideHttpClient()

如果我使用@Singleton 范围而不是@UserScope，也会发生同样的情况。

我应该如何声明ApiComponent 才能成功构建？

Answer 1

单个模块不能引用两个范围；当您在 ApiModule (@Module(includes = [NetworkModule::class])) 中包含 NetworkModule 时，就会发生这种情况。

但是，一个模块可以依赖使用不同范围的组件。

@Component(modules = [NetworkModule::class])
@Singleton
interface NetworkComponent

@Component(dependencies = [NetworkComponent::class], modules = [ApiModule::class])
interface ApiComponent {
    fun inject(target: GithubRetriever)        
}