Kotlin 协程协程异常处理 ① ( 根协程异常处理 | 自动传播异常 | 在协程体捕获异常 | 向用户暴露异常 | 在 await 处捕获异常 | 非根协程异常处理 | 异常传播特性 )

Posted 2022-12-15 韩曙亮

tags:

文章目录

一、协程异常处理
二、根协程自动传播异常
- 1、异常抛出点 ( 协程体抛出异常 )
- 2、异常捕获点 ( 在协程体捕获异常 )
三、根协程向用户暴露异常
- 1、异常抛出点 ( 在 await、receive 处抛出异常 )
- 2、异常捕获点 ( 在 await、receive 处捕获异常 )
四、非根协程异常处理
五、异常传播特性

一、协程异常处理

在 协程任务 中 , 执行的代码出现异常 , 需要进行 异常处理 , 并给出错误提示信息 , 展示给用户或者上报服务器 ;

协程构建器有两种异常处理形式 :

自动传播异常 : 使用 launch 或 actor 构建器创建的根协程 , 如果出现异常 , 会马上抛出异常 ; 此类异常在可能出现异常的代码位置进行捕获即可 ;
向用户暴露异常 : 使用 async 或 produce 构建器创建的根协程 , 如果出现异常 , 则需要用户通过 await 或 receive 来处理异常 ;

注意 : 下面讨论的情况是根协程的异常传播 ;

二、根协程自动传播异常

自动传播异常 : 使用 launch 或 actor 构建器创建的根协程 , 如果出现异常 , 会马上抛出异常 ; 此类异常在可能出现异常的代码位置进行捕获即可 ;

注意 : 下面讨论的情况是根协程的异常传播 ;

1、异常抛出点 ( 协程体抛出异常 )

launch 构建器异常代码示例 : 使用 launch 构建器创建协程 , 在协程任务中抛出异常 , 查看异常的抛出点 ;

package kim.hsl.coroutine

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import kotlinx.coroutines.GlobalScope
import kotlinx.coroutines.launch
import kotlinx.coroutines.runBlocking

class MainActivity : AppCompatActivity()
    val TAG = "MainActivity"

    override fun onCreate(savedInstanceState: Bundle?) 
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        // 将主线程包装成协程
        runBlocking<Unit>

            val job = GlobalScope.launch 
                throw ArithmeticException()

执行结果 : 在第 19 行代码 , 也就是 throw ArithmeticException() 位置出现异常 , 说明 launch 构建器创建的协程抛出的异常是立即抛出 , 捕获异常也应该在该位置进行捕获 ;

23:48:34.849  E  FATAL EXCEPTION: DefaultDispatcher-worker-1
                 Process: kim.hsl.coroutine, PID: 24394
                 java.lang.ArithmeticException
                 	at kim.hsl.coroutine.MainActivity$onCreate$1$job$1.invokeSuspend(MainActivity.kt:21)
                 	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
                 	at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:106)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:571)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:750)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:678)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:665)
23:48:34.856  W    Force finishing activity kim.hsl.coroutine/.MainActivity
---------------------------- PROCESS ENDED (24394) for package kim.hsl.coroutine -----------------------------------------------

2、异常捕获点 ( 在协程体捕获异常 )

异常捕获代码示例 : 在协程任务代码中可能抛出异常的代码处捕获异常 ;

package kim.hsl.coroutine

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import kotlinx.coroutines.GlobalScope
import kotlinx.coroutines.launch
import kotlinx.coroutines.runBlocking

class MainActivity : AppCompatActivity()
    val TAG = "MainActivity"

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

        // 将主线程包装成协程
        runBlocking<Unit>

            val job = GlobalScope.launch 
                try 
                    throw ArithmeticException()
                catch (e: Exception) 
                    e.printStackTrace()

三、根协程向用户暴露异常

向用户暴露异常 : 使用 async 或 produce 构建器创建的根协程 , 如果出现异常 , 则需要用户通过 await 或 receive 来处理异常 ;

注意 : 下面讨论的情况是根协程的异常传播 ;

