JUnit4测试Room数据库遇UncompletedCoroutinesError问题求助

核心问题原因 #

Room数据库返回的Flow是无限流：它会在数据发生变化时持续发射更新，永远不会主动终止。你使用toList()方法时，该方法会一直等待流完成所有发射，导致协程无法结束，最终触发超时错误。

修复步骤 #

1. 替换toList()为first()：first()会获取流发射的第一个值（也就是插入数据后的最新列表），然后立即取消流的收集，让协程正常结束。
2. 重置Main Dispatcher：在测试结束后恢复默认的主线程调度器，避免影响其他测试用例。

修正后的测试代码 #

@RunWith(AndroidJUnit4::class)
class TaskDatabaseTest {
    @get:Rule
    var instantExecutorRule = InstantTaskExecutorRule()
    private lateinit var database: TaskDatabase
    private lateinit var dao: TaskDao

    private val testCoroutineDispatcher = StandardTestDispatcher()
    private val testCoroutineScope = TestScope(testCoroutineDispatcher)

    @Before
    fun setup() {
        Dispatchers.setMain(testCoroutineDispatcher)

        database = Room.inMemoryDatabaseBuilder(
            ApplicationProvider.getApplicationContext(),
            TaskDatabase::class.java
        ).allowMainThreadQueries().build()
        dao = database.taskDao()
    }

    @After
    fun tearDown() {
        Dispatchers.resetMain() // 重置主线程调度器
        database.close()
    }

    @Test
    fun insert() = testCoroutineScope.runTest {
        val task = Task("do exercise", id = 1)
        dao.insert(task)

        // 使用first()获取流的第一个发射值
        val tasks = dao.getTasksSortedByName("", false).first()
        assertThat(tasks).contains(task)
    }
}

额外说明 #

• runTest会自动管理测试协程的生命周期，但必须确保所有子协程都能正常结束。使用first()是处理Room无限流的标准做法，因为我们只需要验证插入操作后的初始数据状态。
• InstantTaskExecutorRule主要用于LiveData测试，如果你没有其他LiveData相关测试，可以考虑移除它，但保留也不会产生负面影响。

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