【Kotlin 协程】协程底层实现 ③ ( 结构化并发 | MainScope 作用域 | 取消协程作用域 | Activity 实现 CoroutineScope 协程作用域接口 )

常见的 CoroutineScope 协程作用域 :

• GlobalScope : 该作用域是 进程级别的 , 与应用进程同级 , 即使 Activity 被销毁 , 协程任务也可以继续执行 ;
• MainScope : 该 作用域仅在 Activty 中 , 如果 Activity 被销毁 , 则 在 onDestory 生命周期函数中取消协程任务 ;
• viewModelScope : 该作用与仅在 ViewModel 中使用 , 与 ViewModel 生命周期绑定 ;
• lifecycleScope : 该作用与仅在 Activity 中使用 , 与 Activity 生命周期绑定 ;

一、MainScope 协程作用域

---

MainScope 是一个 函数 , 其返回值类型为 CoroutineScope 协程作用域 ; 这是使用了设计模式中的 工厂模式 , 生产一个 协程作用域 实例对象 ; 之后的 协程操作都要定义在该协程作用域中 ;

public fun MainScope(): CoroutineScope = ContextScope(SupervisorJob() + Dispatchers.Main)

MainScope 协程作用域 与之前使用的 GlobalScope 协程作用域 作用相同 , 执行 lunch 函数 , 后面的代码块就是协程作用域 , 在其中执行协程任务 ;

CoroutineScope.launch 函数 是 协程作用域的扩展函数 , 其后的代码块参数就是 协程作用域 , 在其中执行协程任务 ;

public fun CoroutineScope.launch(
    context: CoroutineContext = EmptyCoroutineContext,
    start: CoroutineStart = CoroutineStart.DEFAULT,
    block: suspend CoroutineScope.() -> Unit
): Job {
    val newContext = newCoroutineContext(context)
    val coroutine = if (start.isLazy)
        LazyStandaloneCoroutine(newContext, block) else
        StandaloneCoroutine(newContext, active = true)
    coroutine.start(start, coroutine, block)
    return coroutine
}

代码示例 :

mainScope.launch {
    // 协程作用域, 在该代码块中执行协程任务
    // Dispatchers.IO 是协程任务调度器, 用于执行耗时操作
    withContext(Dispatchers.IO){
        Log.i("MainActivity", "withContext : 协程中执行耗时操作")
    }

	// 挂起函数, 可以不使用协程调度器
	delay(20000)

    // 主线程更新 UI
    Log.i("MainActivity", "GlobalScope : 主线程更新 UI")
}

如果在 协程作用域 中 , 执行一个挂起函数 , 如 delay 函数 , 则可以不用 Dispatchers.IO 是协程任务调度器 , 执行挂起函数 , 系统会自动分配一个 协程任务调度器 ;

二、取消 MainScope 协程作用域

---

调用 MainScope 协程作用域 的 cancel 函数 , 即可取 消该 协程作用域 , 同时 该协程作用域内的协程任务不管是否执行完毕 都一并取消 , 该函数是 CoroutineScope 的扩展函数 ;

／**
   * 取消这个范围，包括它的作业和它的所有子任务，可选的取消[原因]。
   * 原因可以用来指定错误消息或提供其他细节为调试目的而取消的原因。
   * 如果作用域中没有作业，抛出[IllegalStateException]。
   * /
public fun CoroutineScope.cancel(cause: CancellationException? = null) {
    val job = coroutineContext[Job] ?: error("Scope cannot be cancelled because it does not have a job: $this")
    job.cancel(cause)
}

只要是通过该 private val mainScope = MainScope() 协程作用域 启动的协程任务 , 如果取消 mainScope 协程作用域 , 则在该 协程作用域 中执行的 协程任务 , 都会被取消 ;

挂起函数中途被取消 会抛出 JobCancellationException 异常 , 异常信息如下 :

kotlinx.coroutines.JobCancellationException: Job was cancelled; job=SupervisorJobImpl{Cancelling}@57a393b

在 Activity 的 onDestroy 生命周期 函数中 , 取消 协程作用域 ;

    override fun onDestroy() {
        super.onDestroy()
        // 在 Activity 销毁前取消协程作用域
        mainScope.cancel()
    }

完整代码如下 :

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.util.Log
import kotlinx.coroutines.*

class MainActivity : AppCompatActivity() {

    /**
     * 协程作用域
     * 该 作用域仅在 Activty 中 , 如果 Activity 被销毁 ,
     * 则 在 onDestory 生命周期函数中取消协程任务 ;
     */
    private val mainScope = MainScope()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        mainScope.launch {
            // 协程作用域, 在该代码块中执行协程任务
            // Dispatchers.IO 是协程任务调度器, 用于执行耗时操作
            withContext(Dispatchers.IO){
                Log.i("MainActivity", "withContext : 协程中执行耗时操作")
            }

            try{
                // 挂起函数, 可以不使用协程调度器
                delay(20000)
            }catch (e : Exception){
                Log.i("MainActivity", "中断挂起函数任务, 报异常:")
                e.printStackTrace()
            }

            // 主线程更新 UI
            Log.i("MainActivity", "GlobalScope : 主线程更新 UI")
        }
	}
	
    override fun onDestroy() {
        super.onDestroy()
        // 在 Activity 销毁前取消协程
        mainScope.cancel()
    }
}

三、Activity 实现 CoroutineScope 协程作用域接口

---

通过委托方式 , 继承 CoroutineScope 接口 ,

public interface CoroutineScope {
    public val coroutineContext: CoroutineContext
}

即可 将整个 协程作用域 委托给 Activity ,

class MainActivity : AppCompatActivity(), CoroutineScope by MainScope()

在 Activity 中可以 直接调用 launch 函数执行协程任务 , 调用 cancel 函数取消协程作用域 ;

完整代码如下 :

package kim.hsl.coroutine

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.util.Log
import kotlinx.coroutines.*

class MainActivity : AppCompatActivity(), CoroutineScope by MainScope() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
		
		// 此处直接调用 协程作用域 CoroutineScope 的 launch 扩展函数
        launch {
            // 协程作用域, 在该代码块中执行协程任务
            // Dispatchers.IO 是协程任务调度器, 用于执行耗时操作
            withContext(Dispatchers.IO){
                Log.i("MainActivity", "withContext : 协程中执行耗时操作")
            }

            try{
                // 挂起函数, 可以不使用协程调度器
                delay(20000)
            }catch (e : Exception){
                Log.i("MainActivity", "中断挂起函数任务, 报异常:")
                e.printStackTrace()
            }

            // 主线程更新 UI
            Log.i("MainActivity", "GlobalScope : 主线程更新 UI")
        }
    }

    override fun onDestroy() {
        super.onDestroy()
        // 此处直接调用 协程作用域 CoroutineScope 的 cancel 扩展函数
        cancel()
    }
}