1、异常抛出点 ( 在 await、receive 处抛出异常 )

代码示例 : 在下面的代码中 , 如果不调用 async 构建的 Deferred 协程任务的 await 方法 , 则不会报异常 ;

package kim.hsl.coroutine

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import kotlinx.coroutines.GlobalScope
import kotlinx.coroutines.async
import kotlinx.coroutines.runBlocking

class MainActivity : AppCompatActivity()
    val TAG = "MainActivity"

    override fun onCreate(savedInstanceState: Bundle?) 
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        // 将主线程包装成协程
        runBlocking<Unit>

            val deferred = GlobalScope.async 
                throw ArithmeticException()

执行结果 :

2、异常捕获点 ( 在 await、receive 处捕获异常 )

代码示例 : 在 deferred.await() 代码处捕获异常 ;

package kim.hsl.coroutine

import android.os.Bundle
import android.util.Log
import androidx.appcompat.app.AppCompatActivity
import kotlinx.coroutines.GlobalScope
import kotlinx.coroutines.async
import kotlinx.coroutines.runBlocking

class MainActivity : AppCompatActivity()
    val TAG = "MainActivity"

    override fun onCreate(savedInstanceState: Bundle?) 
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        // 将主线程包装成协程
        runBlocking<Unit>

            val deferred = GlobalScope.async 
                throw ArithmeticException()
            

            try 
                deferred.await()
            catch (e: Exception) 
                Log.i(TAG, "捕获到了异常")
                e.printStackTrace()

执行结果 :

四、非根协程异常处理

非根协程 , 也就是子协程的异常会被传播 ;

代码示例 : 在子协程中产生的异常 , 会直接抛出 ;

package kim.hsl.coroutine

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import kotlinx.coroutines.GlobalScope
import kotlinx.coroutines.async
import kotlinx.coroutines.launch
import kotlinx.coroutines.runBlocking

class MainActivity : AppCompatActivity()
    val TAG = "MainActivity"

    override fun onCreate(savedInstanceState: Bundle?) 
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        // 将主线程包装成协程
        runBlocking<Unit>

            val job = GlobalScope.launch 
                val deferred = async 
                    // 非根协程产生的异常, 直接抛出
                    throw ArithmeticException()
                
            
            job.join()

执行结果 :

00:01:14.870  E  FATAL EXCEPTION: DefaultDispatcher-worker-2
                 Process: kim.hsl.coroutine, PID: 26818
                 java.lang.ArithmeticException
                 	at kim.hsl.coroutine.MainActivity$onCreate$1$job$1$deferred$1.invokeSuspend(MainActivity.kt:21)
                 	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
                 	at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:106)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:571)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:750)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:678)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:665)
00:01:14.876  W    Force finishing activity kim.hsl.coroutine/.MainActivity
00:01:14.883  I  Sending signal. PID: 26818 SIG: 9
00:01:14.900  I  Process kim.hsl.coroutine (pid 26818) has died: cch  CRE 
---------------------------- PROCESS ENDED (26818) for package kim.hsl.coroutine ----------------------------

五、异常传播特性

协程运行时 , 产生异常 , 会将异常传递给父协程 , 父协程会执行如下操作 :

① 取消子协程 : 不仅仅取消产生异常的子协程 , 该父协程下所有的子协程都会取消 ;
② 取消父协程 : 将父协程本身取消 ;
③ 向父协程的父协程传播异常 : 继续将异常传播给父协程的父协程 ;

Kotlin 协程协程异常处理 ② ( SupervisorJob 协程 | supervisorScope 协程作用域构建器函数 )

Kotlin 协程协程异常处理 ⑤ ( 异常传播的特殊情况 | 取消子协程示例 | 子协程抛出异常后父协程处理异常时机示例 | 异常聚合 | 多个子协程抛出的异常会聚合到第一个异常中 )

Kotlin 协程协程取消 ① ( 协程作用域取消 | 协程作用域子协程取消 | 通过抛出异常取消协程 | Job#cancel 函数 | 自定义异常取消协程 )