如何正確的在 Android 上使用協程？

前言你還記得是哪一年的 Google IO 正式宣佈成為 Android 一級開發語言嗎？是。如今兩年時間過去了，站在一名 Android 開發者的角度來看，Kotlin 的生態環境越來越好了，相關的開源項目和學習資料也日漸豐富，身邊願意去使用或者試用 Kotlin 的朋友也變多了。常年混跡掘 ...

前言

你還記得是哪一年的 Google IO 正式宣佈 Kotlin 成為 Android 一級開發語言嗎？是 Google IO 2017 。如今兩年時間過去了，站在一名 Android 開發者的角度來看，Kotlin 的生態環境越來越好了，相關的開源項目和學習資料也日漸豐富，身邊願意去使用或者試用 Kotlin 的朋友也變多了。常年混跡掘金的我也能明顯感覺到 Kotlin 標簽下的文章慢慢變多了（其實仍然少的可憐）。今年的 Google IO 也放出了 Kotlin First 的口號，許多新的 API 和功能特性將優先提供 Kotlin 支持。所以，時至今日，實在找不到安卓開發者不學 Kotlin 的理由了。

今天想聊聊的是 Kotlin Coroutine。雖然在 Kotlin 發佈之初就有了協程，但是直到 2018 年的 KotlinConf 大會上，JetBrain 發佈了 Kotlin1.3RC，這才帶來了穩定版的協程。即使穩定版的協程已經發佈了一年之餘，但是好像並沒有足夠多的用戶，至少在我看來是這樣。在我學習協程的各個階段中，遇到問題都鮮有地方可以求助，拋到技術群基本就石沉大海了。基本只能靠一些英文文檔來解決問題。

關於協程的文章我看過很多，總結一下，無非下麵幾類。

第一類是 Medium 上熱門文章的翻譯，其實我也翻譯過：

在 Android 上使用協程（一）：Getting The Background

在 Android 上使用協程（二）：Getting started

在 Android 上使用協程（三）：Real Work

說實話，這三篇文章的確加深了我對協程的理解。

第二類就是官方文檔的翻譯了，我看過至少不下於五個翻譯版本，還是覺得看官網文檔比較好，如果英文看著實在吃力，可以對照著 Kotlin 中文站的翻譯來閱讀。

在看完官方文檔的很長一段時間，我幾乎只知道 GlobalScope。的確，官方文檔上基本從頭到尾都是在用 GlobalScope 寫示例代碼。所以一部分開發者，也包括我自己，在寫自己的代碼時也就直接 GlobalScope 了。一次偶然的機會才發現其實這樣的問題是很大的。在 Android 中，一般是不建議直接使用 GlobalScope 的。那麼，在 Android 中應該如何正確使用協程呢？再細分一點，如何直接在 Activity 中使用呢？如何配合 ViewModel 、LiveData 、LifeCycle 等使用呢？我會通過簡單的示例代碼來闡述 Android 上的協程使用，你也可以跟著動手敲一敲。

協程在 Android 上的使用

GlobalScope

在一般的應用場景下，我們都希望可以非同步進行耗時任務，比如網路請求，數據處理等等。當我們離開當前頁面的時候，也希望可以取消正在進行的非同步任務。這兩點，也正是使用協程中所需要註意的。既然不建議直接使用 GlobalScope，我們就先試驗一下使用它會是什麼效果。

private fun launchFromGlobalScope() {
    GlobalScope.launch(Dispatchers.Main) {
        val deferred = async(Dispatchers.IO) {
            // network request
            delay(3000)
            "Get it"
        }
        globalScope.text = deferred.await()
        Toast.makeText(applicationContext, "GlobalScope", Toast.LENGTH_SHORT).show()
    }
}

在 launchFromGlobalScope() 方法中，我直接通過 GlobalScope.launch() 啟動一個協程，delay(3000) 模擬網路請求，三秒後，會彈出一個 Toast 提示。使用上是沒有任何問題的，可以正常的彈出 Toast 。但是當你執行這個方法之後，立即按返回鍵返回上一頁面，仍然會彈出 Toast 。如果是實際開發中通過網路請求更新頁面的話，當用戶已經不在這個頁面了，就根本沒有必要再去請求了，只會浪費資源。GlobalScope 顯然並不符合這一特性。Kotlin 文檔中其實也詳細說明瞭，如下所示:

