Kotlin Coroutines 模式与反模式

原文在此,可能需要翻墙

简介

决定写一些东西,在我看来当你使用Kotlin coroutines时,这些东西你应该做和不应该做(或者说,至少试着避免做)。

处理异常时,用coroutineScope或者使用SupervisorJob包装异步调用

❌如果异步代码块可能抛出异常,不要依赖于用try/catch代码块包装

val job: Job = Job()
val scope = CoroutineScope(Dispatchers.Default + job)
// 可能抛出异常
fun doWork(): Deferred<String> = scope.async { ... }   // (1)
fun loadData() = scope.launch {
    try {
        doWork().await()                               // (2)
    } catch (e: Exception) { ... }
}

在上面例子中,doWork函数开启了新的协程(1),这个协程可能抛出一个未处理的异常。如果你试着用try/catch块包装doWork(2),它照样会崩溃。

这是因为,任意job的子job的失败,会直接导致它的父job的失败

✅避免崩溃的一种方式是使用SupervisorJob(1)

子job的失败或者取消,不会导致Supervisor job的失败,也不会影响其他子job

val job = SupervisorJob()                               // (1)
val scope = CoroutineScope(Dispatchers.Default + job)
// 可能抛出异常
fun doWork(): Deferred<String> = scope.async { ... }
fun loadData() = scope.launch {
    try {
        doWork().await()
    } catch (e: Exception) { ... }
}

注意:只有显式地用SupervisorJob在协程域上运行async,才能行得通。所以,下面的代码仍然会使得应用崩溃,因为async实在父协程的域上启动的(1)。

val job = SupervisorJob()                               
val scope = CoroutineScope(Dispatchers.Default + job)
fun loadData() = scope.launch {
    try {
        async {                                         // (1)
            // 可能抛出异常
        }.await()
    } catch (e: Exception) { ... }
}

✅ 避免崩溃的另外一种方法,也是更可取的方式,是通过用coroutineScope包裹async(1)。现在,当异常发生在async内部时,它将会取消这个域内创建的所有其他协程,而没有影响外面的域(2)。

val job = SupervisorJob()                               
val scope = CoroutineScope(Dispatchers.Default + job)
//可能抛出异常
fun doWork(): Deferred<String> = coroutineScope {     // (1)
    async { ... }
}
fun loadData() = scope.launch {                       // (2)
    try {
        doWork().await()
    } catch (e: Exception) { ... }
}

或者,你可以在async块内部处理异常。

主协程最好选择Main调度器

❌ 如果你需要做后台的工作而后在主协程中更新UI,不要在非Main调度器中启动它。

val scope = CoroutineScope(Dispatchers.Default)          // (1)
fun login() = scope.launch {
    withContext(Dispatcher.Main) { view.showLoading() }  // (2)  
    networkClient.login(...)
    withContext(Dispatcher.Main) { view.hideLoading() }  // (2)
}

在上面的例子红,我们使用Default调度器的域启动了主协程(1)。使用这个方式,当每次我们接触用户界面,我们不得不切换上下文(2)。

✅ 大多数情况下,使用Main调度器创建域是更可取的,这会使得代码更加简洁和更少的上下文显式切换。

val scope = CoroutineScope(Dispatchers.Main)
fun login() = scope.launch {
    view.showLoading()    
    withContext(Dispatcher.IO) { networkClient.login(...) }
    view.hideLoading()
}

避免使用多余的async/await

❌如果你使用async函数,然后随着直接使用await,那么你应该避免这么做。

launch {
    val data = async(Dispatchers.Default) { /* 代码 */ }.await()
}

✅ 如果你想要切换协程上下文,而且挂起父协程,那么withContext是更好的选择。

launch {
    val data = withContext(Dispatchers.Default) { /* code */ }
}

性能虽然不是一个太大的关注点(虽然async创建了新协程来做这些工作),但是语义上async暗示着,你想要在后台开启多个协程,然后在它们上await。

避免取消域的job

