Kotlin 协程的取消机制：深入理解和优雅实现

2024-09-13
福建
本文字数：3236 字
阅读完需：约 11 分钟

Kotlin 协程提供了一种高效的方式来处理并发和异步任务。在协程的生命周期管理中，取消协程是一项重要的操作。本文将深入探讨 Kotlin 协程的取消机制，介绍除了直接使用Job的cancel方法之外的其他方式，并提供优雅的实现策略。

1. 协程取消的基本概念

在 Kotlin 协程中，取消协程是一个协作过程。当外部请求取消协程时，协程需要定期检查自己的取消状态，并在适当的时候退出。这种设计允许协程在取消时进行清理工作，比如关闭资源、保存状态等。

1.1 检查取消状态

协程可以通过以下方式检查自己是否被取消：

isActive：如果协程没有被取消，返回true。
isCancelled：如果协程被取消了，返回true。

1.2 取消协程

取消协程可以通过调用Job的cancel方法来实现。这会标记协程为取消状态，但不会立即停止协程。协程需要定期检查自己的取消状态，并在适当的时候退出。

2. 优雅的取消协程

2.1 使用`CompletableDeferred`

CompletableDeferred是一个特殊的协程构建器，它允许你手动完成或取消一个协程。它常用于需要等待某个异步操作完成或取消的场景。