Global scope is used to launch top-level coroutines which are operating on the whole application lifetime and are not cancelled prematurely. Another use of the global scope is operators running in Dispatchers.Unconfined, which don’t have any job associated with them.

Application code usually should use an application-defined CoroutineScope. Using async or launch on the instance of GlobalScope is highly discouraged.

大致意思是，Global scope 通常用於啟動頂級協程，這些協程在整個應用程式生命周期內運行，不會被過早地被取消。程式代碼通常應該使用自定義的協程作用域。直接使用 GlobalScope 的 async 或者 launch 方法是強烈不建議的。

GlobalScope 創建的協程沒有父協程，GlobalScope 通常也不與任何生命周期組件綁定。除非手動管理，否則很難滿足我們實際開發中的需求。所以，GlobalScope 能不用就儘量不用。

MainScope

官方文檔中提到要使用自定義的協程作用域，當然，Kotlin 已經給我們提供了合適的協程作用域 MainScope 。看一下 MainScope 的定義：

public fun MainScope(): CoroutineScope = ContextScope(SupervisorJob() + Dispatchers.Main)

記著這個定義，在後面 ViewModel 的協程使用中也會借鑒這種寫法。

給我們的 Activity 實現自己的協程作用域：

class BasicCorotineActivity : AppCompatActivity(), CoroutineScope by MainScope() {}

通過擴展函數 launch() 可以直接在主線程中啟動協程，示例代碼如下：

private fun launchFromMainScope() {
    launch {
        val deferred = async(Dispatchers.IO) {
            // network request
            delay(3000)
            "Get it"
        }
        mainScope.text = deferred.await()
        Toast.makeText(applicationContext, "MainScope", Toast.LENGTH_SHORT).show()
    }
}

最後別忘了在 onDestroy() 中取消協程，通過擴展函數 cancel() 來實現：

override fun onDestroy() {
    super.onDestroy()
    cancel()
}

現在來測試一下 launchFromMainScope() 方法吧！你會發現這完全符合你的需求。實際開發中可以把 MainScope 整合到 BaseActivity 中，就不需要重覆書寫模板代碼了。

ViewModelScope

如果你使用了 MVVM 架構，根本就不會在 Activity 上書寫任何邏輯代碼，更別說啟動協程了。這個時候大部分工作就要交給 ViewModel 了。那麼如何在 ViewModel 中定義協程作用域呢？還記得上面 MainScope() 的定義嗎？沒錯，搬過來直接使用就可以了。

class ViewModelOne : ViewModel() {

    private val viewModelJob = SupervisorJob()
    private val uiScope = CoroutineScope(Dispatchers.Main + viewModelJob)

    val mMessage: MutableLiveData<String> = MutableLiveData()

    fun getMessage(message: String) {
        uiScope.launch {
            val deferred = async(Dispatchers.IO) {
                delay(2000)
                "post $message"
            }
            mMessage.value = deferred.await()
        }
    }

    override fun onCleared() {
        super.onCleared()
        viewModelJob.cancel()
    }
}

這裡的 uiScope 其實就等同於 MainScope。調用 getMessage() 方法和之前的 launchFromMainScope() 效果也是一樣的，記得在 ViewModel 的 onCleared() 回調里取消協程。

你可以定義一個 BaseViewModel 來處理這些邏輯，避免重覆書寫模板代碼。然而 Kotlin 就是要讓你做同樣的事，寫更少的代碼，於是 viewmodel-ktx 來了。看到 ktx ，你就應該明白它是來簡化你的代碼的。引入如下依賴：

implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.2.0-alpha03"

然後，什麼都不需要做，直接使用協程作用域 viewModelScope 就可以了。viewModelScope 是 ViewModel 的一個擴展屬性，定義如下：

