Dagger Hilt 测试中 Application.onCreate() 未调用的解决方案

问题背景

在使用 Dagger Hilt 进行 Android 应用开发时，开发者经常会遇到一个常见问题：在编写仪器测试（Instrumentation Test）时，自定义 Application 类中的 onCreate() 方法没有被调用。这会导致应用初始化逻辑（如数据库预填充等）无法执行，从而影响测试结果。

问题分析

在 Hilt 测试环境中，默认会使用 HiltTestApplication 替代开发者自定义的 Application 类。这是 Hilt 测试框架的设计机制，目的是为了提供一个干净的测试环境。然而，这也意味着：

1. 自定义 Application 类中的 @HiltAndroidApp 注解会被忽略
2. 自定义 Application 的 onCreate() 方法不会被执行
3. 所有在 onCreate() 中执行的初始化逻辑都会丢失

解决方案

方案一：使用 @CustomTestApplication 注解

Hilt 提供了 @CustomTestApplication 注解，允许开发者在测试中使用自定义的 Application 类：

@CustomTestApplication(SearchFlightApplication::class)
interface HiltTestApplication

然后在测试运行器中指定这个生成的测试应用类：

class SearchFlightTestRunner : AndroidJUnitRunner() {
    override fun newApplication(
        cl: ClassLoader?,
        className: String?,
        context: Context?
    ): Application {
        return super.newApplication(cl, HiltTestApplication_Application::class.java.name, context)
    }
}

方案二：在测试 setUp 中手动执行初始化

如果不想使用自定义测试应用，可以在测试的 @Before 方法中手动执行原本放在 onCreate() 中的初始化逻辑：

@Before
fun setUp() {
    hiltRule.inject()
    runTest {
        airportsFtsRepository.deleteAndInsertAll(
            airportFtsEntitiesTestData
        )
    }
}

这种方法更加灵活，可以根据不同测试用例的需求定制初始化逻辑。

最佳实践建议

1. 分离初始化逻辑：将关键的初始化逻辑提取到单独的类或方法中，而不是全部放在 Application 的 onCreate() 中

2. 使用测试专用模块：在测试中提供专门的 Hilt 模块来替换生产环境的依赖

3. 考虑异步操作：如果初始化涉及协程或异步操作，确保测试等待这些操作完成

4. 合理使用测试数据库：考虑使用内存数据库或预填充的测试数据来加速测试执行

总结

在 Dagger Hilt 测试环境中处理 Application 初始化问题时，开发者有多种选择。理解 Hilt 测试框架的工作原理是关键，这有助于选择最适合项目需求的解决方案。无论是使用 @CustomTestApplication 还是手动初始化，目标都是确保测试环境的一致性，同时保持测试的高效执行。