import kotlinx.coroutines.*
fun main() = runBlocking {    val deferred = CompletableDeferred<Unit>()    launch {        try {            deferred.await() // 等待某个条件        } catch (e: CancellationException) {            println("Deferred was cancelled")        } catch (e: Exception) {            println("An error occurred: ${e.message}")        }    }    delay(1000L)    deferred.cancel() // 取消等待    println("main: Now I can quit.")}

复制代码

在这个示例中，我们通过CompletableDeferred来控制协程的取消。当外部条件满足时，我们可以取消等待，并通过try-catch块来处理取消和异常。

2.2 使用`isActive`检查

在协程内部，你可以通过检查isActive属性来决定是否继续执行。如果isActive返回false，协程应该停止执行。

import kotlinx.coroutines.*
fun main() = runBlocking {    val job = launch {        try {            while (isActive) {                // 执行任务                delay(500L)            }        } catch (e: CancellationException) {            println("Job was cancelled")        }    }    delay(1000L)    job.cancel() // 取消协程    job.join() // 等待协程结束    println("main: Now I can quit.")}

复制代码

在这个示例中，我们在协程内部使用while (isActive)来检查协程是否被取消，并在取消时通过try-catch块来处理取消。

2.3 使用`ensureActive`

ensureActive是一个函数，如果当前协程被取消了，它会抛出CancellationException。你可以在协程的关键点调用它来确保协程仍然活跃。

import kotlinx.coroutines.*
fun main() = runBlocking {    val job = launch {        try {            repeat(1000) { i ->                ensureActive() // 确保协程仍然活跃                println("job: I'm sleeping $i ...")                delay(500L)            }        } catch (e: CancellationException) {            println("Job was cancelled")        }    }    delay(1300L)    job.cancel() // 取消协程    job.join() // 等待协程结束    println("main: Now I can quit.")}

复制代码

在这个示例中，我们在协程的关键点调用ensureActive来确保协程仍然活跃。如果协程被取消了，ensureActive会抛出CancellationException，并通过try-catch块来处理取消。

2.4 使用`yield`

yield函数可以让出协程的执行权，允许其他协程运行。它也可以用于检查协程是否应该继续执行。

import kotlinx.coroutines.*
fun main() = runBlocking {    val job = launch {        try {            while (isActive) {                yield() // 让出执行权并检查取消状态                println("job: I'm sleeping ...")                delay(500L)            }        } catch (e: CancellationException) {            println("Job was cancelled")        }    }    delay(1000L)    job.cancel() // 取消协程    job.join() // 等待协程结束    println("main: Now I can quit.")}

复制代码

在这个示例中，我们在协程内部使用yield来让出执行权，并检查协程是否应该继续执行。如果协程被取消了，yield会抛出CancellationException，并通过try-catch块来处理取消。

2.5 使用`CoroutineScope`的取消

如果你在CoroutineScope中启动协程，你可以通过取消整个CoroutineScope来间接取消所有在其中启动的协程。

import kotlinx.coroutines.*
fun main() = runBlocking {    val scope = CoroutineScope()    val job = scope.launch {        try {            repeat(1000) { i ->                println("job: I'm sleeping $i ...")                delay(500L)            }        } catch (e: CancellationException) {            println("Job was cancelled")        }    }    delay(1000L)    scope.cancel() // 取消整个协程作用域    scope.join() // 等待协程作用域结束    println("main: Now I can quit.")}

复制代码

在这个示例中，我们在CoroutineScope中启动协程，并在需要时取消整个作用域。这会间接取消所有在作用域中启动的协程。

2.6 使用`select`协程构建器

select构建器可以用来构建基于选择的协程逻辑，其中可以包含取消操作。

import kotlinx.coroutines.*
fun main() = runBlocking {    val job = launch {        select<Unit> {            onCancel {                println("Coroutine was cancelled")            }            onTimeout(1000) {                println("Timeout occurred")            }        }    }    delay(1000L)    job.cancel() // 取消协程    job.join() // 等待协程结束    println("main: Now I can quit.")}

复制代码

在这个示例中，我们使用select构建器来构建基于选择的协程逻辑。我们监听取消事件，并在协程被取消时打印消息。

3. 常见理解误区

3.1 误区 1：取消协程会立即停止

取消协程并不会立即停止它。协程需要定期检查自己的取消状态，并在适当的时候退出。

3.2 误区 2：取消协程会导致异常

取消协程不会抛出异常。如果协程没有正确处理取消状态，它可能会继续运行，直到自然结束或遇到其他错误。

3.3 误区 3：`cancelAndJoin`会立即停止协程

cancelAndJoin方法会取消协程并等待它完成。但是，如果协程没有检查取消状态，它仍然不会立即停止。

4. 结论

理解协程的取消机制对于编写高效、健壮的异步代码至关重要。通过使用CompletableDeferred、isActive检查、ensureActive、yield、CoroutineScope的取消以及select协程构建器，你可以优雅地管理和取消协程，确保资源被正确释放，同时避免不必要的异常处理。

通过本文的介绍，你应该对 Kotlin 协程中的取消机制有了更深入的理解。在实际开发中，合理地使用这些机制，可以大大提高代码的健壮性和可维护性。

作为程序员，持续学习和充电非常重要，作为开发者，我们需要保持好奇心和学习热情，不断探索新的技术，只有这样，我们才能在这个快速发展的时代中立于不败之地。低代码也是一个值得我们深入探索的领域，让我们拭目以待，它将给前端世界带来怎样的变革，推荐一个低代码工具。

应用地址：https://www.jnpfsoft.com
开发语言：Java/.net

这是一个基于 Flowable 引擎(支持 java、.NET)，已支持MySQL、SqlServer、Oracle、PostgreSQL、DM（达梦）、 KingbaseES（人大金仓）6 个数据库，支持私有化部署，前后端封装了上千个常用类，方便扩展，框架集成了表单、报表、图表、大屏等各种常用的 Demo 方便直接使用。

至少包含表单建模、流程设计、报表可视化、代码生成器、系统管理、前端 UI 等组件，这种情况下我们避免了重复造轮子，已内置大量的成熟组件，选择合适的组件进行集成或二次开发复杂功能，即可自主开发一个属于自己的应用系统。

发布于: 刚刚阅读数: 5

伤感汤姆布利柏

关注

还未添加个人签名 2023-06-19 加入

还未添加个人简介

发布

暂无评论

创作场景

Kotlin 协程的取消机制：深入理解和优雅实现

1. 协程取消的基本概念

1.1 检查取消状态

1.2 取消协程

2. 优雅的取消协程

2.1 使用CompletableDeferred

2.2 使用isActive检查

2.3 使用ensureActive

2.4 使用yield

2.5 使用CoroutineScope的取消

2.6 使用select协程构建器

3. 常见理解误区

3.1 误区 1：取消协程会立即停止

3.2 误区 2：取消协程会导致异常

3.3 误区 3：cancelAndJoin会立即停止协程

4. 结论

伤感汤姆布利柏

评论

2.1 使用`CompletableDeferred`

2.2 使用`isActive`检查

2.3 使用`ensureActive`

2.4 使用`yield`

2.5 使用`CoroutineScope`的取消

2.6 使用`select`协程构建器

3.3 误区 3：`cancelAndJoin`会立即停止协程