Dagger Hilt中ViewModel注入的正确使用方式

概述

在使用Dagger Hilt进行依赖注入时，ViewModel的注入是一个常见需求。许多开发者会遇到一个典型问题：当ViewModel构造函数需要参数时，直接使用传统的ViewModelProvider方式会导致创建失败。本文将深入分析这个问题，并介绍正确的解决方案。

问题现象

开发者在使用Hilt时，可能会尝试在Activity基类中这样初始化ViewModel：

mViewModel = ViewModelProvider(
    this,
    ViewModelProvider.AndroidViewModelFactory.getInstance(application)
).get(persistentClass)

当ViewModel构造函数无参数时，这种方式可以正常工作。但是一旦ViewModel构造函数需要注入参数，例如：

@HiltViewModel
class ListViewModel @Inject constructor(
    val testDao: TestModelDao
) : BaseViewModel()

就会抛出Cannot create an instance of class异常，提示找不到合适的构造函数。

问题根源

这个问题的根本原因在于使用了错误的ViewModelProvider工厂。传统的AndroidViewModelFactory无法处理Hilt注解的ViewModel，因为它不知道如何注入ViewModel所需的依赖项。

Hilt提供了专门的HiltViewModelFactory来处理带有@HiltViewModel注解的ViewModel的创建和依赖注入。当我们直接使用AndroidViewModelFactory时，系统尝试通过反射创建ViewModel实例，但找不到无参构造函数，因此失败。

解决方案

正确的做法是让Hilt自动处理ViewModel的注入。在Activity中，最简单的方式是使用by viewModels()委托属性：

@AndroidEntryPoint
class MyActivity : AppCompatActivity() {
    private val viewModel: MyViewModel by viewModels()
}

这种方式会自动使用Hilt提供的ViewModel工厂，正确处理依赖注入。

如果确实需要在基类中封装ViewModel的获取逻辑，可以这样实现：

abstract class BaseVMActivity<VM : ViewModel> : AppCompatActivity() {
    protected lateinit var viewModel: VM
    
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        viewModel = ViewModelProvider(this).get(getViewModelClass())
    }
    
    abstract fun getViewModelClass(): Class<VM>
}

注意这里没有指定ViewModelProvider.Factory，因为Hilt会自动提供正确的工厂实现。

最佳实践

1. 尽量使用by viewModels()：这是最简单、最不容易出错的方式，推荐优先使用。

2. 避免手动创建ViewModelProvider.Factory：Hilt已经为我们处理了工厂的创建，手动指定工厂会覆盖Hilt的自动配置。

3. 基类封装要谨慎：如果必须在基类中封装ViewModel获取逻辑，确保不要指定工厂参数。

4. 检查Hilt配置：确保Application类添加了@HiltAndroidApp注解，Activity添加了@AndroidEntryPoint注解。

总结

在Dagger Hilt中使用ViewModel时，理解Hilt的自动注入机制非常重要。传统的ViewModel创建方式不再适用，应该充分利用Hilt提供的简化API。记住关键点：让Hilt处理ViewModel工厂的创建，不要手动干预这个过程。这样既能保证依赖正确注入，又能避免各种奇怪的运行时错误。

通过遵循这些原则，开发者可以更高效地在项目中使用Hilt进行ViewModel管理，专注于业务逻辑而不是依赖注入的细节。