在 Kotlin 中创建子协程范围

bro*_*oot 6 kotlin kotlin-coroutines

短(-ish)故事

我想知道是否有或多或少的标准方法来创建协程上下文/范围,以便:

  • 它是用于结构化并发的当前协程的子项,
  • 它可以存储在某些属性等中,然后用于运行异步任务,例如launch()

coroutineScope()正是我所需要的,它创建了一个子作用域,但它不是简单地将它返回给调用者——我们需要传递一个 lambda 并且协程生命周期仅限于这个 lambda 的执行。另一方面,CoroutineScope()工厂创建了一个长时间运行的作用域,我可以存储以备后用,但它与当前的协程无关。

我能够手动创建这样的范围:

suspend fun createChildCoroutineScope(): CoroutineScope {
    val ctx = coroutineContext
    return CoroutineScope(ctx + Job(ctx.job))
}
Run Code Online (Sandbox Code Playgroud)

乍一看,它似乎完全符合我的需要。它相当于什么coroutineScope(),或者我的解决方案在某种程度上不完整,我应该执行一些额外的任务?我试图阅读 的源代码coroutineScope(),但它相当复杂。是否有更简单或更标准的方法来创建子作用域?

此外,它是否被认为是一种不好的做法或反模式?我只是担心如果已经没有这样一个简单的函数,那么可能是有原因的,我不应该真正以这种方式使用协程。

用例(更长的故事)

通常,当我实现某种可以异步安排后台操作的长时间运行的服务时,我会看到这种需求:

class MyService {
    fun scheduleSomeTask() {
        // start task in the background
        // return immediately
    }
}
Run Code Online (Sandbox Code Playgroud)

使用协程有几种可能性:

  1. GlobalScope,但很糟糕。

  2. scheduleSomeTask()使用当前协程使可挂起并运行后台任务。在许多情况下,我认为这种方法并不是真正合适的方法:

    • 后台任务由调用者“拥有”,而不是由服务本身“拥有”。例如,如果我们停止服务,后台任务将仍在运行。
    • 它要求调度功能是可挂起的。我认为这是错误的,因为我真的不明白为什么不允许某些 Java 代码或协程上下文之外的代码在我的服务中安排任务的原因。
  3. 给我的服务定义的生命周期,创建范围与CoroutineScope()cancel()它停止/销毁时。这很好,但我认为我们仍然可以从协程的结构化并发中受益,所以对我来说,我的服务分离是一个缺点。

    例如,我们有一个文件下载服务,它由(拥有)其他服务组成,包括数据缓存服务。使用start()/stop()服务的典型方法,我们需要手动控制生命周期,并且很难正确处理故障。协程让它变得更容易:如果缓存服务崩溃,它会自动传播到下载服务;如果下载服务需要停止,它只是取消它的协程,它可以确保它不会泄漏它的任何子组件。所以对我来说,在设计由几个小服务组成的应用程序时,协程的结构化并发可能非常有用。

我目前的方法是这样的:

class MyService {
    private lateinit var coroutine : CoroutineScope

    suspend fun start() {
        coroutine = createChildCoroutineScope() + CoroutineName("MyService")
    }

    fun stop() {
        coroutine.cancel()
    }

    fun scheduleSomeTask() {
        coroutine.launch {
            // do something
        }
    }
}
Run Code Online (Sandbox Code Playgroud)

或者,或者:

class MyService(
    private val coroutine: CoroutineScope
) {
    companion object {
        suspend fun start() = MyService(createChildCoroutineScope())
    }
}
Run Code Online (Sandbox Code Playgroud)

通过这种方式,服务“拦截”启动它的协程并将其后台操作附加到它。但正如我所说,我不确定这是否出于某种原因不被视为反模式。

此外,我了解我createChildCoroutineScope()的潜在危险。通过调用它,我们使当前的协程无法完成。这可能是库中不存在此类函数的原因。另一方面,它与执行以下操作并没有真正不同:

launch {
    while (true) {
        socket.accept() // assume it is suspendable, not blocking
        // launch connection handler
    }
} 
Run Code Online (Sandbox Code Playgroud)

事实上,从技术角度来看,这两种方法非常相似。它们具有相似的并发结构,但我相信“我的”方法通常更简洁、更强大。

bro*_*oot 5

我对我的问题找到了一个非常好的答案和解释。Roman Elizarov 在他的一篇文章中准确讨论了我的问题:https://elizarov.medium.com/coroutine-context-and-scope-c8b255d59055

他解释说,虽然在技术上可以“捕获”挂起函数的当前上下文并使用它来启动后台协程,但强烈不鼓励这样做:

不要这样做!它使协程启动的范围变得不透明和隐式,捕获一些外部Job来启动新的协程,而无需在函数签名中明确声明它。协程是与代码的其余部分并发的一项工作,其启动必须是明确的。

如果您需要启动一个在函数返回后继续运行的协程,请使您的函数成为 的扩展CoroutineScopescope: CoroutineScope作为参数传递,以便在函数签名中明确您的意图。不要使这些功能暂停。

我知道我可以将CoroutineScope/传递CoroutineContext给函数,但我认为挂起函数将是一种更短、更优雅的方法。然而,上面的解释却很有意义。如果我们的函数需要获取调用者的协程范围/上下文,请明确说明这一点 - 这再简单不过了。

这也与“热”/“冷”执行的概念有关。挂起函数的一大好处是它们使我们能够轻松创建长时间运行任务的“冷”实现。虽然我认为协程文档中没有明确指定挂起函数应该是“冷”的,但满足此要求通常是一个好主意,因为我们挂起函数的调用者可以假设它是“冷”的。捕获协程上下文使我们的函数变得“热”,因此应该通知调用者这一点。