在kotlin协程中如何正确处理异常

在简单的kotlin中的异常处理

try {
    // some code
    throw RuntimeException("RuntimeException in 'some code'")
} catch (exception: Exception) {
    println("Handle $exception")
}

// Output:
// Handle java.lang.RuntimeException: RuntimeException in 'some code'

fun main() {
    try {
        functionThatThrows()
    } catch (exception: Exception) {
        println("Handle $exception")
    }
}

fun functionThatThrows() {
    // some code
    throw RuntimeException("RuntimeException in regular function")
}

// Output
// Handle java.lang.RuntimeException: RuntimeException in regular function

那么在协程中又是如何处理异常呢？

在Coroutines中使用try-catch

fun main() {
    val topLevelScope = CoroutineScope(Job())
    topLevelScope.launch {
        try {
            throw RuntimeException("RuntimeException in coroutine")
        } catch (exception: Exception) {
            println("Handle $exception")
        }
    }
    Thread.sleep(100)
}

// Output
// Handle java.lang.RuntimeException: RuntimeException in coroutine

但是如果我们修改代码为如下情况

fun main() {
    val topLevelScope = CoroutineScope(Job())
    topLevelScope.launch {
        try {
            launch {
                throw RuntimeException("RuntimeException in nested coroutine")
            }
        } catch (exception: Exception) {
            println("Handle $exception")
        }
    }
    Thread.sleep(100)
}

// Output
// Exception in thread "main" java.lang.RuntimeException: RuntimeException in nested coroutine

异常并没有被catch住。这是因为协程自身并不能过通过try catch来捕获异常。

协程是一种具有父子关系的Job层级结构。

job 层级结构
异常传递

如果有安装过CoroutineExceptionHandler的话，传递的异常通常会被CoroutineExceptionHandler处理，如果没有安装过，异常将会由线程的未捕获异常处理器处理。

总结1：如果协程内部没有通过try-catch处理异常，那么异常并不会被重新抛出或者被外部的try-catch捕获。异常将会在job层级结构中向上传递，将会被安装的CoroutineExceptionHandler处理，如果没有安装过，异常将会被线程的未捕获的异常处理器处理。

Coroutine Exception Handler
fun main() {
  
    val coroutineExceptionHandler = CoroutineExceptionHandler { coroutineContext, exception ->
        println("Handle $exception in CoroutineExceptionHandler")
    }
    
    val topLevelScope = CoroutineScope(Job())

    topLevelScope.launch {
        launch(coroutineExceptionHandler) {
            throw RuntimeException("RuntimeException in nested coroutine")
        }
    }

    Thread.sleep(100)
}

// Output
// Exception in thread "DefaultDispatcher-worker-2" java.lang.RuntimeException: RuntimeException in nested coroutine

我们如此修改代码，异常仍然没有被捕获。那是因为在子协程内安装CoroutineExceptionHandler是不会有任何效果的。
只有在作用域内或者顶级协程内安装CoroutineExceptionHandler才会有效果。

// ...
val topLevelScope = CoroutineScope(Job() + coroutineExceptionHandler)
// ...

或者

// ...
val topLevelScope = CoroutineScope(Job() + coroutineExceptionHandler)
// ...

效果如下

// ..
// Output: 
// Handle java.lang.RuntimeException: RuntimeException in nested coroutine in CoroutineExceptionHandler

总结2：只有安装在CoroutineScope或者顶级协程的CoroutineExceptionHandler才会生效

try-cach VS CoroutineExceptionHandler

针对如何选择try-cach 和CoroutineExceptionHandler来处理异常，官方文档也给出了如下建议：

  • CoroutineExceptionHandler是全局异常捕获的最后手段，你不能在CoroutineExceptionHandler中恢复你的操作，当相应的异常处理器被调用的时候，协程已经完成了。通常，handler是用于打印异常，显示一些错误信息，终止，还有重启应用。

  • 如果你需要在特定的代码中处理异常，那么try-cach是推荐的异常处理方法，这可以帮助你避免因为异常而终止协程，以此继续进行重试操作或者其他操作。

    总结3：如果你想要重试某些操作，或者在协程完成之前执行某些操作，那么可以考虑使用try-cach。需要注意的是，在协程内部使用了try-cach捕获该异常之后，那么这个异常将不会再向上传递，也不能使用利用结构性并发的取消函数。在i协程因异常结束需要打印异常信息的时候可以考虑使用CoroutineExceptionHandler。

launch{} VS async{}

fun main() {

    val topLevelScope = CoroutineScope(SupervisorJob())

    topLevelScope.async {
        throw RuntimeException("RuntimeException in async coroutine")
    }

    Thread.sleep(100)
}

// No output

