遵循DIP的Android项目中Dagger Hilt跨模块注入缺失绑定问题

核心原因 #

重构为DIP分层结构后，Dagger Hilt无法扫描到impl模块中的绑定配置，因为主组件（如Application级SingletonComponent）所在的模块未正确依赖所有impl模块，或impl模块的@Module未正确安装到目标组件中。

具体解决方案 #

1. 确保主模块显式依赖所有impl模块

Hilt的根组件（如SingletonComponent）在app模块生成，必须让app模块直接或间接依赖所有包含@Module的impl模块，这样Hilt才能扫描到这些绑定配置。在app模块的build.gradle中添加依赖：

dependencies {
    // 显式依赖所有impl模块，确保Hilt能扫描到它们的Module
    implementation project(':feature:A:impl')
    implementation project(':common:B:impl')
    implementation project(':lib:C:impl')
}

2. 为每个impl模块的@Module配置正确的@InstallIn注解

每个impl模块中的绑定模块必须通过@InstallIn指定要安装到的Hilt组件，确保绑定被注册到全局组件中。例如common:B:impl中的模块：

@Module
@InstallIn(SingletonComponent::class) // 绑定到全局单例组件
object BModule {
    @Provides
    fun provideIServiceProvider(): IServiceProviderFromModuleB {
        return ServiceProviderFromModuleBImpl()
    }
}

同理，lib:C:impl中的模块也要做相同配置：

@Module
@InstallIn(SingletonComponent::class)
object CModule {
    @Provides
    fun provideIClassFromModuleC(): IClassFromModuleC {
        return ClassFromModuleCImpl()
    }
}

3. 梳理模块依赖关系，符合DIP的同时保证Hilt扫描路径

保持抽象模块与实现模块的依赖单向性：

• 抽象模块（如:lib:C、:common:B）只包含接口/抽象类，不依赖任何impl模块
• 实现模块（如:lib:C:impl、:common:B:impl）依赖对应的抽象模块，以及其他需要的抽象模块（如:common:B:impl依赖:lib:C）
• 主app模块依赖所有impl模块，确保Hilt能遍历到所有绑定

4. 清理构建缓存，重新生成Hilt组件

缓存可能导致Hilt未识别新添加的模块绑定，执行以下命令清理后重新构建：

./gradlew clean build

5. 验证注入点的正确性

确保注入的是抽象接口类型，而非具体实现类。例如DataProviderFromModuleA的构造函数注入：

class DataProviderFromModuleA @Inject constructor(
    private val serviceProvider: IServiceProviderFromModuleB // 注入接口而非实现类
) {
    // ...
}

总结 #

只要保证Hilt能扫描到所有impl模块的绑定配置，同时模块间依赖符合DIP的单向依赖原则，就能解决跨模块注入的缺失绑定问题。

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