kotlin 协程之取消协程

  • 取消作用域会取消它的子协程。
  • 被取消的子协程并不会影响其余兄弟协程。
  • 协程通过抛出一个特殊的异常CancellationException来处理取消操作。
  • 所有kotlinx.coroutines中的挂起函数(withContext、delay等)都是可取消的
取消作用域会取消它的子协程
 val b = runBlocking<Unit> {
        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<Unit> {
        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<Unit> {
        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<Unit> {
        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<Unit> {
        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<Unit> {
        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<Unit> {
        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<Unit> {
        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<Unit> {
        BufferedReader(FileReader("file:///android_asset/citys.json")).use{
            var line: String?
            while (true) {
                line = readLine() ?: break
                println(line)
            }
        }
    }

不能被取消的任务

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

超时任务

  • 很多情况下取消一个协程的理由是它有可能超时。
  • withTimeoutOrNull 通过返回null来进行超时操作,从而替代抛出一个异常
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,884评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,755评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,369评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,799评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,910评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,096评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,159评论 3 411
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,917评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,360评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,673评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,814评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,509评论 4 334
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,156评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,882评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,123评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,641评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,728评论 2 351

推荐阅读更多精彩内容