java程序員的kotlin課(N):coroutines基礎

序言

如果對協程沒有概念,不了解使用協程的好處,請參考《異步編程
》系列文章

引入協程庫

kotlin協程是以一個lib包的形式引入的,參考: kotlinx.coroutines

這里摘錄gradle方式的協程庫引入

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.3'
}

請確認使用了最新版本的kotlin

buildscript {
    ext.kotlin_version = '1.3.61'
}

語法講解

此部分翻譯至 https://kotlinlang.org/docs/reference/coroutines/basics.html,作了微調

第一個協程程序

我們使用協程來寫一個helloworld程序

fun main() {
    GlobalScope.launch { // 啟動并后臺運行一個協程
        delay(1000L) // 非阻塞的暫停1s
        println("World!") 
    }
    println("Hello,") // 主線程繼續執行
    Thread.sleep(2000L) // 主線程睡眠2秒鐘,保持當前jvm進程存活
}

輸出:

Hello,
World!

本質上,協程是一種輕量級的線程。通過launch關鍵字啟動,launch是一個協程構建器,攜帶一種CoroutineScope的上下文。上面的代碼中,我們在Global Scope中啟動了協程,這意味著,被啟動的協程的生命周期與整個進程保持一致。
我們可以通過把GlobalScope.launch { ... }替換為thread { ... }并把delay(...)替換為Thread.sleep(...)來實現同樣的效果(去試試吧!)
如果你把 GlobalScope.launch 替換為 thread(譯者:還沒來得及替換delay), 編譯器會報如下的錯:

Error: Kotlin: Suspend functions are only allowed to be called from a coroutine or another suspend function

這是因為delay是一個suspending function并不會阻塞線程但是會阻塞協程,而且他只能在協程中被調用。

阻塞和非阻塞世界的橋梁

上面的例子在同一段代碼中混用了 non-blocking delay(...)blocking Thread.sleep(...) . 這樣很容易讓我們混淆哪些是blocking哪些不是blocking的代碼. 讓我們通過 runBlocking 協程構建器來提出阻塞的代碼吧:

fun main() { 
    GlobalScope.launch { // 啟動并在后臺運行協程
        delay(1000L)
        println("World!")
    }
    println("Hello,") // 主線程直接繼續執行
    runBlocking {     // 會阻塞主線程的執行
        delay(2000L)  // 保持jvm的持續運行
    } 
}

上面的代碼執行結果是一樣的,但是只用了非阻塞的delay。主線程執行了runBlocking代碼塊,并且主線程在其代碼塊內部執行完成之前會被阻塞。
上面例子里的代碼可以被重寫成更加通用的方式:

fun main() = runBlocking<Unit> { // 啟動主協程
    GlobalScope.launch { // 啟動新協程并在后臺允許
        delay(1000L)
        println("World!")
    }
    println("Hello,") // 主協程此處直接繼續執行
    delay(2000L)      // 睡兩秒保持jvm運行
}

這里使用了runBlocking<Unit> { ... }作為一個適配器,用來在最頂層啟動主協程,我們聲明了Unit作為他的返回值類型,因為main函數需要如此。
這也是對suspending函數做單元測試的一種方法:

class MyTest {
    @Test
    fun testMySuspendingFunction() = runBlocking<Unit> {
        // here we can use suspending functions using any assertion style that we like
    }
}
等待一個任務的執行

上面幾個例子里,都是通過主函數最后睡幾秒來保持jvm進程的運行狀態,這并不是很好,讓我們來更精確的控制時間:

val job = GlobalScope.launch { //此處獲得一個job的引用
    delay(1000L)
    println("World!")
}
println("Hello,")
job.join() // 主協程等待,直到job執行完畢

現在,執行結果依然相同,但代碼好看多了!

結構化并發

如果想要在實際中使用協程,還需要考慮一些其他的事情。當我們使用GlobalScope.launch時,我們就創建了top-level的協程。雖然協程是輕量的,但協程運行時畢竟還是要消耗一些內存的。如果我們對新創建的協程沒有保持引用,而協程恰巧hangs住了,如果我們跑了海量的協程并發生內存溢出...必須要手動管理已啟動協程的引用,join 這些協程是容易出錯的。
有更好的解決方案,我們可以在代碼里使用結構化并發:基于當前操作的scope創建所需的協程,而不是使用GlobalScope
在我們的例子里我們的main函數通過runBlocking協程構建器轉換成一個協程函數。包括runBlocking在內的每一個協程構造器都會給它對應的代碼塊附加一個CoroutineScope實例。

join

我們可以基于這個scope創建新的協程,而不需顯示的join,因為外層的協程在這個scope內的所有協程介紹之前不會結束。所以我們可以讓我們的例子更加簡單:

fun main() = runBlocking { // this: CoroutineScope
    launch { // launch a new coroutine in the scope of runBlocking
        delay(1000L)
        println("World!")
    }
    println("Hello,")
}
scope構建器

上文講到每一個協程構建器會自動創建一個自己的scope,這節給大家介紹一下我們可以通過coroutineScope自定義創建scope。scope的作用就是scope不會結束在scope內部代碼和內部launch的所有協程結束之前。

fun main() = runBlocking { // this: CoroutineScope
    launch { 
        delay(200L)
        println("Task from runBlocking")
    }
    
    coroutineScope { // Creates a coroutine scope
        launch {
            delay(500L) 
            println("Task from nested launch")
        }
    
        delay(100L)
        println("Task from coroutine scope") // This line will be printed before the nested launch
    }
    
    println("Coroutine scope is over") // 在我們自定義的coroutineScope結束之前,這一行不會執行
}

輸出

Task from coroutine scope
Task from runBlocking
Task from nested launch
Coroutine scope is over

runBlockingcoroutineScope 比較相似,因為他們都會等待內部代碼塊執行完畢也會等待其內部創建的協程執行完畢。區別是一個阻塞當前線程一個阻塞當前協程,所以他們一個是普通方法,一個是suspend方法。

方法拆分重構

原文這個章節的意思沒理解透,只記錄理解的部分:
當我們做代碼拆分,把一部分代碼單獨拆分到另一個函數里時,被拆分出來的函數需要以suspend修飾,只有suspend修飾的函數才能在協程里被調用。

fun main() = runBlocking {
    launch { doWorld() }
    println("Hello,")
}

// this is your first suspending function
suspend fun doWorld() {
    delay(1000L)
    println("World!")
}

總結

coroutine builder
GlobalScope.launch {}
runBlocking
join
CoroutineScope
Scope Builder
suspend

系列文章快速導航:
java程序員的kotlin課(一):環境搭建
java程序員的kotlin課(N):coroutines基礎
java程序員的kotlin課(N+1):coroutines 取消和超時
java程序員的kotlin課(N+2):suspending函數執行編排

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,527評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,687評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,640評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,957評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,682評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,011評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,009評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,183評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,714評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,435評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,665評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,148評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,838評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,251評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,588評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,379評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,627評論 2 380