Dagger2不同作用域模块与组件冲突：如何正确声明ApiComponent？

这个错误的核心原因是Dagger的作用域规则限制：带有自定义作用域的组件（比如你的@UserScope的ApiComponent）不能直接引用不同作用域的绑定（这里是@Singleton的OkHttpClient），除非通过依赖其他作用域的组件来获取这些实例。

正确的解决方案：拆分组件，通过组件依赖实现跨作用域访问 #

我们需要把全局单例的网络模块和用户作用域的API模块拆到不同组件中，让ApiComponent依赖提供单例的全局组件，这样就能合法获取@Singleton的实例，同时保持自己的@UserScope。

步骤1：创建全局单例组件（AppComponent）

首先定义一个@Singleton作用域的组件，负责提供NetworkModule中的全局单例：

@Component(modules = [NetworkModule::class])
@Singleton
interface AppComponent {
    // 必须暴露OkHttpClient，让子组件可以获取到它
    fun okHttpClient(): OkHttpClient
}

步骤2：修改ApiModule，移除对NetworkModule的包含

原来的ApiModule通过includes引入了NetworkModule，现在我们要去掉这个引用，因为单例实例将从依赖的AppComponent获取：

@Module
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)
}

步骤3：修改ApiComponent，依赖AppComponent

更新ApiComponent的声明，添加dependencies属性指向AppComponent，同时保留自己的@UserScope：

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

步骤4：初始化组件的方式

现在你需要先初始化AppComponent，再用它来创建ApiComponent：

// 全局初始化AppComponent（比如在Application类中）
val appComponent = DaggerAppComponent.create()

// 创建ApiComponent时传入AppComponent
val apiComponent = DaggerApiComponent.builder()
    .appComponent(appComponent)
    .apiModule(ApiModule("your-username"))
    .build()

为什么这样能解决问题？ #

• AppComponent作为@Singleton组件，负责管理全局唯一的OkHttpClient实例。
• ApiComponent作为@UserScope组件，通过依赖AppComponent来获取跨作用域的实例，这完全符合Dagger的作用域规则：子作用域组件可以依赖父作用域组件，从而合法获取父作用域的绑定。

如果尝试把ApiComponent改成@Singleton也报错，是因为ApiModule中的provideApi是@UserScope，同样违反了“组件作用域必须和其绑定的作用域一致”的规则——一个@Singleton组件不能包含@UserScope的绑定。

内容的提问来源于stack exchange，提问作者user2340612