kotlin 协程之取消协程

  • 取消作用域会取消它的子协程。
  • 被取消的子协程并不会影响其余兄弟协程。
  • 协程通过抛出一个特殊的异常CancellationException来处理取消操作。
  • 所有kotlinx.coroutines中的挂起函数(withContext、delay等)都是可取消的
取消作用域会取消它的子协程
 val b = runBlocking {
        val scope = CoroutineScope(Dispatchers.Default)
        scope.launch {
            delay(1000)
            println("job 1")
        }
        scope.launch {
            delay(1000)
            println("job 2")
        }
        delay(100)
        scope.cancel()
    }

当scope协程作用被取消,其作用域中的子协程都会被取消
"job 1" 和"job 2"将都不会被输出

被取消的子协程并不会影响其余兄弟协程
 val b = runBlocking {
        val scope = CoroutineScope(Dispatchers.Default)
        val job1=scope.launch {
            delay(1000)
            println("job 1")
        }
        val job2=scope.launch {
            delay(1000)
            println("job 2")
        }
        delay(100)
        job1.cancel()
    }

输出结果:
16455-16540 I/System.out: job 2

协程通过抛出一个特殊的异常CancellationException来处理取消操作
 val b = runBlocking {
        val job1 = GlobalScope.launch {
            try {
                delay(1000)
                println("job 1")
            } catch (e: Exception) {
                e.printStackTrace()
            }

        }
        delay(100)
        job1.cancel()//调用取消会抛出CancellationException 会被静默处理,使用try catch捕获查看
        job1.join()
       // job1.cancelAndJoin() 等同上面两行代码
    }
所有kotlinx.coroutines中的挂起函数(withContext、delay等)都是可取消的

CPU密集型任务取消

  • isActive 是一个可以被使用在CoroutineScope中的扩展属性,检查Job是否处于活跃状态
  • ensureActive(),如果job处于非活跃状态,这个方法会立即执行抛出异常
  • yield函数会检查所有协程的状态,如果已经取消,则抛出CancellationException予以相应。此外,它还会尝试让出线程的执行权,给其他协程提供执行机会。
 val b = runBlocking {
        val startTime = System.currentTimeMillis()
        val job = launch(Dispatchers.Default) {
            var nextPrintTime = startTime
            var i = 0
            while (i < 5 ) {
                if (System.currentTimeMillis() >= nextPrintTime) {
                    println("job:I'm sleeping ${i++} .....")
                    nextPrintTime += 500
                }

            }
        }
        delay(1300)
        println("main:I'm tired of waiting!")
        job.cancelAndJoin()
        println("main:Now I can quit.")

输出内容:
15527-15568 I/System.out: job:I'm sleeping 0 .....
15527-15568 I/System.out: job:I'm sleeping 1 .....
15527-15568 I/System.out: job:I'm sleeping 2 .....
15527-15527 I/System.out: main:I'm tired of waiting!
15527-15568 I/System.out: job:I'm sleeping 3 .....
15527-15568 I/System.out: job:I'm sleeping 4 .....
15527-15527 I/System.out: main:Now I can quit.

任务仍然执行并没有取消成功,在CPU在做密集型计算任务时,是不允许直接取消,
可以通过job的生命周期属性来判断

val b = runBlocking {
        val startTime = System.currentTimeMillis()
        val job = launch(Dispatchers.Default) {
            var nextPrintTime = startTime
            var i = 0
            while (i < 5 && isActive) { //添加isActive job属性判断
                if (System.currentTimeMillis() >= nextPrintTime) {
                    println("job:I'm sleeping ${i++} .....")
                    nextPrintTime += 500
                }

            }
        }
        delay(1300)
        println("main:I'm tired of waiting!")
        job.cancelAndJoin()
        println("main:Now I can quit.")
    }

输出结果:
16211-16296 I/System.out: job:I'm sleeping 0 .....
16211-16296 I/System.out: job:I'm sleeping 1 .....
16211-16296 I/System.out: job:I'm sleeping 2 .....
16211-16211 I/System.out: main:I'm tired of waiting!
16211-16211 I/System.out: main:Now I can quit.

还可以使用ensureActive()来进行判断取消任务,ensureActive()内部实现同样是使用isActive来判断,但是ensureActive()会抛出CancellationException,会被静默处理,可以捕获此异常

 val b = runBlocking {
        val startTime = System.currentTimeMillis()
        val job = launch(Dispatchers.Default) {
            var nextPrintTime = startTime
            var i = 0
            while (i < 5 ) {
                ensureActive()//会抛出CancellationException
                if (System.currentTimeMillis() >= nextPrintTime) {
                    println("job:I'm sleeping ${i++} .....")
                    nextPrintTime += 500
                }

            }
        }
        delay(1300)
        println("main:I'm tired of waiting!")
        job.cancelAndJoin()
        println("main:Now I can quit.")
    }

yield函数会检查所有协程的状态,如果已经取消,则抛出CancellationException予以相应。此外,它还会尝试让出线程的执行权,给其他协程提供执行机会。

 val b = runBlocking {
        val startTime = System.currentTimeMillis()
        val job = launch(Dispatchers.Default) {
            var nextPrintTime = startTime
            var i = 0
            while (i < 5 ) {
                 yield()//会抛出CancellationException
                if (System.currentTimeMillis() >= nextPrintTime) {
                    println("job:I'm sleeping ${i++} .....")
                    nextPrintTime += 500
                }

            }
        }
        delay(1300)
        println("main:I'm tired of waiting!")
        job.cancelAndJoin()
        println("main:Now I can quit.")
    }

应用场景计算太过密集,占用了大部分资源,使用yield()可以在取消后让出执行权给其他执行

协程取消的副作用

  • 在finally中释放资源。
  • use函数:该函数只能被事项了Closeable的对象使用,程序结束的时候会自动调用close方法,适合文件对象
 val b = runBlocking {
        val job = launch(Dispatchers.Default) {
            repeat(1000) { i ->
                try {
                    println("job:I'm sleeping ${i} .....")
                    delay(500)
                } finally {
                    println("job:I'm running finally!")
                }
            }
        }
        delay(1300)
        println("main:I'm tired of waiting!")
        job.cancelAndJoin()
        println("main:Now I can quit.")
    }

输出结果:
22131-22231 I/System.out: job:I'm sleeping 0 .....
22131-22231 I/System.out: job:I'm running finally!
22131-22231 I/System.out: job:I'm sleeping 1 .....
22131-22231 I/System.out: job:I'm running finally!
22131-22231 I/System.out: job:I'm sleeping 2 .....
22131-22131 I/System.out: main:I'm tired of waiting!
22131-22231 I/System.out: job:I'm running finally!
22131-22131 I/System.out: main:Now I can quit.

use函数:

 val b = runBlocking {
        BufferedReader(FileReader("file:///android_asset/citys.json")).use{
            var line: String?
            while (true) {
                line = readLine() ?: break
                println(line)
            }
        }
    }

不能被取消的任务

  • 处于取消状态的协程不能够挂起(运行不能取消的代码),当协程被取消后需要调用挂起函数,我们需要将清理的任务代码放置于 NonCancellable CoroutineContext 中。
  • 这样会挂起运行中的代码,并保持协程的取消中状态知道任务处理完成。

超时任务

  • 很多情况下取消一个协程的理由是它有可能超时。
  • withTimeoutOrNull 通过返回null来进行超时操作,从而替代抛出一个异常

你可能感兴趣的:(kotlin 协程之取消协程)