Kotlin Firestore：挂起函数中Task未被正确await问题排查

根本原因 #

你遇到的问题核心有两点：

1. 协程扩展未正确配置：Firestore原生Task没有await()挂起函数，必须依赖kotlinx.coroutines的Play Services扩展才能将异步任务转为挂起函数。如果缺失依赖或未正确导入扩展，await()不会生效，返回值仍为Task类型而非预期的QuerySnapshot。
2. 查询结果处理错误：即使await()生效，第一个查询返回的是QuerySnapshot（文档集合），但startAfter()需要的是单个文档快照或排序字段的具体值，直接传入QuerySnapshot会导致类型或逻辑错误。

具体修复步骤 #

1. 补全协程扩展依赖与导入 #

首先在Module级别的build.gradle中添加协程Firestore扩展依赖：

implementation "org.jetbrains.kotlinx:kotlinx-coroutines-play-services:1.7.3" // 版本可根据项目Kotlin版本调整

然后在UserRemoteMediator文件顶部导入await扩展函数：

import kotlinx.coroutines.tasks.await

2. 正确处理分页游标 #

你是按timestamp排序分页，最直接的方式是用最后一条数据的timestamp作为分页游标，无需额外查询文档：

LoadType.APPEND -> {
    val lastItem = state.lastItemOrNull() ?: return MediatorResult.Success(endOfPaginationReached = true)
    // 直接用lastItem的timestamp作为startAfter的参数
    lastItem.timestamp
}

如果必须通过查询获取文档快照（比如需要完整文档作为游标），则需从QuerySnapshot中提取目标文档：

LoadType.APPEND -> {
    val lastItem = state.lastItemOrNull() ?: return MediatorResult.Success(endOfPaginationReached = true)
    val querySnapshot = firestore.collection("users")
        .whereEqualTo("id", lastItem.id)
        .get()
        .await()
    // 提取唯一匹配的文档快照（id唯一，所以取第一个即可）
    querySnapshot.documents.firstOrNull() ?: return MediatorResult.Success(endOfPaginationReached = true)
}

3. 修正第二个查询逻辑 #

确保startAfter()传入的参数类型与orderBy()指定的字段类型一致：

val response = firestore.collection("users")
    .orderBy("timestamp")
    .let { query ->
        loadKey?.let { query.startAfter(it) } ?: query
    }
    .limit(10)
    .get()
    .await()

完整修复后代码片段 #

import kotlinx.coroutines.tasks.await

class UserRemoteMediator(
    private val networkService: UserApiService,
    private val database: UserDatabase,
    private val firestore: FirebaseFirestore // 确保Firestore实例已注入
) : RemoteMediator<Int, User>() {

    private val userDao = database.userDao()

    override suspend fun load(
        loadType: LoadType,
        state: PagingState<Int, User>
    ): MediatorResult {
        return try {
            val loadKey = when (loadType) {
                LoadType.REFRESH -> null
                LoadType.PREPEND ->
                    return MediatorResult.Success(endOfPaginationReached = true)
                LoadType.APPEND -> {
                    val lastItem = state.lastItemOrNull() ?: return MediatorResult.Success(endOfPaginationReached = true)
                    // 直接用timestamp作为分页游标
                    lastItem.timestamp
                }
            }
            
            val response = firestore.collection("users")
                .orderBy("timestamp")
                .let { query -> loadKey?.let { query.startAfter(it) } ?: query }
                .limit(10)
                .get()
                .await()

            // 处理查询结果并插入数据库
            val users = response.toObjects(User::class.java)
            database.withTransaction {
                if (loadType == LoadType.REFRESH) userDao.clearAll()
                userDao.insertAll(users)
            }

            MediatorResult.Success(endOfPaginationReached = users.size < 10)
        } catch (e: IOException) {
            MediatorResult.Error(e)
        } catch (e: Exception) {
            MediatorResult.Error(e)
        }
    }
}

额外注意事项 #

• 确保User实体类的timestamp字段与Firestore中的字段类型完全匹配（比如同为Timestamp或Long）。
• 分页时startAfter()的参数类型必须与orderBy()指定的字段类型一致，否则会导致查询失败。

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