【问题标题】:Make part of coroutine continue past cancellation使协程的一部分继续取消
【发布时间】:2020-02-10 17:29:15
【问题描述】:

我有一个可以保存大文件的文件管理类。文件管理器类是一个应用程序单例,因此它比我的 UI 类寿命更长。我的 Activity/Fragment 可以从协程调用文件管理器的savesuspend 函数,然后在 UI 中显示成功或失败。例如:

//In MyActivity:
private fun saveTheFile() = lifecycleScope.launch {
    try {
        myFileManager.saveBigFile()
        myTextView.text = "Successfully saved file"
    } catch (e: IOException) {
        myTextView.text = "Failed to save file"
    }
}

//In MyFileManager
suspend fun saveBigFile() {
    //Set up the parameters
    //...

    withContext(Dispatchers.IO) {
        //Save the file
        //...
    }
}

这种方法的问题是,如果 Activity 完成,我不希望保存操作被中止。如果活动在withContext 块开始之前被销毁,或者withContext 块中有任何暂停点,则保存不会完成,因为协程将被取消。

我想要发生的是文件总是被保存。如果 Activity 仍然存在,那么我们可以在完成时显示 UI 更新。

我认为一种方法可能是从这样的挂起函数开始一个新的coroutineScope,但是当它的父作业被取消时,这个范围似乎仍然被取消。

suspend fun saveBigFile() = coroutineScope {
    //...
}

我认为另一种选择可能是使其成为一个常规函数,在完成时更新一些 LiveData。 Activity 可以观察结果的实时数据,并且由于 LiveData 在生命周期观察者被销毁时会自动删除它们,因此 Activity 不会泄漏到 FileManager。如果可以做像上面这样不那么复杂的事情,我想避免这种模式。

//In MyActivity:
private fun saveTheFile() {
    val result = myFileManager.saveBigFile()
    result.observe(this@MyActivity) {
        myTextView.text = when (it) {
            true -> "Successfully saved file"
            else -> "Failed to save file"
        }
    }
}

//In MyFileManager
fun saveBigFile(): LiveData<Boolean> {
    //Set up the parameters
    //...
    val liveData = MutableLiveData<Boolean>()
    MainScope().launch {
        val success = withContext(Dispatchers.IO) {
            //Save the file
            //...
        }
        liveData.value = success
    }
    return liveData
}

【问题讨论】:

  • 可能你应该在服务中做这样的工作,即使你的活动/应用程序被杀死也需要完成。因为协程就像线程一样,其生命周期取决于它运行的进程。服务使您保证您的工作将完成并且不会受到活动/应用被终止的影响。
  • 一个服务也在你的应用程序中运行,因此不能保证它不会被杀掉。如果你把它设为前台服务,它就不太可能被杀死。但我从未见过任何应用程序启动前台服务只是为了保存文件。很可能,文件操作不会花费足够长的时间,不会有应用程序被拆除以节省 RAM 的风险。
  • 另一种方法是使用不会受到应用终止或重启影响的 workmanager。

标签: android kotlin kotlin-coroutines


【解决方案1】:

你可以用NonCancellable包裹你不想被取消的位。

// May cancel here.
withContext(Dispatchers.IO + NonCancellable) {
    // Will complete, even if cancelled.
}
// May cancel here.

【讨论】:

  • 从文档看来,应该可以。但是我开始感觉到,如果协程不能很好地取消,这是一种很大的代码气味。 NonCancellable 的文档暗示您应该很少需要它,并且只能在 finally 块中使用。协程忽略取消请求似乎是一种意外行为。也许 LiveData 是处理这个问题的最佳方式。
  • 来自 Kotlinconf 的取消的好视频,包括 NonCancellable youtu.be/w0kfnydnFWI?t=1160
  • 如果您需要做一些原子性的事情,并且不能在中途取消,那么您就属于少数情况之一。暂时防止取消是可以的,只要确保你的协程是作用域的。