val ViewModel.viewModelScope: CoroutineScope
        get() {
            val scope: CoroutineScope? = this.getTag(JOB_KEY)
            if (scope != null) {
                return scope
            }
            return setTagIfAbsent(JOB_KEY,
                CloseableCoroutineScope(SupervisorJob() + Dispatchers.Main))
        }

看下代碼你就應該明白了，還是熟悉的那一套。當 ViewModel.onCleared() 被調用的時候，viewModelScope 會自動取消作用域內的所有協程。使用示例如下：

fun getMessageByViewModel() {
    viewModelScope.launch {
        val deferred = async(Dispatchers.IO) { getMessage("ViewModel Ktx") }
        mMessage.value = deferred.await()
    }
}

寫到這裡，viewModelScope 是能滿足需求的最簡寫法了。實際上，寫完全篇，viewModelScope 仍然是我認為的最好的選擇。

LiveData

Kotlin 同樣為 LiveData 賦予了直接使用協程的能力。添加如下依賴：

implementation "androidx.lifecycle:lifecycle-livedata-ktx:2.2.0-alpha03"

直接在 liveData {} 代碼塊中調用需要非同步執行的掛起函數，並調用 emit() 函數發送處理結果。示例代碼如下所示：

val mResult: LiveData<String> = liveData {
    val string = getMessage("LiveData Ktx")
    emit(string)
}

你可能會好奇這裡好像並沒有任何的顯示調用，那麼，liveData 代碼塊是在什麼執行的呢？當 LiveData 進入 active 狀態時，liveData{ } 會自動執行。當 LiveData 進入 inactive 狀態時，經過一個可配置的 timeout 之後會自動取消。如果它在完成之前就取消了，當 LiveData 再次 active 的時候會重新運行。如果上一次運行成功結束了，就不會再重新運行。也就是說只有自動取消的 liveData{ } 可以重新運行。其他原因（比如 CancelationException）導致的取消也不會重新運行。

所以 livedata-ktx 的使用是有一定限制的。對於需要用戶主動刷新的場景，就無法滿足了。在一次完整的生命周期內，一旦成功執行完成一次，就沒有辦法再觸發了。 這句話不知道對不對，我個人是這麼理解的。因此，還是 viewmodel-ktx 的適用性更廣，可控性也更好。

LifecycleScope

implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.2.0-alpha03"

lifecycle-runtime-ktx 給每個 LifeCycle 對象通過擴展屬性定義了協程作用域 lifecycleScope 。你可以通過 lifecycle.coroutineScope 或者 lifecycleOwner.lifecycleScope 進行訪問。示例代碼如下：

fun getMessageByLifeCycle(lifecycleOwner: LifecycleOwner) {
    lifecycleOwner.lifecycleScope.launch {
        val deferred = async(Dispatchers.IO) { getMessage("LifeCycle Ktx") }
        mMessage.value = deferred.await()
    }
}

當 LifeCycle 回調 onDestroy() 時，協程作用域 lifecycleScope 會自動取消。在 Activity/Fragment 等生命周期組件中我們可以很方便的使用，但是在 MVVM 中又不會過多的在 View 層進行邏輯處理，viewModelScope 基本就可以滿足 ViewModel 中的需求了，lifecycleScope 也顯得有點那麼食之無味。但是他有一個特殊的用法：

suspend fun <T> Lifecycle.whenCreated()
suspend fun <T> Lifecycle.whenStarted()
suspend fun <T> Lifecycle.whenResumed()
suspend fun <T> LifecycleOwner.whenCreated()
suspend fun <T> LifecycleOwner.whenStarted()
suspend fun <T> LifecycleOwner.whenResumed()

可以指定至少在特定的生命周期之後再執行掛起函數，可以進一步減輕 View 層的負擔。

總結

以上簡單的介紹了在 Android 中合理使用協程的一些方案，示例代碼已上傳至 Github。關於 MVVM + 協程 的實戰項目，可以看看我的開源項目 wanandroid，同時也期待你寶貴的意見。

文章首發微信公眾號： 秉心說 ，專註 Java 、 Android 原創知識分享，LeetCode 題解。

更多最新原創文章，掃碼關註我吧！

如何正確的在 Android 上使用協程 ？

前言