在上述例子中，并没用打印异常。对于async来说，产生的异常同样会马上向上传递，只不过和launch相反的是，异常并不会被CoroutineExceptionHandler和线程的未捕获异常处理器处理。async内抛出的异常会被封装在Deferred内部，当我们在通过.await()获取结果的时候，异常会被重新抛出。

注意：只有当async协程是顶级协程的时候，async内的异常才会被封装在Deferred内部，除此以外，异常会被马上向上传递，并且交给CoroutineExceptionHandler处理或者线程的未捕获异常处理器处理，即使你没有调用.await()方法。

fun main() {
  
    val coroutineExceptionHandler = CoroutineExceptionHandler { coroutineContext, exception ->
        println("Handle $exception in CoroutineExceptionHandler")
    }
    
    val topLevelScope = CoroutineScope(SupervisorJob() + coroutineExceptionHandler)
    topLevelScope.launch {
        async {
            throw RuntimeException("RuntimeException in async coroutine")
        }
    }
    Thread.sleep(100)
}

// Output
// Handle java.lang.RuntimeException: RuntimeException in async coroutine in CoroutineExceptionHandler

总结4：对于launch和async未捕获的异常都会被马上向上传递，然而，如果顶级协程是由launch启动，那么异常将会由CoroutineExceptionHandler或者线程的未捕获异常处理器处理，如果顶级协程由async启动，那么异常将会被封装进Deferred，在调用.await时候重新抛出。

coroutineScope{}的异常处理特性

在文章开头，在try-cach内启动的协程内的异常不能被捕获，但如果在失败的协程外部套上coroutineScope{}函数，那就会不太一样了：

fun main() {
    
  val topLevelScope = CoroutineScope(Job())
    
  topLevelScope.launch {
        try {
            coroutineScope {
                launch {
                    throw RuntimeException("RuntimeException in nested coroutine")
                }
            }
        } catch (exception: Exception) {
            println("Handle $exception in try/catch")
        }
    }

    Thread.sleep(100)
}

// Output 
// Handle java.lang.RuntimeException: RuntimeException in nested coroutine in try/catch

catch成功捕获了异常，这是因为coroutineScope{}将失败的子协程内部的异常抛出，而没有继续向上传递。

总结5： coroutineScope{}会重新抛出失败子协程内的异常而不是将其继续向上传递，这样我就可以自己处理失败子协程的异常了。

supervisorScope{}异常处理特性

fun main() {

    val coroutineExceptionHandler = CoroutineExceptionHandler { coroutineContext, exception ->
        println("Handle $exception in CoroutineExceptionHandler")
    }

    val topLevelScope = CoroutineScope(Job())

    topLevelScope.launch {
        val job1 = launch {
            println("starting Coroutine 1")
        }

        supervisorScope {
            val job2 = launch(coroutineExceptionHandler) {
                println("starting Coroutine 2")
                throw RuntimeException("Exception in Coroutine 2")
            }

            val job3 = launch {
                println("starting Coroutine 3")
            }
        }
    }

    Thread.sleep(100)
}

// Output
// starting Coroutine 1
// starting Coroutine 2
// Handle java.lang.RuntimeException: Exception in Coroutine 2 in CoroutineExceptionHandler
// starting Coroutine 3

对于supervisorScope既不会重新抛出失败的子协程的异常也不会将异常继续向上传递。
对于job层级结构，异常会一直向上传递直到遇到顶级协程作用域或者SupervisorJob为止。

在supervisorScope内直接启动的作为顶级协程将异常封装进Deferred对象

// ... other code is identical to example above
supervisorScope {
    val job2 = async {
        println("starting Coroutine 2")
        throw RuntimeException("Exception in Coroutine 2")
    }
}
// ...

// Output: 
// starting Coroutine 1
// starting Coroutine 2
// starting Coroutine 3

只有在调用.await()的时候才会重新抛出异常。

总结6：作用域函数supervisorScope{}会在job层级中安装一个独立的新的子作用域，并使用SupervisorJob作为该作用域的job，这个新的作用域并不会将异常继续向上传递，异常将由它自己处理。在supervisorScope内直接启动的协程将作为顶级协程。顶级协程在由launch或者async启动的时候，它的表现和作为子协程时的表现将有所不同。

原文地址
异常传递流程

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 160,026评论 4赞 364
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,655评论 1赞 296
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 109,726评论 0赞 244
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 44,204评论 0赞 213
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,558评论 3赞 287
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,731评论 1赞 222
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,944评论 2赞 314
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,698评论 0赞 203
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,438评论 1赞 246
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,633评论 2赞 247
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,125评论 1赞 260
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,444评论 3赞 255
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,137评论 3赞 238
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,103评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,888评论 0赞 197
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,772评论 2赞 276
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,669评论 2赞 271