Dagger Hilt 中 Fragment 访问 ViewModel 的正确方式

问题背景

在使用 Dagger Hilt 进行依赖注入时，开发者经常遇到在 Fragment 中访问 ViewModel 的问题。特别是当 ViewModel 需要注入依赖项时，直接使用 viewModels() 委托会导致运行时错误，而使用 activityViewModels() 却能正常工作。

问题现象

当尝试在 Fragment 中通过以下方式获取 ViewModel 时：

private val viewModel: MyViewModel by viewModels()

如果 ViewModel 构造函数有依赖注入（如通过 @Inject 注解的 Repository），系统会抛出 Cannot create an instance of class 异常。而改用：

private val viewModel: MyViewModel by activityViewModels()

则不会出现任何问题。

根本原因

这个问题的核心在于 Hilt 的注入机制。当 ViewModel 需要依赖注入时，Fragment 本身也必须能够进行依赖注入。activityViewModels() 之所以能工作，是因为它共享 Activity 的 ViewModelStore，而 Activity 已经被标记为 @AndroidEntryPoint。

解决方案

正确的做法是在 Fragment 类上添加 @AndroidEntryPoint 注解：

@AndroidEntryPoint
class MyFragment : Fragment() {
    private val viewModel: MyViewModel by viewModels()
    // ...
}

技术原理

1. Hilt 的工作机制：Hilt 需要在 Android 组件类上添加 @AndroidEntryPoint 注解才能进行依赖注入。这适用于 Activity、Fragment、Service、BroadcastReceiver 等。

2. ViewModel 生命周期：使用 viewModels() 委托创建的 ViewModel 实例与 Fragment 生命周期绑定，而 activityViewModels() 创建的实例则与 Activity 生命周期绑定。

3. 依赖注入范围：当 ViewModel 需要注入依赖时，创建它的组件（Fragment 或 Activity）必须能够进行依赖注入，否则 Hilt 无法提供所需的依赖项。

最佳实践

1. 对于需要注入依赖的 ViewModel，确保使用它的 Fragment 都添加了 @AndroidEntryPoint 注解。

2. 考虑 ViewModel 的生命周期需求：

   • 如果数据需要在多个 Fragment 间共享，使用 activityViewModels()
   • 如果数据只属于当前 Fragment，使用 viewModels()

3. 在 Application 类上添加 @HiltAndroidApp 注解，这是 Hilt 工作的基础。

常见误区

1. 认为只需要在 Activity 上添加注解：实际上，任何需要依赖注入的 Android 组件都需要相应的注解。

2. 混淆 ViewModel 的两种获取方式：viewModels() 和 activityViewModels() 不仅仅是作用范围不同，在依赖注入方面也有不同要求。

3. 忽略错误信息的提示：当看到 Cannot create an instance of class 错误时，首先应该检查相关类是否都正确添加了 Hilt 注解。

总结

在 Dagger Hilt 项目中，正确处理 Fragment 访问 ViewModel 的关键在于理解 Hilt 的注入机制和 ViewModel 的生命周期。通过为 Fragment 添加 @AndroidEntryPoint 注解，可以确保依赖注入链完整，从而避免运行时错误。这一实践不仅解决了当前问题，也为项目后续的依赖管理奠定了良好基础。