如何使用带虚拟数据的Room数据库运行AndroidTests？

要在UI测试中给Room数据库填充虚拟数据，核心思路是创建测试专用的数据库实例，并在测试初始化阶段插入预设的测试数据，确保UI能加载到数据进行验证。以下是具体实现步骤：

1. 配置测试专用Room数据库 #

在androidTest目录下创建测试数据库类，它和主应用的数据库结构一致，但使用内存模式（避免污染真实数据），并允许主线程操作（简化测试代码）：

// androidTest/java/[你的包名]/TestAppDatabase.kt
@Database(entities = [User::class], version = 1)
abstract class TestAppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao

    companion object {
        fun create(context: Context): TestAppDatabase {
            return Room.inMemoryDatabaseBuilder(context, TestAppDatabase::class.java)
                .allowMainThreadQueries() // 测试场景下临时允许主线程操作
                .build()
        }
    }
}

2. 封装测试数据生成工具 #

写一个工具类统一生成虚拟数据，方便在不同测试场景中复用：

// androidTest/java/[你的包名]/TestDataGenerator.kt
object TestDataGenerator {
    // 生成测试用的用户列表
    fun generateTestUsers(): List<User> {
        return listOf(
            User(id = 1, name = "测试用户1", email = "test1@example.com"),
            User(id = 2, name = "测试用户2", email = "test2@example.com"),
            User(id = 3, name = "测试用户3", email = "test3@example.com")
        )
    }

    // 可扩展其他类型的测试数据生成方法
    fun generateTestItems(): List<Item> {
        return listOf(
            Item(id = 1, title = "测试条目1", content = "这是测试内容"),
            Item(id = 2, title = "测试条目2", content = "这是另一项测试内容")
        )
    }
}

3. 在UI测试中初始化数据并验证 #

在测试类的@Before方法中初始化测试数据库、插入虚拟数据，测试完成后关闭数据库：

// androidTest/java/[你的包名]/UserListActivityTest.kt
@RunWith(AndroidJUnit4::class)
class UserListActivityTest {
    private lateinit var testDb: TestAppDatabase
    private lateinit var userDao: UserDao

    @Before
    fun setup() {
        val context = ApplicationProvider.getApplicationContext<Context>()
        // 创建内存数据库实例
        testDb = TestAppDatabase.create(context)
        userDao = testDb.userDao()

        // 插入测试数据
        val testUsers = TestDataGenerator.generateTestUsers()
        userDao.insertAll(testUsers)
    }

    @Test
    fun userListDisplaysAllTestUsers() {
        // 启动目标Activity
        val intent = Intent(ApplicationProvider.getApplicationContext(), UserListActivity::class.java)
        ActivityScenario.launch(intent)

        // 验证UI中显示了测试数据
        onView(withId(R.id.user_recycler_view))
            .check(matches(hasDescendant(withText("测试用户1"))))
            .check(matches(hasDescendant(withText("测试用户2"))))
            .check(matches(hasDescendant(withText("测试用户3"))))
    }

    @After
    fun teardown() {
        // 测试结束后关闭数据库
        testDb.close()
    }
}

进阶：用依赖注入替换数据库（可选） #

如果你的项目使用Hilt等依赖注入框架，可以通过测试模块替换生产环境的数据库实例，让测试代码更优雅：

// androidTest/java/[你的包名]/TestDatabaseModule.kt
@Module
@InstallIn(SingletonComponent::class)
object TestDatabaseModule {
    @Provides
    fun provideTestDatabase(@ApplicationContext context: Context): AppDatabase {
        return Room.inMemoryDatabaseBuilder(context, TestAppDatabase::class.java)
            .allowMainThreadQueries()
            .build() as AppDatabase
    }
}

然后在测试类中使用Hilt注解：

@HiltAndroidTest
@UninstallModules(AppDatabaseModule::class) // 卸载生产环境的数据库模块
class UserListActivityTest {
    @Inject lateinit var db: AppDatabase
    private lateinit var userDao: UserDao

    @Before
    fun setup() {
        HiltAndroidRule(this).inject()
        userDao = db.userDao()
        userDao.insertAll(TestDataGenerator.generateTestUsers())
    }

    // ... 测试方法和之前一致
}

注意事项 #

• 内存数据库每次测试都会重新创建，数据不会跨测试残留，保证测试独立性。
• 测试用的DAO必须和生产环境的DAO接口完全一致，避免测试逻辑与实际逻辑脱节。
• 若需要模拟异常场景（比如空数据、错误格式数据），可在TestDataGenerator中添加对应的数据生成方法。

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