使用AndroidX与Hilt测试ViewModel遇到问题求助

1. 为什么找不到@HiltViewModelTest？ #

这个注解根本不存在，Hilt没有提供专门用于ViewModel测试的@HiltViewModelTest注解。测试带@HiltViewModel的类，只需使用常规的Hilt测试注解：

• 仪器化测试（需设备/模拟器）用@HiltAndroidTest
• 本地单元测试用@HiltTest（需额外配置依赖，你的场景用仪器化测试即可）

2. 解决“多次绑定”错误 #

问题根源 #

• 测试类中同时使用ActivityScenarioRule和Hilt注入：启动Activity会触发Hilt的依赖注入流程，加上测试类自身的注入，导致依赖被重复提供
• 测试类中错误使用@BindValue：注入真实Repository实例后又重新绑定，造成重复绑定
• AppModule中存在重复Provider：providesMenuItemListLocal()和providesMenuItemListInterface()都提供了MenuItemListLocal实例，导致Hilt无法确定使用哪个

修正步骤 #

步骤1：修正AppModule，移除重复的Provider

@Module
@InstallIn(ViewModelComponent::class)
class AppModule {
    @Provides
    fun providesMenuPhotoGalleryRepository(): MenuPhotoGalleryRepository = MenuPhotoGalleryRepository()

    @Provides
    fun providesMenuItemListInterface(): MenuItemListInterface = MenuItemListLocal()

    // 移除重复的Provider，上面的接口实现已返回MenuItemListLocal实例
    // @Provides
    // fun providesMenuItemListLocal(): MenuItemListLocal = MenuItemListLocal()

    @Provides
    fun providesMenuItemRepository(menuItemListLocal: MenuItemListInterface): MenuItemRepository = 
        MenuItemRepository(menuItemListLocal as MenuItemListLocal)
    // 推荐依赖接口，如需直接用实现类可修改参数类型
}

步骤2：重写测试类，移除冗余代码

import androidx.test.ext.junit.runners.AndroidJUnit4
import com.elnimijogames.porschegarage.model.MenuItemRepository
import com.elnimijogames.porschegarage.model.MenuPhotoGalleryRepository
import dagger.hilt.android.testing.HiltAndroidRule
import dagger.hilt.android.testing.HiltAndroidTest
import org.junit.Assert.assertEquals
import org.junit.Before
import org.junit.Rule
import org.junit.runner.RunWith
import javax.inject.Inject

@HiltAndroidTest
@RunWith(AndroidJUnit4::class)
class MainMenuViewModelTest {

    @get:Rule
    var hiltRule = HiltAndroidRule(this)

    // 直接注入ViewModel，无需手动实例化
    @Inject
    lateinit var viewModel: MainMenuViewModel

    @Inject
    lateinit var galleryRepository: MenuPhotoGalleryRepository

    @Inject
    lateinit var menuItemRepository: MenuItemRepository

    @Before
    fun setup() {
        hiltRule.inject()
    }

    fun testMainMenuViewModel() {
        val expectedGalleryList = galleryRepository.getImageGalleryList()
        val expectedMenuList = menuItemRepository.getMenuItemsList()

        assertEquals(expectedGalleryList, viewModel.photoGalleryState.value)
        assertEquals(expectedMenuList, viewModel.itemMenuState.value)
    }
}

关键改动说明 #

• 移除ActivityScenarioRule：测试ViewModel不需要启动Activity，避免重复注入依赖
• 移除@BindValue代码：Hilt会通过AppModule提供Repository实例，无需重复绑定
• 直接注入MainMenuViewModel：利用Hilt的依赖注入能力获取ViewModel，无需手动创建（若需手动创建，也可使用注入的Repository实例）

额外说明 #

如果需要模拟Repository进行测试（而非真实实例），可使用@BindValue绑定Mock实例，示例如下：

@BindValue
@JvmField
val mockGalleryRepo: MenuPhotoGalleryRepository = mockk() // 使用MockK或Mockito创建Mock

@BindValue
@JvmField
val mockMenuItemRepo: MenuItemRepository = mockk()

此时需确保测试类中未同时注入真实Repository实例，避免冲突。

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