使用 async & await 从房间数据库中获取数据

Question

我正在尝试使用 async & await 内部的 Coroutine Scope 从房间数据库中获取数据，但在返回值时遇到问题。

这是我的代码：

fun getUserFromDB():Profile {
    val profileDao = AppDatabase.getDatabase(context).getProfileDao()
    CoroutineScope(Dispatchers.IO).launch {
        return profileDao.getUserProfile().await()
    }
}

道：

@Query("SELECT * FROM PROFILE LIMIT 1")
suspend fun getUserProfile():Deferred<Profile>

这里我想从方法中返回 userProfile，但我不能在范围内这样做，如果我从 Coroutine scope 之外返回，它将为空。

注意：我这里没有遵循 MVVM 模式，只是做一个简单的例子。

Answer 1

这里有一些问题，但我将首先解决主要问题。

fun getUserFromDB() {
    val profileDao = AppDatabase.getDatabase(context).getProfileDao()
    CoroutineScope(Dispatchers.IO).launch {
        val userProfile = profileDao.getUserProfile().await()
    }
    return userProfile
}

在getUserFromDB 中，launch 从getUserFromDB 异步执行，并且在您返回之前不会完成。

为了保证完成，你有两个选择（如果你想使用协程）。

1. 将getUserFromDB 标记为挂起函数。 （强烈推荐）

suspend fun getUserFromDB() {
    val profileDao = AppDatabase.getDatabase(context).getProfileDao()
    val userProfile = withContext(Dispatchers.IO) {
        profileDao.getUserProfile().await()
    }
    return userProfile
}

1. 使用runBlocking。

fun getUserFromDB() {
    val profileDao = AppDatabase.getDatabase(context).getProfileDao()
    val userProfile = runBlocking(Dispatchers.IO) {
        profileDao.getUserProfile().await()
    }
    return userProfile
}

现在主要问题已解决。这里有几件事违反了惯例和准则。

1. getUserProfile 不应该返回 Deferred<Profile>（尤其是如果它已经挂起），因为这是一个不安全的传递原语，它应该只返回 Profile。这样就不会意外引入不需要的并发，也不必写await()。

@Query("SELECT * FROM PROFILE LIMIT 1")
suspend fun getUserProfile(): Profile

fun getUserFromDB() {
    val profileDao = AppDatabase.getDatabase(context).getProfileDao()
    CoroutineScope(Dispatchers.IO).launch {
        val userProfile = profileDao.getUserProfile() /* .await() */
    }
    return userProfile
}

1. 在 Room 中使用协程时，它在专用线程池中执行阻塞调用，因此您不必使用一个（Dispatchers.IO），在主线程/调度程序中调用是安全的。此答案Why does the querySkuDetails need to run in IO context? 中的更多信息。

fun getUserFromDB() {
    val profileDao = AppDatabase.getDatabase(context).getProfileDao()
    CoroutineScope(/* Dispatchers.IO */).launch {
        val userProfile = profileDao.getUserProfile().await()
    }
    return userProfile
}

1. 最后一点，如果你创建了一个CoroutineScope 之后没有取消它，你应该只使用GlobalScope 来减少分配的数量。人们说“避免使用GlobalScope。”，这是真的，但你同样应该避免创建CoroutineScopes而不取消它们（我认为它更糟）。

fun getUserFromDB() {
    val profileDao = AppDatabase.getDatabase(context).getProfileDao()
    GlobalScope.launch(Dispatchers.IO) {
        val userProfile = profileDao.getUserProfile().await()
    }
    return userProfile
}

TL;DR

我已整理好答案，以便您在准备好后可以独立应用每个更改。 如果您只想要所有更改的总和，那么就在这里。

@Query("SELECT * FROM PROFILE LIMIT 1")
suspend fun getUserProfile(): Profile

suspend fun getUserFromDB(): Profile {
    val profileDao = AppDatabase.getDatabase(context).getProfileDao()
    val userProfile = profileDao.getUserProfile()
    return userProfile
}

愉快的编码。 :)

Answer 2

正如 cmets 中所指出的：非挂起函数永远不能异步返回。使用下一种方法从 DB 中获取 Profile：

suspend fun getUserFromDB(): Profile {
    val profileDao = AppDatabase.getDatabase(context).getProfileDao()
    return profileDao.getUserProfile().await()
}

使用CoroutineScope 和Dispatchers.Main 上下文启动协程，获取Profile 并更新UI：

CoroutineScope(Dispatchers.Main).launch {
    val profile = getUserFromDB()
    updateUi(profile)
}

或者更简洁，不使用getUserFromDB()函数：

CoroutineScope(Dispatchers.Main).launch {
    val profile = AppDatabase.getDatabase(context).getProfileDao().getUserProfile().await()
    updateUi(profile)
}

Answer 3

您可以通过在 DAO 中执行以下操作从查询中返回 Profile 数据类型：

@Query("SELECT * FROM PROFILE LIMIT 1")
suspend fun getUserProfile(): Profile

不用担心在主线程上进行调用，因为 Room 在后台线程上处理查询。

现在，根据您的架构，您可以使用launch 启动一个新的协程来调用getUserProfile，但既然您说您正在做一个简单的示例，您可以像这样调用getUserProfile：

来自活动：

fun myMethod() = lifecycleScope.launch {
    val profileDao = AppDatabase.getDatabase(this@MyActivity).getProfileDao()
    val profile = profileDao.getUserProfile()
    //Do something with profile here
}

从一个片段：

fun myMethod() = viewLifecycleOwner.lifecycleScope.launch {
    val profileDao = AppDatabase.getDatabase(this@MyFragment.context).getProfileDao()
    val profile = profileDao.getUserProfile()
    //Do something with profile here
}

来自 ViewModel：

fun myMethod() = viewModelScope.launch {
    val profileDao = AppDatabase.getDatabase(getApplication<Application>().applicationContext).getProfileDao()
    val profile = profileDao.getUserProfile()
    //Do something with profile here
}