Kotlin Coroutines 执行异步加载

Kotlin Coroutines是Kotlin推出的新的异步API。并不是解决所有问题的最优方案,但是希望在许多情况下它会使事情变得更容易一些。这里只简单的展示一下这个库在安卓中的具体使用方案。

引入Coroutines

//在application的build.gradle文件中的android节点添加如下的代码
kotlin {
    experimental {
        coroutines 'enable'
    }
}

//添加下面两行到依赖中
implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:0.20"
implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:0.20"

第一个Coroutines示例

通常我们加载一张图片到ImageView中,异步的加载任务如下所示:

fun loadBitmapFromMediaStore(imageId: Int, 
                             imagesBaseUri: Uri): Bitmap {
  val uri = Uri.withAppendedPath(imagesBaseUri, imageId.toString())
  return MediaStore.Images.Media.getBitmap(contentResolver, uri)
}

这个方法必须在后台线程中执行,因为他属于一个IO操作,这意味着我们有很多解决方案可以启动后台任务,一旦该方法返回一个bitmap,我们需要立即显示在Imageview中。

imageView.setImageBitmap(bitmap)

这行代码必须在主线程执行,否则会crash。

以上三行代码如果写到一起将会导致程序卡死或者是闪退,这都取决于合理的选择线程。接下来我们看一下使用kotlin的Coroutines是如何解决这个问题的:

val job = launch(Background) {
  val uri = Uri.withAppendedPath(imagesBaseUri, imageId.toString())
  val bitmap = MediaStore.Images.Media.getBitmap(contentResolver, 
  launch(UI) {
    imageView.setImageBitmap(bitmap)
  }
}

这里最重要的是launch()和参数BackgroundUIlaunch()表示创建和启动一个Coroutine,Background参数CoroutineContext用来保证在后台线程执行,从而保证应用程序不会卡死或者闪退,你可以声明一个如下面所示的CoroutineContext。

internal val Background = newFixedThreadPoolContext(2, "bg")

这将创建一个新的上下文,并在执行他的任务的时候使用两个常规的线程。

接下来说launch(UI),这将触发另一个coroutine,将执行在Android
的主线程。

可取消

接下来的挑战是处理跟Activity声明周期相关的东西,当你在加载一个任务,还没有执行完的时候离开了该Activity,以至于他在调用imageView.setImageBitmap(bitmap)就会引起crash,所以我们在离开该activity之前就需要取消该任务,这里就用到了launch()方法的返回值job,当activity调用onStop方法时,我们需要使用job来取消任务

job.cancel()

这就像你使用Rxjava时调用dispose和使用AsyncTask时调用cancel函数是一个道理。

LifecycleObserver

Android Architecture Components 给安卓开发者提供了特别多强大的库,其中之一就是Lifecycle API.给我们提供了一个简便的方法用来实时的监听activity和fragment的生命周期,我们定义一下代码与coroutines一起使用。

class CoroutineLifecycleListener(val deferred: Deferred<*>) : LifecycleObserver {
  @OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)
  fun cancelCoroutine() {
    if (!deferred.isCancelled) {
      deferred.cancel()
    }
  }
}

我们创建一个LifecycleOwner的扩展函数:

fun <T> LifecycleOwner.load(loader: () -> T): Deferred<T> {
  val deferred = async(context = Background, 
                       start = CoroutineStart.LAZY) {
    loader()
  }

  lifecycle.addObserver(CoroutineLifecycleListener(deferred))
  return deferred
}

这个方法中有太多新的东西,接下来一一解释:
现在我们可以在一个activity或fragment中调用load(),并从该函数中访问生命周期成员,并将我们的CoroutineLifecycleListener添加为观察者。
load方法需要一个loader作为参数,返回一个通用类型T,在load方法中我,我们调用了另外一个Coroutine的创造者async()函数,将会使用Background coroutine上下文在后台线程中执行任务,注意这个方法还有另外一个参数start = CoroutineStart.LAZY,这意味着coroutine不会立即执行,知道被调用为止。

coroutine接着会返回一个Defered<T>对象给调用者,这与我们之前的Job类似,但它也可以携带一个延迟值,如常规Java API中的JavaScript Promise或Future <T>,更好的是他有一个await方法.

接下来我们定义另外一个扩展函数then(),这次是在Deferen<T>上面定义,是我们上面的load方法返回的类型,它还将一个lambda作为参数,命名为block,它将T类型的单个对象作为其参数。

infix fun <T> Deferred<T>.then(block: (T) -> Unit): Job {
  return launch(context = UI) {
    block(this@then.await())
  }
}

这个函数将使用launch()函数创建另一个Coroutine,这次在主线程上运行。传递给此Coroutine的lambda(命名块)将完成的Deferred对象的值作为其参数。我们调用await()来挂起这个Coroutine的执行,直到Deferred对象返回一个值。
这里是coroutine变得如此令人印象深刻的地方。 await()的调用是在主线程上完成的,但是不会阻塞该线程的进一步执行。它将简单地暂停该函数的执行,直到它准备好,当它恢复并将延迟值传递给lambda时。coroutine暂停时,主线程可以继续执行其他的事情。await函数是coroutine中的一个核心概念,是什么创造了整个事物如此有魔力。

load()函数中添加的生命周期观察者将在我们的activity上调用onDestroy()后取消第一个coroutine。这也会导致第二个coroutine被取消,阻止block()被调用。

Kotlin Coroutine DSL

现在我们得到了两个扩展函数和一个会处理coroutine被取消的类,让我们来看看如何使用:

load {
  loadBitmapFromMediaStore(imageId, imagesBaseUri)
} then {
  imageView.setImageBitmap(it)
}

上面的代码中,我们将lambda方法传给load函数,该函数调用loadBitmapFromMediaStore方法,该函数必须在后台线程上执行,直到该方法返回一个Bitmap,load方法的返回值是Deferred<Bitmap>

作为扩展函数,then()方法使用infix声明,尽管load方法中返回的是Deferred<Bitmap>,但是将会传送给then方法一个bitmap返回值,所以我们可以直接在then方法中调用imageView.setImageBitmap(it)

上面的代码可以用于任何需要在后台线程上发生的异步调用,以及返回值应该返回到主线程的地方,就像上面的例子。它不像RxJava那样可以编写多个调用,但它更容易阅读,可能会涵盖很多最常见的情况。现在你可以安全地做这样的事情,而不必担心在每个调用中造成context泄漏或处理线程;

load { restApi.fetchData(query) } then { adapter.display(it) }

then()和load()方法只不过是这个新库的冰山一角,但是我确实希望在未来的基于Kotlin的Android库中出现类似的东西,一旦coroutine版本达到稳定版本。在此之前,您可以使用或修改上面的代码,或者查看Anko Coroutines。我还在GitHub上发布了一个更完整的版本。 (https://github.com/ErikHellman/KotlinAsyncWithCoroutines).

原文地址

https://hellsoft.se/simple-asynchronous-loading-with-kotlin-coroutines-f26408f97f46

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

推荐阅读更多精彩内容