如何解决Android Compose UI测试批量运行时Firestore模拟器缓存问题

问题场景 #

我正在为基于Jetpack Compose的Android应用写UI集成测试，用的是本地测试服务器上的Firebase Firestore模拟器。本来想让每个测试用例都从干净状态开始——每次测试前都会给模拟器填充特定测试数据，保证数据库起始状态完全一致。

但碰到了麻烦：

• 单独跑单个测试用例时，所有测试都能过
• 批量跑整个测试类/测试组时，测试就开始失败。UI显示的是上一个测试的旧数据，明明已经确认Firestore模拟器里的新数据是对的

后来发现是因为测试套件运行时，ActivityScenario.launch只会重启Activity，但同一个应用进程会保留下来，Firestore的单例实例在测试之间不会销毁，导致App读取的是本地缓存，而不是模拟器的最新数据。

现有测试代码 #

@Before
fun setup() {
    hiltRule.inject()
    runBlocking {
        MyFirebaseApi.deleteAllDriverLogBookEntries(settings)
        fillFirestore()
    }

    val intent = Intent(ApplicationProvider.getApplicationContext(), MainActivitySettings::class.java)
    scenario = ActivityScenario.launch(intent)
}

@After
fun tearDown() {
    if (::scenario.isInitialized) {
        scenario.close()
    }
}

private fun fillFirestore() {
    runBlocking {
        MyFirebaseApi
            .insertDriverLogBookEntriesToFirestore(settings, testData)
    }
}

解决方案 #

1. 清除Firestore本地缓存并关闭实例 #

在@After方法里主动清理Firestore的本地缓存，并且关闭现有实例，这样下一个测试启动时就会重新初始化：

@After
fun tearDown() {
    if (::scenario.isInitialized) {
        scenario.close()
    }
    // 清除缓存并终止Firestore实例
    runBlocking {
        Firebase.firestore.clearPersistence()
        Firebase.firestore.terminate()
    }
}

注意：clearPersistence()和terminate()都是挂起函数，得在runBlocking里调用，或者用Coroutine测试规则处理。

2. 测试环境直接禁用Firestore持久化 #

如果测试不需要离线缓存功能，直接在测试环境初始化Firestore时关掉持久化，从根源避免缓存问题：
在你的Firebase初始化类里加个测试环境判断：

fun getFirestoreInstance(): FirebaseFirestore {
    val firestore = Firebase.firestore
    if (BuildConfig.DEBUG || isTesting()) {
        // 禁用本地持久化
        firestore.firestoreSettings = FirebaseFirestoreSettings.Builder()
            .setPersistenceEnabled(false)
            .build()
    }
    return firestore
}

这里的isTesting()可以通过自定义的BuildConfig字段来判断是不是测试环境。

3. 主动移除所有Firestore监听器 #

如果你的App里用了Firestore的实时监听器（比如addSnapshotListener），测试结束时得主动移除这些监听器，避免它们拿着旧数据的引用：
可以在ViewModel或者Repository里维护监听器的引用，然后在测试的@After方法里调用清理方法：

// 示例：Repository中维护监听器的逻辑
class DriverLogBookRepository {
    private var listenerRegistration: ListenerRegistration? = null

    fun startListening() {
        listenerRegistration = Firebase.firestore.collection("entries")
            .addSnapshotListener { snapshot, error ->
                // 处理数据更新
            }
    }

    fun stopListening() {
        listenerRegistration?.remove()
        listenerRegistration = null
    }
}

// 在测试的tearDown里调用清理
@After
fun tearDown() {
    // ... 其他清理步骤
    runBlocking {
        driverLogBookRepository.stopListening()
    }
}

4. 强制Firestore从服务器拉取最新数据 #

在测试的setup方法启动Activity后，主动触发Firestore数据刷新，绕过本地缓存：
查询数据时用get(Source.SERVER)强制从服务器获取：

// 可以放在测试里或者App的初始化逻辑中
fun refreshDataFromServer() {
    runBlocking {
        Firebase.firestore.collection("entries")
            .get(Source.SERVER)
            .addOnSuccessListener { /* 触发UI更新 */ }
    }
}

在setup里启动Activity后调用这个方法，确保UI加载的是模拟器的最新数据。

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