如何使用协程从 Room 返回单个（非 LiveData）对象

Question

Room 在后台线程自动执行返回LiveData 的查询。但我想返回一个未包含在 LiveData 中的单个值（因为我不想要实时更新）。 如何使用协程来实现这一点？

如何从这个函数返回Task 对象？

fun getTask(id: Int): Task {
    viewModelScope.launch {
        repository.getTask(id)
    }
}

这个函数在 ViewModel 中。它将调用转发到 DAO：

@Query("SELECT * FROM task_table WHERE id = :id")
fun getTask(id: Int): Task

Answer 1

如果您不从 Room 返回 LiveData，您将无法从数据库中获取更新。但是，您可以从 viewModel 返回 LiveData。

val data = liveData {
    emit(repository.getTask(id))
}

liveData 扩展函数在协程中运行，然后您可以使用 DAO 的挂起版本正确处理后台处理。

@Query("SELECT * FROM task_table WHERE id = :id")
suspend fun getTask(id: Int): Task?

如果您没有在查询中使用聚合函数，您需要做的一件大事是确保它可以为空。

如果您真的想调用 viewModel 中的方法来返回任务，您应该从您的活动/片段运行启动（不推荐）

ViewModel
suspend fun getTask(id: Int): Task {
    repository.getTask(id)
}

Activity/Fragment
lifecycleScope.launch {
    val task = viewModel.getTask(id)
    // Do What you want with the task
}

Answer 2

Room 中的挂起函数是主安全的，并且在自定义的 调度员。与您在问题中提到的 LiveData 相同。下面是实现相同的示例

viewmModel 类的一些函数内部

 viewModelScope.launch {
       // suspend and resume make this database request main-safe
       // so our ViewModel doesn't need to worry about threading
       someLiveData.value =
               repository.getSomething()
   }

在存储库类中

suspend fun getSomething(): List<Something> {
   return dao.getSomething()

}

在道课中

 @Query("select * from tableName")
   suspend fun getSomething(): List<Something>

Answer 3

Flow 是新的 LiveData！

我之前在两个项目中遇到过类似的问题，每个解决方案都不同。但最近我学会了使用Flow，它似乎是迄今为止最干净的方式。

LiveData 的替代品

如果您不需要使用 LiveData，您有两种选择：

1. 通过@query 检索Cursor，适用于重构旧项目。
2. 使用Flow，适合新项目。

只检索一个对象/值

1. LiveDate：您可以取消订阅 LiveData，在第一次获取后移除观察者。在我看来并不干净。
2. 流：如果需要，您可以只检索单个对象/值，然后停止流收集。

道：

getTask(): 这个方法返回一个Flow<Task>:

@Query("SELECT * FROM task_table WHERE id = :id")
fun getTask(id: Int): Flow<Task>

视图模型：

getTask()：返回一个Task对象（不是Flow<Task>），也是suspend函数。

first() 返回第一个元素的终端操作符 flow 然后取消 flow 的收集。抛出 NoSuchElementException 如果流是空的。

suspend fun getTask(id: Int): Task {
    return dao.getTask(id).first()
}

片段/活动：

属性：

private var viewModelJob = Job()
private val uiScope = CoroutineScope(Dispatchers.Main + viewModelJob)

不要忘记在不需要片段/活动（即 onClear/onDestory/...）时取消 viewModelJob，以便取消与此相关的所有协程。

用法

现在，每当我们想从挂起的函数中检索对象Task 时，我们都需要在挂起或协程中。因此在这里使用launch builder 创建协程是合适的（因为我们不希望该builder 有任何返回对象，我们只想运行一个挂起函数，否则异步返回一个延迟）。

    onCreate() / onCreateView()
    .
    ..
    ...
    uiScope.launch() {
        // Here are the Task & Main-UI
        val task = viewModel.getTask(1)
        binding.taskTitleTextView.text = task.title
    }

如果我们不使用first()那么我们需要收集流viewModel.getTasks().collect{ it }kotlinx.coroutines.flow有很多有用的功能。 Flow is Coroutine 包中发生的最好的事情，哦，对不起，我通过了存储库层，在大多数情况下它只是 viewModel 的重复?。

Answer 4

其中一种解决方法是立即返回 Deferred 对象，然后在返回 deferred 时调用 .await()

fun getTaskAsync(id: Int): Deferred<Task> = viewModelScope.async {
        repository.getTask(id)
    }

//call-site
getTaskAsync(id).await() // <- this is suspension point