Android协程(Coroutines)系列-Exception异常处理

4,418 阅读5分钟

小知识,大挑战!本文正在参与“   程序员必备小知识   ”创作活动

本文同时参与 「掘力星计划」   ,赢取创作大礼包,挑战创作激励金

📚 如果您是 Android 平台上协程的初学者,请查阅上一篇文章: Android协程(Coroutines)系列-入门

异常处理

处理协程异常一共两种方法:

  • try-catch

  • CoroutineExceptionHandler

在协程中,可以使用常规语法来处理异常:try/catch 或者内置的函数 runCatching (内部使用了 try/catch) 。

我们之前说过 未捕获的异常始终会被抛出 。但是不同的协程构建器对于异常有不同的处理方式。

Launch

在 launch 中,异常一旦发生就会立马被抛出 。因此,你可以使用 try/catch 包裹会发生异常的代码。如下所示:

scope.launch {
    try {
        doSomeThing()
    } catch(e: Exception) {
        // Handle exception
    }
}

Async

async 在根协程 (CoroutineScope 实例或者 supervisorJob 的直接子协程) 使用时,异常不会被自动抛出,而是直到你调用 .await() 时才抛出。

为了处理 async 抛出的异常,你可以在 try/catch 中调用 await

supervisorScope {
    val deferred = async {
        cdoSomeThing()
    }
    try {
        deferred.await()
    } catch(e: Exception) {
        // Handle exception thrown in async
    }
}

try-catch捕获异常

模拟请求失败的状态

interface Api {
    @GET("project/tree/json")
    suspend fun loadProjectTree(): Any

    //故意写错接口,会抛异常404
    @GET("project/tree/jsonError")
    suspend fun loadProjectTreeError(): Any
}
suspend fun loadProjectTree() {
        try {
            val result = service.loadProjectTree()
            val errorResult = service.loadProjectTreeError()
        } catch (e: Exception) {
            e.printStackTrace()
        }
    }

调用后会抛异常 HTTP 404 Not Found

由于故意将loadProjectTreeError接口中的path写错,执行流程理所当然的走进了catch里,报了404的错误。两个接口其实一个是成功,一个是失败,但当两个接口放在同一个try-catch块中,只要有一个失败,另外的请求即使是成功的,也不再执行。

如果我们想要彼此接口不影响,则需要为每个接口单独设立try-catch块。如下:

suspend fun loadProjectTree() {
        try {
            val result = service.loadProjectTree()
        } catch (e: Exception) {
            e.printStackTrace()
        }
        //分开try-catch
         try {
            val errorResult = service.loadProjectTreeError()
        } catch (e: Exception) {
            e.printStackTrace()
        }
    }

分开try-catch后 接口请求互相不影响.

上述为一般状况下处理协程异常的方法,但是在某些情况下,try-catch却也存在捕获不到异常的可能。

什么情况下try-catch会无效?

例如在协程中开启一个失败的子协程,则无法捕获。还是以上面的接口举个例子:

     fun loadProjectTree() {
        viewModelScope.launch() {
            try {
                //子协程
                launch {
                    //失败的接口
                    service.loadProjectTreeError()
                }
            } catch (e: Exception) {
                e.printStackTrace()
            }

        }
    }

运行后却发现App崩溃退出了,try-catch没有起到作用.

🚩 为什么会失效?

子协程中未捕获的异常不会被重新抛出,而是在父子层次结构中向上传播,这种异常传播将导致父Job失败

在kotlin的协程中,全局的GlobalScope是一个作用域,每个协程自身也是一个作用域,新建的协程与它的父作用域存在一个级联的关系,也就是一个父子关系层次结构。而这级联关系主要在于:

  1. 父作用域的生命周期持续到所有子作用域执行完;
  2. 当结束父作用域结束时,同时结束它的各个子作用域;
  3. 子作用域未捕获到的异常将不会被重新抛出,而是一级一级向父作用域传递,这种异常传播将导致父作用域失败,进而导致其子作用域的所有请求被取消。

上面的三点也就是协程结构化并发的特性。

✔️在这种情况下,我们就应该使用一个新的处理异常的方法:CoroutineExceptionHandler

CoroutineExceptionHandler

CoroutineExceptionHandler是用于全局“捕获所有”行为的最后一种机制。您无法在CoroutineExceptionHandler中从异常中恢复。当处理程序被调用时,协程已经完成了相应的异常。通常,该处理程序用于记录异常、显示某种错误消息、终止和/或重新启动应用程序。

    val handler =  CoroutineExceptionHandler { coroutineContext, throwable ->
        println("Caught $throwable")
    }

    fun loadProjectTree() {
        viewModelScope.launch(handler) {
            //失败的接口
            service.loadProjectTreeError()
        }
    }

根据协程的结构化并发的特性,当根协程通过launch{}启动时,异常将被传递给已附加的CoroutineExceptionHandler

📢CoroutineExceptionHandler的错误写法

    val handler =  CoroutineExceptionHandler { coroutineContext, throwable ->
        println("Caught $throwable")
    }

    fun loadProjectTree() {
        viewModelScope.launch() {
        
            //子协程
            launch(handler){
            //失败的接口
            service.loadProjectTreeError()
           }
       }
    }

由于 handler(需要放到最顶层) 没有在正确的协程上下文中使用,所以异常没有被捕获。

CoroutineExceptionHandler的不足

  1. 由于没有try-catch来捕获住异常,异常会向上传播,直到它到达RootScope或SupervisorJob,根据协程的结构化并发的特性,异常向上传播时,父协程会失败,同时父协程所级联的子协程和兄弟协程也都会失败;

如果你想并行请求多个接口,并且需要他们彼此不影响任务的执行,也就是任何一个接口异常,其他任务将继续执行,那么CoroutineExceptionHandler不是一个很好的选择。

  1. CoroutineExceptionHandler的作用在于全局捕获异常,CoroutineExceptionHandler无法在代码的特定部分处理异常,例如针对某一个失败接口,无法在异常后进行重试或者其他特定操作。

如果你想在特定部分做异常处理的话,try-catch更适合。

取消时的异常处理

在Kotlin中,我们可以从Activity中的lifecycleScope启动此等效代码,如果使用ViewModel,则可以在viewModelScope中启动此等效代码:

viewModelScope.launch {
    try {
        doSomeThing()
    } catch (e: Exception){
        
    }
}

除了本身正常抛出异常外,当Activity关闭时,还会抛出CancellationException来执行取消操作。而CancellationException我们可能不需要处理,所以需要增加一个判断:

viewModelScope.launch {
    try {
        doSomeThing()
    } catch (ce: CancellationException){
        //判断是否是`CancellationException`,如果是则不做处理
        //do nothing, activity is closing
    } catch (e: Exception){
        //方式有多种,也可以在这里判断is CancellationException
    }
}