【解决方案2】:

如果您的代码的生命周期限定为整个应用程序的生命周期,那么这是GlobalScope 的一个用例。但是,仅仅说GlobalScope.launch 并不是一个好的策略,因为您可能会启动多个可能发生冲突的并发文件操作(这取决于您的应用程序的详细信息)。推荐的方法是使用全局范围的actor,作为执行者服务。

基本上可以说

@ObsoleteCoroutinesApi
val executor = GlobalScope.actor<() -> Unit>(Dispatchers.IO) {
    for (task in channel) {
        task()
    }
}

并像这样使用它:

private fun saveTheFile() = lifecycleScope.launch {
    executor.send {
        try {
            myFileManager.saveBigFile()
            withContext(Main) {
                myTextView.text = "Successfully saved file"
            }
        } catch (e: IOException) {
            withContext(Main) {
                myTextView.text = "Failed to save file"
            }
        }
    }
}

请注意,这仍然不是一个很好的解决方案,它会在其生命周期后保留myTextView。不过,将 UI 通知与视图分离是另一个主题。

actor 被标记为“过时的协程 API”,但这只是提前通知,它将在未来版本的 Kotlin 中被更强大的替代方案所取代。这并不意味着它已损坏或不受支持。

【讨论】:

  • 通过使用为文件管理器的生命周期创建的 CoroutineScope(它是一个为应用程序的生命周期而存在的单例),我们会得到与您描述的相同的结果吗?关于你的例子,如果我不关心泄露 Activity 的视图,我首先不需要担心取消——我会使用生命周期范围以外的东西来启动这项工作。
  • 至于第一点,你可以一直写GlobalScope.launch(Dispatchers.IO),但是还是会留下漏电的问题。您必须从提交的后台作业中删除对视图的所有引用,这通常意味着使用 MVVM,以便您可以引用 ViewModel。
  • @MarkoTopoInk,您有推荐的方法来处理@ObsoleteCoroutinesApi 注释吗?我不想在我的代码中传播这个注释,而是将它限制在我直接使用演员的地方,所以有一天我可以在演员被弃用时修改 API。这样做的唯一方法是根本不使用注释并保持警告不变,还是有办法仅在此类或函数上抑制它?
【解决方案3】:

我试过这个,它似乎做了我所描述的我想要的。 FileManager 类有自己的作用域,不过我想它也可以是 GlobalScope,因为它是一个单例类。

我们从协程在其自己的范围内启动一个新作业。这是通过一个单独的函数完成的,以消除关于工作范围的任何歧义。我用async 完成这项工作,这样我就可以冒出 UI 应该响应的异常。

然后在启动后,我们在原始范围内等待异步作业。 await() 暂停直到作业完成并传递任何抛出(在我的情况下,我希望 IOExceptions 冒泡以使 UI 显示错误消息)。因此,如果原始范围被取消,它的协程永远不会等待结果,但启动的作业会继续滚动,直到它正常完成。我们要确保始终处理的任何异常都应在 async 函数中处理。否则,如果取消原​​始作业,它们将不会冒泡。

//In MyActivity:
private fun saveTheFile() = lifecycleScope.launch {
    try {
        myFileManager.saveBigFile()
        myTextView.text = "Successfully saved file"
    } catch (e: IOException) {
        myTextView.text = "Failed to save file"
    }
}

class MyFileManager private constructor(app: Application):
    CoroutineScope by MainScope() {

    suspend fun saveBigFile() {
        //Set up the parameters
        //...

        val deferred = saveBigFileAsync()
        deferred.await()
    }

    private fun saveBigFileAsync() = async(Dispatchers.IO) {
        //Save the file
        //...
    }
}

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2012-02-18
    • 1970-01-01
    • 1970-01-01
    • 2012-10-07
    • 1970-01-01
    • 2016-10-02
    • 2019-11-01
    • 1970-01-01
    相关资源
    最近更新 更多