一学就会的协程使用——基础篇(三)初遇取消

1. 引言

协程支持取消,也就是说,启动一个协程后而且在协程结束前已经不希望协程再执行代码了,可以对协程进行取消。

如果只知道协程的取消,而并不知道协程的取消需要代码配合,将会导致不符合预期的执行结果。

2. 协程的取消

其实,在每次通过launch启动协程,该函数都会返回一个Job对象。

val job = GlobalScope.launch(Dispatchers.IO) {
    // ...
}

这个Job对象理解为协程的句柄,可以用来管理协程的生命周期。

协程的生命周期设计的内容相当丰富,这里作为基础篇部分不会铺开所有的知识点(事实上,如果铺开这方面的知识点,将会牵扯到协程非常多的设计概念和理解内容,一下子吃太多,容易消化不良)。

本文主要介绍的内容便是协程生命周期里的取消部分:在不再需要协程的时候,提前让协程取消。

取消的主要API,即使前面提及的Job对象的取消函数:

job.cancel()

当在某个页面(比如Activity)中启动了一个协程,然后在页面退出后,如协程仍未执行完成,这时候最好将协程取消。

所以也很简单,在页面内所有启动协程的地方,将启动协程的Job对象保存,然后在页面销毁的回调中调用取消即可。

事实上,这样是不够的。取消不是万能的,并不能在协程任意执行点结束线程,而是需要协程执行代码中的API调用配合。

3. 协程没有达到取消效果的样例

为了说明,这里写出一段代码,主要逻辑是启动协程,协程内的执行主要逻辑为:5秒内不断循环打印log的操作,10秒后协程执行完成。

如下:

val job = GlobalScope.launch(Dispatchers.IO) {、
    "Coroutine IO runs (from loopBtn)".let {
        myLog(it)
    }
    var curMillis = System.currentTimeMillis()
    val targetMilli = curMillis + FIVE_SECONDS
    while (curMillis < targetMilli) {
        val msg = "looping (from loopBtn)"
        myLog(msg)
        curMillis = System.currentTimeMillis()
    }
    "loop finished (from loopBtn)".let {
        myLog(it)
    }
}

然后通过一个List将job收集起来:

jobList.add(job)

然后在取消按钮监听中将jobList中每个Job对象调用取消:

jobList.forEach {
    it.cancel()
}

那么,请问,如果在启动协程后的5秒之内,点击取消按钮触发协程的取消方法,协程最后一行的"loop finished (from loopBtn)"这一行log仍会不会输出?

最终结果上,是会输出的,即使在点击了取消按钮以后,循环体中的log也仍然在不断输出!

这便是,协程的取消并不是万能,并不是说启动了协程后在协程结束前调用了取消函数,协程自然就会中断而停下!也就是说,在这段代码当中,协程完全不会按照“理所当然”地产生想要的取消效果!

事实上,协程的取消是协作的,⼀段协程代码必须协作才能被取消!

上面的协程代码,即缺少了协作部分!

4. 协程取消协作途径——变量判断

在协程取消协作当中,一个不得不提的变量是isActive

通过这个变量,便可以知道协程在执行的过程中是否已经被取消。

事实上,这个变量在协程调用取消后,必然为false,但是反过来并不会成立,也就是这个变量是false,并不能说明协程被取消。

所以,在第3节的代码当中,补充这个条件的判断:

val job = GlobalScope.launch(Dispatchers.IO) {、
    "Coroutine IO runs (from loopBreakBtn)".let {
        myLog(it)
    }
    var curMillis = System.currentTimeMillis()
    val targetMilli = curMillis + FIVE_SECONDS
    while (curMillis < targetMilli) {
        if (!isActive) {
            break
        }
        val msg = "looping (from loopBreakBtn)"
        myLog(msg)
        curMillis = System.currentTimeMillis()
    }
    "loop finished (from loopBreakBtn)".let {
        myLog(it)
    }
}

这样就会发现,当这个job被取消以后,循环代码中的log不再输出,也就是循环已经跳出,但协程最后的一行log仍会输出。

如果这个是理想效果,那么可以到底为止。

5. 协程取消协作途径——函数检测

事实上,更多的情况下的需求应该是,在协程取消后,不再执行后续任何代码,也就是说,仅仅跳出循环是不够的,我们希望循环后面的所有代码都不再执行!

这种情况上,在协程取消协作上,有更好的选择,函数检测,具体的函数为:

ensureActive()

所以,进一步得,将协程执行代码再次修改为如下执行逻辑:

val job = GlobalScope.launch(Dispatchers.IO) {
    "Coroutine IO runs (from loopEnsureBtn)".let {
        myLog(it)
    }
    var curMillis = System.currentTimeMillis()
    val targetMilli = curMillis + FIVE_SECONDS
    while (curMillis < targetMilli) {
        ensureActive()
        val msg = "looping (from loopEnsureBtn)"
        myLog(msg)
        curMillis = System.currentTimeMillis()
    }
    "loop finished (from loopEnsureBtn)".let {
        myLog(it)
        stringBuilder.append(buildUIMsg(it))
    }
}

这样的话,在协程取消以后,无论是循环体还是循环体后面的log,都不会再输出,达到了理想的协程取消效果!

6. 样例工程代码

代码样例Demo,见Github:https://github.com/TeaCChen/CoroutineStudy

本文示例代码,如觉奇怪或啰嗦,其实为CancelStepOneActivity.kt中的代码摘取主要部分说明,在demo代码当中,为提升细节内容,有更加多的封装和输出内容。

本文不再列举所有的log输出内容和情况进行比较,而是直接给出结论,具体的log输出检验可自行检验。

本文的页面截图如下:

image-3-1.png

7. 引申问题

本文所有的isActiveensureActive()均是协程作用域的拓展属性或方法,其实本质也是协程上下文的同名变量或方法的进一步封装,而协程上下文,其实是协程所有的地方都可以拿到的变量,而协程作用域仅在个别协程API上可用。

画外音:忍住!不要展开!这里是基础篇不作铺展!

最后,必须强调,本文的协程样例代码,是通过容器收集Job对象的方式来进行的,事实上,这是个非常不合理的做法

一来,每次书写启动协程方法的时候都要注意不能遗漏Job的收集,非常麻烦;

二来,在协程执行完成以后,由于Job对象仍在容器当中有引用,所以协程执行完后并不能及时回收对象所占用内存;

而这两个问题,通过协程作用域可以完美地自动解决!所以,接下来,才是认识协程作用域的正确学习时机!

一学就会的协程使用——基础篇

一学就会的协程使用——基础篇(一)协程启动

一学就会的协程使用——基础篇(二)线程切换

一学就会的协程使用——基础篇(三)初遇协程取消(本文)

一学就会的协程使用——基础篇(四)协程作用域

一学就会的协程使用——基础篇(五)再遇协程取消

一学就会的协程使用——基础篇(六)初识挂起

一学就会的协程使用——基础篇(七)初识结构化

一学就会的协程使用——基础篇(八)初识协程异常

一学就会的协程使用——基础篇(九)异常与supervisor

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

推荐阅读更多精彩内容