❌ 如果你需要取消协程,首先不要取消域的job。

class WorkManager {
    val job = SupervisorJob()
    val scope = CoroutineScope(Dispatchers.Default + job)
    fun doWork1() {
        scope.launch { /* 做一些事情 */ }
    }
    fun doWork2() {
        scope.launch { /* 做一些事情 */ }
    }
    fun cancelAllWork() {
        job.cancel()
    }
}
fun main() {
    val workManager = WorkManager()
    workManager.doWork1()
    workManager.doWork2()
    workManager.cancelAllWork()
    workManager.doWork1() // (1)
}

上面代码的问题在于,当我们取消job时,我们把它放入到completed的状态。在completed的job的域中启动的协程,不会被执行(1)。

✅ 当我们想要取消特定域中所有的协程,我们可以使用cancelChildren函数。提供取消单个job的可能,也是一个良好实践(2)。

class WorkManager {
    val job = SupervisorJob()
    val scope = CoroutineScope(Dispatchers.Default + job)
    fun doWork1(): Job = scope.launch { /* 做一些事情 */ } // (2)
    fun doWork2(): Job = scope.launch { /* 做一些事情 */ } // (2)
    fun cancelAllWork() {
        scope.coroutineContext.cancelChildren()         // (1)                             
    }
}
fun main() {
    val workManager = WorkManager()
    workManager.doWork1()
    workManager.doWork2()
    workManager.cancelAllWork()
    workManager.doWork1()
}

避免编写用隐式调度器的挂起函数

❌ 不要编写这样的挂起函数,它依赖于来自特定协程调度器的执行。

suspend fun login(): Result {
    view.showLoading()
    val result = withContext(Dispatcher.IO) {  
        someBlockingCall() 
    }
    view.hideLoading()
    return result
}

上面例子中,login函数是个挂起函数,当你在使用了非Main调度器的协程执行它的时候,这个函数会崩溃。

launch(Dispatcher.Main) {     // (1) 不崩溃
    val loginResult = login()
    ...
}
launch(Dispatcher.Default) {  // (2) 造成崩溃
    val loginResult = login()
    ...
}

CalledFromWrongThreadException: 在创建了视图层级的原来线程,才能接触它的视图

✅ 要以这样一种方式设计你的挂起函数:它可以在任何协程调度器中执行。

suspend fun login(): Result = withContext(Dispatcher.Main) {
    view.showLoading()
    val result = withContext(Dispatcher.IO) {  
        someBlockingCall() 
    }
    view.hideLoading()
    return result
}

现在,你可以在任何调度器中调用login函数。

launch(Dispatcher.Main) {     // (1) 不会崩溃
    val loginResult = login()
    ...
}
launch(Dispatcher.Default) {  // (2) 也不会崩溃
    val loginResult = login()
    ...
}

避免使用全局域

❌ 如果你在你的Android应用中到处使用GlobalScope,你需要停止这么做了。

GlobalScope.launch {
    // 代码
}

全局域使用在最顶层协程中,它在整个应用的生命周期中运行,而且不能够永久地取消。
应用代码通常使用定义应用的CoroutineScope,在GlobalScope的实例上使用async或者launch , 是非常不建议的。

✅Android中的协程,可以很容易使用到Activity、Fragment、View或者ViewModel的生命周期中。

class MainActivity : AppCompatActivity(), CoroutineScope {

    private val job = SupervisorJob()
    
    override val coroutineContext: CoroutineContext
        get() = Dispatchers.Main + job
        
    override fun onDestroy() {
        super.onDestroy()
        coroutineContext.cancelChildren()
    }
    
    fun loadData() = launch {
        // code
    }
}

特别感谢:Andrey Mischenko, Louis CA, DBradyn Poulsen, Tolriq, Dave A.

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,723评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,003评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,512评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,825评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,874评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,841评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,812评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,582评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,033评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,309评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,450评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,158评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,789评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,409评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,609评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,440评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,357评论 2 352

推荐阅读更多精彩内容