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.png7. 引申问题
本文所有的isActive
和ensureActive()
均是协程作用域的拓展属性或方法,其实本质也是协程上下文的同名变量或方法的进一步封装,而协程上下文,其实是协程所有的地方都可以拿到的变量,而协程作用域仅在个别协程API上可用。
画外音:忍住!不要展开!这里是基础篇不作铺展!
最后,必须强调,本文的协程样例代码,是通过容器收集Job对象的方式来进行的,事实上,这是个非常不合理的做法!
一来,每次书写启动协程方法的时候都要注意不能遗漏Job的收集,非常麻烦;
二来,在协程执行完成以后,由于Job对象仍在容器当中有引用,所以协程执行完后并不能及时回收对象所占用内存;
而这两个问题,通过协程作用域可以完美地自动解决!所以,接下来,才是认识协程作用域的正确学习时机!
一学就会的协程使用——基础篇(三)初遇协程取消(本文)
网友评论