Kotlinのコルーチンについて

by 虎の穴ラボ株式会社

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Slide 7

Slide 7 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 2.コルーチンについて 7 ● 「コルーチン」はWikipediaには以下のように書かれています。 Copyright © 2019 Toranoana Inc. All Rights Reserved. コルーチン（英: co-routine）とはプログラミングの構造の一種。サブルーチンがエントリーからリターンまでを一つの処理単位とするのに対し、コルーチンはいったん処理を中断した後、続きから処理を再開できる。接頭辞 co は協調を意味するが、複数のコルーチンが中断・継続により協調動作を行うことによる。（「コルーチン」『フリー百科事典　ウィキペディア日本語版』。 2019年6月4日 (火) 17:00　UTC、 URL: https://ja.wikipedia.org ）

Slide 8

Slide 8 text

Slide 9

Slide 9 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 2.コルーチンについて 9 ですが、その実装は用語なども含めて言語により異なっており、「一般的なコルーチン」というのは捉えることができませんでした。今回はあくまで「Kotlinのコルーチン」に限定したお話です。以降、「コルーチン」は全て「Kotlinのコルーチン」をさします。 Copyright © 2019 Toranoana Inc. All Rights Reserved.

Slide 10

Slide 10 text

Slide 11

Slide 11 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 11 Copyright © 2019 Toranoana Inc. All Rights Reserved. • Kotlinのコルーチンについて Webサイトには以下のように説明されています。 3.コルーチンの概要 One can think of a coroutine as a light-weight thread. Like threads, coroutines can run in parallel, wait for each other and communicate. The biggest difference is that coroutines are very cheap, almost free: we can create thousands of them, and pay very little in terms of performance. True threads, on the other hand, are expensive to start and keep around. A thousand threads can be a serious challenge for a modern machine. 「Your first coroutine with Kotlin – Kotlin Programming Language (https://kotlinlang.org/docs/tutorials/coroutines/coroutines-basic-jvm.html )」より、記述の一部を抜粋して引用

Slide 12

Slide 12 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 12 Copyright © 2019 Toranoana Inc. All Rights Reserved. • Kotlinのコルーチンについて 3.コルーチンの概要　コルーチンは軽量のスレッドと考えることができます。スレッドと同様に、コルーチンは並行して実行でき、互いに待機して通信ができます。最大の違いは、コルーチンはリソースの要求コストが非常に低いということです。これにより私たちは何千ものコルーチンを作成することができます。その一方で、本来のスレッドは非常にコストがかかります。現代のマシンでは、1000 個のスレッドの作成が深刻な問題になる場合もあります。「Your first coroutine with Kotlin – Kotlin Programming Language (https://kotlinlang.org/docs/tutorials/coroutines/coroutines-basic-jvm.html )」より、記述の一部を抜粋して引用したものを翻訳したものです

Slide 13

Slide 13 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 13 Copyright © 2019 Toranoana Inc. All Rights Reserved. ・軽量なスレッドのようなもの・（呼び出し元の）スレッドをブロックせずに非同期に動作させることができる・互いに通信ができる・軽量な為、大量に作成することができる・ Kotlinのコルーチンは「非対称コルーチン」と呼ばれるもので、中断時に呼び出し元に制御をいったん戻します 3.コルーチンの概要

Slide 14

Slide 14 text

Slide 15

Slide 15 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 15 Copyright © 2019 Toranoana Inc. All Rights Reserved. ・・・ざっくりと説明していきいます。 4.Kotlinのコルーチン用語用語説明 CoroutineDispatcher コルーチンが動作するスレッドを指定できます CoroutineContext コルーチンを動作させる為の様々な要素を含むインスタンス。CoroutineDispatcher も含みます CoroutineScope CoroutineContextを所持するインスタンス Coroutine builder コルーチンを作成する為の関数 suspending functions コルーチンを中断状態にすることのできる関数です。コルーチン、またはサスペンド関数からのみ実行することができます。

Slide 16

Slide 16 text

Slide 17

Slide 17 text

Slide 18

Slide 18 text

Slide 19

Slide 19 text

Slide 20

Slide 20 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 20 Copyright © 2019 Toranoana Inc. All Rights Reserved. 4.コルーチンビルダー　コルーチンを作成する為の関数です。　runBuilder()を除く関数がコルーチンスコープの拡張関数となっている為、基本的にコルーチンは、何かしらのコルーチンスコープに所属することになります。 4.Kotlinのコルーチン用語

Slide 21

Slide 21 text

Slide 22

Slide 22 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 22 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.サスペンド関数　コルーチンを中断状態にできる関数です。ユーザー側で定義することもできます。　サスペンド関数は、コルーチンまたはサスペンド関数からのみ呼び出すことができます。　中断状態となったコルーチンは、呼び出し元に制御を一旦戻します。 4.Kotlinのコルーチン用語

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Slide 25

Slide 25 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 25 Copyright © 2019 Toranoana Inc. All Rights Reserved. ここからはKotlinのリファレンスガイドで説明されているコードを実際に動かしながら、コルーチンの動作を見て行きます。 Coroutines Guide - Kotlin Programming Language https://kotlinlang.org/docs/reference/coroutines /coroutines-guide.html 5.コルーチンの動作

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 28 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作 fun main() = runBlocking { GlobalScope.launch { delay(1000L) println("World!") } println("Hello,") delay(2000L) } 実行結果 Hello, ←　実行してすぐに表示 World! ←　実行して 1秒後に表示

Slide 29

Slide 29 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 29 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作 fun main() = runBlocking { GlobalScope.launch { ←　❶コルーチンを作成 delay(1000L) ←　❷中断して呼び出し元に戻る println("World!") ←　❺1秒後に再開して、”World!”を出力 } println("Hello,") ←　❸”Hello,”を出力 delay(2000L) ←　❹2秒間スリープ } コルーチンが中断状態となっても、メインスレッドが動作しているのが確認できます。

Slide 30

Slide 30 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 30 Copyright © 2019 Toranoana Inc. All Rights Reserved. 用語説明・runBlocking 　コルーチンビルダー。　コルーチンを作成しておきながら、中断関数で中断しても、呼び出し元に返さずにブロックしてしまいます。　runBlocking {...}は、トップレベルのメインコルーチンを起動する為に使用してください。 5.コルーチンの動作

Slide 31

Slide 31 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 31 Copyright © 2019 Toranoana Inc. All Rights Reserved. 用語説明・GlobalScope 　アプリケーションの有効期間全体にわたって動作するグローバルなコルーチンスコープです。　アプリケーションコードは通常、（GlobalScopeではなく）アプリケーション定義のコルーチンスコープを使用する必要があります。 5.コルーチンの動作

Slide 32

Slide 32 text

Slide 33

Slide 33 text

Slide 34

Slide 34 text

Slide 35

Slide 35 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 35 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作 fun main() = runBlocking { val job = GlobalScope.launch { delay(1000L) println("World!") } println("Hello,") job.join() } 実行結果 Hello, ←　実行してすぐに表示 World! ←　実行して 1秒後に表示

Slide 36

Slide 36 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 36 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作 fun main() = runBlocking { val job = GlobalScope.launch { ← ❶ 新しいコルーチンを起動し、その参照を取得 delay(1000L) println("World!") } println("Hello,") job.join() ← ❷ コルーチンの処理が完了するまで待ちます } job.join()により、コルーチンの完了を待っているのが確認できます。

Slide 37

Slide 37 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 37 Copyright © 2019 Toranoana Inc. All Rights Reserved. 用語説明・join() 　launch コルーチンビルダーが返す Job インスタンスが持つサスペンド関数。　コルーチンの完了を待つことができます。　他にJobインスタンスでは、cancel()によりコルーチンのキャンセルなども行えます。　 5.コルーチンの動作

Slide 38

Slide 38 text

Slide 39

Slide 39 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 39 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作 fun main() = runBlocking { withTimeout(1300L) { repeat(1000) { i -> println("I'm sleeping $i ...") delay(500L) } } } 実行結果 I'm sleeping 0 ... I'm sleeping 1 ... I'm sleeping 2 ... Exception in thread "main" kotlinx.coroutines.TimeoutCancellationException: Timed out waiting for 1300 ms

Slide 40

Slide 40 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 40 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作 fun main() = runBlocking { withTimeout(1300L) { ← ❶ 指定時間が経過すると、 TimeoutCancellationExceptionが発生します repeat(1000) { i -> println("I'm sleeping $i ...") delay(500L) } } } withTimeoutによってスローされる TimeoutCancellationExceptionにより、コルーチンがキャンセルされるのが確認できます。

Slide 41

Slide 41 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 41 Copyright © 2019 Toranoana Inc. All Rights Reserved. 用語説明・withTimeout() 　コルーチン内の指定されたコードブロックを実行し、タイムアウト時間を超えた場合は TimeoutCancellationException をスローします。　コルーチンの中では TimeoutCancellationException はコルーチンの完了の通常の理由であると見なされます。 5.コルーチンの動作

Slide 42

Slide 42 text

Slide 43

Slide 43 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 43 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作 fun main() = runBlocking { val time = measureTimeMillis { val one = async { doSomethingUsefulOne() } val two = async { doSomethingUsefulTwo() } println("The answer is ${one.await() + two.await()}") } println("Completed in $time ms") } suspend fun doSomethingUsefulOne(): Int { delay(1000L) // pretend we are doing something useful here return 13 } suspend fun doSomethingUsefulTwo(): Int { delay(1000L) // pretend we are doing something useful here, too return 29 }

Slide 44

Slide 44 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 44 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作実行結果 The answer is 42 Completed in 1051 ms fun main() = runBlocking { val time = measureTimeMillis { val one = async { doSomethingUsefulOne() } ← ❶ コルーチン起動 val two = async { doSomethingUsefulTwo() } ← ❶ コルーチン起動 println("The answer is ${one.await() + two.await()}") ← ❷ 2つのコルーチンの完了と戻り値を待ち、出力 } println("Completed in $time ms") }

Slide 45

Slide 45 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 45 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作 fun main() = runBlocking { val time = measureTimeMillis { val one = async { doSomethingUsefulOne() } ← ❶ コルーチン起動 val two = async { doSomethingUsefulTwo() } ← ❶ コルーチン起動 println("The answer is ${one.await() + two.await()}") ← ❷ 2つのコルーチンの完了と戻り値を待ち、出力 } println("Completed in $time ms") } それぞれ別の関数を実行するコルーチンの完了を待ち、それぞれの戻り値を得て計算が行えているのが確認できます。

Slide 46

Slide 46 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 46 Copyright © 2019 Toranoana Inc. All Rights Reserved. 用語説明・async 　コルーチンビルダー。　コルーチンを作成し、戻り値としてDeferredの実装を返します。DeferredはJobインタフェースを継承している為、Job同様、実行中のコルーチンのキャンセルや完了の待機なども可能です。 5.コルーチンの動作

Slide 47

Slide 47 text

Slide 48

Slide 48 text

Slide 49

Slide 49 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 49 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作 fun main() = runBlocking { val channel = Channel() launch { for (x in 1..5) channel.send(x * x) } // ここでは5つの受信整数を表示します: repeat(5) { println(channel.receive()) } println("Done!") } 実行結果 1 4 9 16 25 Done!

Slide 50

Slide 50 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 50 Copyright © 2019 Toranoana Inc. All Rights Reserved. 5.コルーチンの動作 fun main() = runBlocking { val channel = Channel() launch { for (x in 1..5) channel.send(x * x) ← ❶ 計算結果を channel に送信 } // ここでは5つの受信整数を表示します: repeat(5) { println(channel.receive()) } ← ❷ channel から受信して表示 println("Done!") } コルーチン内部で順次送信される計算結果を、メインスレッド側で受信して表示できているのが確認できます。

Slide 51

Slide 51 text

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 51 Copyright © 2019 Toranoana Inc. All Rights Reserved. 用語説明・Channel 　コルーチン用の通信用チャンネル。　関数として sendとreceiveを持ち、これにより通信が行えます。　これは現在のところ実験的(experimental)な実装になっているので注意してください。 5.コルーチンの動作