Kotlin コルーチンを理解しよう 2019 - KotlinFest2019 -

by yagi

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

Slide 8

Slide 8 text

8 コルーチンとはなにかメルヴィン・コンウェイの 1963年の論⽂が初出 ※実装は機械語で1958年にあったらしい © 2019 Ubie, Inc. IUUQNFMDPOXBZDPN)PNFQEGDPNQJMFSQEG IUUQTUBGGVNFEVNUKTLMUBMLIUNM 1967年にSimulaがプログラミング⾔語としては初めてコルーチンを実装したらしい Modula-2 様々な⾔語で⾊々な実装 generator, async/await

Slide 9

Slide 9 text

Slide 10

Slide 10 text

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Slide 13

Slide 13 text

Slide 14

Slide 14 text

Slide 15

Slide 15 text

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

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

Slide 29

Slide 29 text

Slide 30

Slide 30 text

Slide 31

Slide 31 text

Slide 32

Slide 32 text

Slide 33

Slide 33 text

Slide 34

Slide 34 text

Slide 35

Slide 35 text

Slide 36

Slide 36 text

Slide 37

Slide 37 text

Slide 38

Slide 38 text

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Slide 41

Slide 41 text

Slide 42

Slide 42 text

Slide 43

Slide 43 text

Slide 44

Slide 44 text

Slide 45

Slide 45 text

45 suspendラムダとコルーチン © 2019 Ubie, Inc. suspend fun getProfile(id: Int): Profile suspend fun loadProfile(id: Int) { val profile = getProfile(id) showProfile(profile) } 通常の関数からsuspend関数が呼び出せないとすると、そもそもどうやって呼び出せばいいのか?

Slide 46

Slide 46 text

Slide 47

Slide 47 text

Slide 48

Slide 48 text

Slide 49

Slide 49 text

Slide 50

Slide 50 text

Slide 51

Slide 51 text

Slide 52

Slide 52 text

52 Kotlinにおけるコルーチンの仕組み © 2019 Ubie, Inc. ঢ়ଶ ঢ়ଶ ঢ়ଶ Kotlinプログラム ঢ়ଶ ঢ়ଶ ঢ়ଶ suspendラムダ suspend関数中断と再開コンパイルコルーチン https://speakerdeck.com/sys1yagi/kotlin-korutinwo-li-jie-siyou どのようにコルーチンに変換しているかの詳細は前回の資料を参照してください

Slide 53

Slide 53 text

Slide 54

Slide 54 text

54 Kotlinにおけるコルーチンの仕組み © 2019 Ubie, Inc. ঢ়ଶ ঢ়ଶ ঢ়ଶ Kotlinプログラム ঢ়ଶ ঢ়ଶ ঢ়ଶ suspendラムダのステートマシン suspend関数のステートマシン CPSによる中断と再開コンパイルコルーチンコルーチンライブラリ CoroutineDispatcher launch, async Job, Deferred CoroutineScope CoroutineStart 実⾏キャンセルスレッドプール割り込み例外ハンドラスコープ etc

Slide 55

Slide 55 text

55 Kotlinにおけるコルーチンの仕組み © 2019 Ubie, Inc. ঢ়ଶ ঢ়ଶ ঢ়ଶ Kotlinプログラム ঢ়ଶ ঢ়ଶ ঢ়ଶ suspendラムダのステートマシン suspend関数のステートマシン CPSによる中断と再開コンパイルコルーチンコルーチンライブラリ CoroutineDispatcher launch, async Job, Deferred CoroutineScope CoroutineStart コルーチンの実⾏や管理はライブラリが提供する実⾏キャンセルスレッドプール割り込み例外ハンドラスコープ etc

Slide 56

Slide 56 text

56 Kotlinにおけるコルーチンの仕組み © 2019 Ubie, Inc. ঢ়ଶ ঢ়ଶ ঢ়ଶ Kotlinプログラム ঢ়ଶ ঢ়ଶ ঢ়ଶ suspendラムダのステートマシン suspend関数のステートマシン CPSによる中断と再開コンパイルコルーチンコルーチンライブラリ CoroutineDispatcher launch, async Job, Deferred CoroutineScope CoroutineStart コルーチンの実⾏や管理はライブラリが提供する実⾏キャンセルスレッドプール割り込み例外ハンドラスコープ etc Kotlinのコルーチンの話はほぼこのライブラリの使い⽅の話

Slide 57

Slide 57 text

Slide 58

Slide 58 text

Slide 59

Slide 59 text

59 コルーチンライブラリを導⼊する © 2019 Ubie, Inc. implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core: 1.3.0" implementation “org.jetbrains.kotlinx:kotlinx-coroutines-android: 1.3.0-RC2” implementation “org.jetbrains.kotlinx:kotlinx-coroutines-play-services: 1.3.0-RC2” implementation “org.jetbrains.kotlinx:kotlinx-coroutines-rx2: 1.3.0-RC2” https://github.com/Kotlin/kotlinx.coroutines build.gradle

Slide 60

Slide 60 text

60 コルーチンライブラリを導⼊する © 2019 Ubie, Inc. implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core: 1.3.0" implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android: 1.3.0" implementation "org.jetbrains.kotlinx:kotlinx-coroutines-play-services: 1.3.0" implementation "org.jetbrains.kotlinx:kotlinx-coroutines-rx2: 1.3.0" https://github.com/Kotlin/kotlinx.coroutines build.gradle

Slide 61

Slide 61 text

Slide 62

Slide 62 text

Slide 63

Slide 63 text

Slide 64

Slide 64 text

Slide 65

Slide 65 text

Slide 66

Slide 66 text

Slide 67

Slide 67 text

67 コルーチンビルダー関数 © 2019 Ubie, Inc. • コルーチンを起動する関数 • 実⾏コンテキスト、開始⽅法、suspendラムダを渡してコルーチンを起動できる • ノンブロッキングで動作する • 結果を返さないlaunch関数と、結果を返すasync関数がある。 public fun CoroutineScope.launch( context: CoroutineContext start: CoroutineStart block: suspend CoroutineScope.() -> Unit ): Job public fun CoroutineScope.async( context: CoroutineContext start: CoroutineStart block: suspend CoroutineScope.() -> T ): Deferred

Slide 68

Slide 68 text

Slide 69

Slide 69 text

Slide 70

Slide 70 text

Slide 71

Slide 71 text

Slide 72

Slide 72 text

Slide 73

Slide 73 text

Slide 74

Slide 74 text

Slide 75

Slide 75 text

Slide 76

Slide 76 text

Slide 77

Slide 77 text

Slide 78

Slide 78 text

Slide 79

Slide 79 text

Slide 80

Slide 80 text

Slide 81

Slide 81 text

Slide 82

Slide 82 text

Slide 83

Slide 83 text

fun main() = runBlocking { // this: CoroutineScope GlobalScope.launch { delay(100) println("World!") } println("Hello,") delay(200) } 83 コルーチンスコープと⼦コルーチン © 2019 Ubie, Inc. トップレベルのスコープ。アプリケーション（プロセス）のライフサイクルで動作する

Slide 84

Slide 84 text

fun main() = runBlocking { // this: CoroutineScope GlobalScope.launch { delay(100) println("World!") } println("Hello,") delay(200) } 84 コルーチンスコープと⼦コルーチン © 2019 Ubie, Inc. このコルーチンはrunBlockingのスコープに属さないため、明⽰的に終了を待つ必要がある

Slide 85

Slide 85 text

Slide 86

Slide 86 text

Slide 87

Slide 87 text

Slide 88

Slide 88 text

Slide 89

Slide 89 text

Slide 90

Slide 90 text

Slide 91

Slide 91 text

Slide 92

Slide 92 text

Slide 93

Slide 93 text

93 コルーチンのキャンセル © 2019 Ubie, Inc. public fun CoroutineScope.launch( context: CoroutineContext start: CoroutineStart block: suspend CoroutineScope.() -> Unit ): Job fun main() = runBlocking { // this: CoroutineScope val job = launch { while(true) { delay(100) println("World!") } } println("Hello,") }

Slide 94

Slide 94 text

Slide 95

Slide 95 text

fun main() = runBlocking { // this: CoroutineScope val job = launch { while(true) { delay(100) println("World!") } } println("Hello,") delay(500) job.cancel() } 95 コルーチンのキャンセル © 2019 Ubie, Inc. jobを使ってキャンセルできる

Slide 96

Slide 96 text

fun main() = runBlocking { // this: CoroutineScope val job = launch { while(true) { delay(100) println("World!") } } println("Hello,") delay(500) job.cancel() } 96 コルーチンのキャンセル © 2019 Ubie, Inc. Hello, World! World! World! World!

Slide 97

Slide 97 text

97 Kotlinコルーチンのきほん① © 2019 Ubie, Inc. • コルーチンスコープはコルーチンが動作する範囲で、複数のコルーチンを起動できる • コルーチンを起動するためのコルーチンビルダー関数（launch, async）があり、実⾏コンテキスト、開始⽅法とsuspendラムダを渡して使う • コルーチンをブロッキングで実⾏するためのrunBlocking関数がある • コルーチンスコープは⼦コルーチンの完了を待つ • 時間経過で完了するコルーチンと、完了しないコルーチンがある。 • Job#cancel関数を使って明⽰的にコルーチンをキャンセルできる。

Slide 98

Slide 98 text

Slide 99

Slide 99 text

Slide 100

Slide 100 text

Slide 101

Slide 101 text

Slide 102

Slide 102 text

102 suspend関数と実⾏コンテキスト © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile { return apiClient.getProfile(id) } } この関数はどのスレッドで動作するか？関数を呼び出したスレッドで動作する

Slide 103

Slide 103 text

103 suspend関数と実⾏コンテキスト © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } }

Slide 104

Slide 104 text

104 suspend関数と実⾏コンテキスト © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } } 実⾏コンテキストを切り替える関数

Slide 105

Slide 105 text

105 suspend関数と実⾏コンテキスト © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } } コルーチンディスパッチャーの定数

Slide 106

Slide 106 text

Slide 107

Slide 107 text

107 コルーチンディスパッチャー © 2019 Ubie, Inc. • コルーチンインターセプターの実装 • コルーチンをどのスレッドで実⾏するかを選択できる • 定数として4種類提供している • Default: CPUバウンド • IO: I/Oバウンド • Main: メインスレッド • UnConﬁned: 制限なし（通常は使わない） ঢ়ଶ ঢ়ଶ ঢ়ଶ コルーチン実⾏コンテキスト ίϧʔνϯσΟεύονϟʔ 実⾏スレッドをコントロール

Slide 108

Slide 108 text

108 suspend関数と実⾏コンテキスト © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } }

Slide 109

Slide 109 text

109 suspend関数と実⾏コンテキスト © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } } IOバウンドのスレッドプールで動作するように切り替える

Slide 110

Slide 110 text

110 suspend関数の呼び出し © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { println("loadProfile: ${Thread.currentThread().id}") apiClient.getProfile(id) } }

Slide 111

Slide 111 text

111 suspend関数の呼び出し © 2019 Ubie, Inc. fun main() = runBlocking { println("start: ${Thread.currentThread().id}") val dataSource = ProfileDataSource(ApiClient()) val profile = dataSource.loadProfile(10) println("end: ${Thread.currentThread().id}") }

Slide 112

Slide 112 text

112 suspend関数の呼び出し © 2019 Ubie, Inc. fun main() = runBlocking { println("start: ${Thread.currentThread().id}") val dataSource = ProfileDataSource(ApiClient()) val profile = dataSource.loadProfile(10) println("end: ${Thread.currentThread().id}") } start: 1 loadProﬁle: 8 end: 1

Slide 113

Slide 113 text

113 例外のハンドリング © 2019 Ubie, Inc. fun main() = runBlocking { println("start: ${Thread.currentThread().id}") val dataSource = ProfileDataSource(ApiClient()) val profile = dataSource.loadProfile(10) println("end: ${Thread.currentThread().id}") } 通信エラー

Slide 114

Slide 114 text

114 例外のハンドリング © 2019 Ubie, Inc. fun main() = runBlocking { println("start: ${Thread.currentThread().id}") val dataSource = ProfileDataSource(ApiClient()) try { val profile = dataSource.loadProfile(10) println("end: ${Thread.currentThread().id}") } catch (e: Exception) { println("error") } }

Slide 115

Slide 115 text

115 例外のハンドリング © 2019 Ubie, Inc. fun main() = runBlocking { println("start: ${Thread.currentThread().id}") val dataSource = ProfileDataSource(ApiClient()) try { val profile = dataSource.loadProfile(10) println("end: ${Thread.currentThread().id}") } catch (e: Exception) { println("error") } } 基本的にsuspend関数をtry-catchで囲む形で良い

Slide 116

Slide 116 text

116 実際に近い例（Android） © 2019 Ubie, Inc. class ProfileViewModel(private val dataSource: ProfileDataSource) : ViewModel() { sealed class ViewState { /* ུ */ } private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun loadProfile(id: Long) { viewModelScope.launch { try { _viewState.value = ViewState.Progress dataSource.loadProfile(id) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } }

Slide 117

Slide 117 text

117 実際に近い例（Android） © 2019 Ubie, Inc. class ProfileViewModel(private val dataSource: ProfileDataSource) : ViewModel() { sealed class ViewState { /* ུ */ } private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun loadProfile(id: Long) { viewModelScope.launch { try { _viewState.value = ViewState.Progress dataSource.loadProfile(id) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } JetpackのViewModel

Slide 118

Slide 118 text

118 実際に近い例（Android） © 2019 Ubie, Inc. class ProfileViewModel(private val dataSource: ProfileDataSource) : ViewModel() { sealed class ViewState { /* ུ */ } private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun loadProfile(id: Long) { viewModelScope.launch { try { _viewState.value = ViewState.Progress dataSource.loadProfile(id) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } ActivityやFragmentから呼び出す

Slide 119

Slide 119 text

119 実際に近い例（Android） © 2019 Ubie, Inc. class ProfileViewModel(private val dataSource: ProfileDataSource) : ViewModel() { sealed class ViewState { /* ུ */ } private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun loadProfile(id: Long) { viewModelScope.launch { try { _viewState.value = ViewState.Progress dataSource.loadProfile(id) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } lifecycle-viewmodel-ktx:2.2.0-alpha3 が提供するViewModelのコルーチンスコープ

Slide 120

Slide 120 text

120 実際に近い例（Android） © 2019 Ubie, Inc. class ProfileViewModel(private val dataSource: ProfileDataSource) : ViewModel() { sealed class ViewState { /* ུ */ } private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun loadProfile(id: Long) { viewModelScope.launch { try { _viewState.value = ViewState.Progress dataSource.loadProfile(id) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } メインスレッドで動作する

Slide 121

Slide 121 text

121 実際に近い例（Android） © 2019 Ubie, Inc. class ProfileViewModel(private val dataSource: ProfileDataSource) : ViewModel() { sealed class ViewState { /* ུ */ } private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun loadProfile(id: Long) { viewModelScope.launch { try { _viewState.value = ViewState.Progress dataSource.loadProfile(id) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } この関数はDispatchers.IOで動作する

Slide 122

Slide 122 text

122 実際に近い例（Android） © 2019 Ubie, Inc. class ProfileViewModel(private val dataSource: ProfileDataSource) : ViewModel() { sealed class ViewState { /* ུ */ } private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun loadProfile(id: Long) { viewModelScope.launch { try { _viewState.value = ViewState.Progress dataSource.loadProfile(id) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } }

Slide 123

Slide 123 text

123 Kotlinコルーチンのきほん② © 2019 Ubie, Inc. • コルーチンが動作するための要素セットとして実⾏コンテキストがある • ⽤途ごとにスレッドプールなどをコルーチンディスパッチャーとして提供している • withContext関数で実⾏コンテキストを切り替えられる • 例外ハンドリングは基本的にtry-catchで⾏う • ⾮同期処理のほとんどはこれらの組み合わせで対応できる

Slide 124

Slide 124 text

Slide 125

Slide 125 text

125 直列な動作 © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { showProgress() val id = 10L val profile = dataSource.loadProfile(id) val articles = dataSource.loadArticles(id) showContent(profile, articles) hideProgress() } }

Slide 126

Slide 126 text

126 直列な動作 fun loadContent() { viewModelScope.launch { showProgress() val id = 10L val profile = dataSource.loadProfile(id) --- 1 val articles = dataSource.loadArticles(id) --- 2 showContent(profile, articles) hideProgress() } } © 2019 Ubie, Inc. 順次、IOバウンドのスレッドプールで実⾏する

Slide 127

Slide 127 text

127 直列な動作 © 2019 Ubie, Inc. 順次、IOバウンドのスレッドプールで実⾏する同時に実⾏するには？ fun loadContent() { viewModelScope.launch { showProgress() val id = 10L val profile = dataSource.loadProfile(id) --- 1 val articles = dataSource.loadArticles(id) --- 2 showContent(profile, articles) hideProgress() } }

Slide 128

Slide 128 text

128 並⾏な動作 © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) hideProgress() } }

Slide 129

Slide 129 text

129 並⾏な動作 © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) hideProgress() } } Deferredを返し、コルーチンを実⾏する

Slide 130

Slide 130 text

130 並⾏な動作 © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) hideProgress() } } Deferredから結果を取り出す

Slide 131

Slide 131 text

131 並⾏な動作 © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) hideProgress() } } 通信エラー

Slide 132

Slide 132 text

132 並⾏な動作 © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { try { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } catch (e: IOException) { showError(e) } finally { hideProgress() } } }

Slide 133

Slide 133 text

133 並⾏な動作 © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { try { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } catch (e: IOException) { showError(e) } finally { hideProgress() } } }

Slide 134

Slide 134 text

134 並⾏な動作 © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { try { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } catch (e: IOException) { showError(e) } finally { hideProgress() } } }

Slide 135

Slide 135 text

Slide 136

Slide 136 text

Slide 137

Slide 137 text

137 並⾏性を構造化する © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { try { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } catch (e: IOException) { showError(e) } finally { hideProgress() } } }

Slide 138

Slide 138 text

138 並⾏性を構造化する © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { try { coroutineScope { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } } catch (e: IOException) { showError(e) } finally { hideProgress() } } }

Slide 139

Slide 139 text

139 並⾏性を構造化する © 2019 Ubie, Inc. fun loadContent() { viewModelScope.launch { try { coroutineScope { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } } catch (e: IOException) { showError(e) } finally { hideProgress() } } } ⼦スコープを作る関数

Slide 140

Slide 140 text

fun loadContent() { viewModelScope.launch { try { coroutineScope { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } } catch (e: IOException) { showError(e) } finally { hideProgress() } } } 140 並⾏性を構造化する © 2019 Ubie, Inc. 親スコープ coroutineScope viewModelScope.launch() async() async()

Slide 141

Slide 141 text

fun loadContent() { viewModelScope.launch { try { coroutineScope { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } } catch (e: IOException) { showError(e) } finally { hideProgress() } } } viewModelScope.launch() 141 並⾏性を構造化する © 2019 Ubie, Inc. 親スコープ coroutineScope async() async() この範囲が処理の単位になる

Slide 142

Slide 142 text

fun loadContent() { viewModelScope.launch { try { coroutineScope { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } } catch (e: IOException) { showError(e) } finally { hideProgress() } } } 142 並⾏性を構造化する © 2019 Ubie, Inc. 親スコープ coroutineScope async() async() どれかが失敗すると全体がエラーになる viewModelScope.launch() この範囲が処理の単位になる

Slide 143

Slide 143 text

fun loadContent() { viewModelScope.launch { try { coroutineScope { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } } catch (e: IOException) { showError(e) } finally { hideProgress() } } } 143 並⾏性を構造化する © 2019 Ubie, Inc. 親スコープ coroutineScope async() async() スコープのエラーを透過的にハンドリングできる viewModelScope.launch()

Slide 144

Slide 144 text

fun loadContent() { viewModelScope.launch { try { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } catch (e: IOException) { showError(e) } finally { hideProgress() } } } 144 並⾏性を構造化していなかったら © 2019 Ubie, Inc. 親スコープ async() async() viewModelScope.launch()

Slide 145

Slide 145 text

fun loadContent() { viewModelScope.launch { try { showProgress() val id = 10L val profile: Deferred = async { dataSource.loadProfile(id) } val articles: Deferred> = async { dataSource.loadArticles(id) } showContent(profile.await(), articles.await()) } catch (e: IOException) { showError(e) } finally { hideProgress() } } } 145 並⾏性を構造化していなかったら © 2019 Ubie, Inc. 親スコープ async() async() この範囲が処理の単位になるので、エラーが発⽣すると、親スコープが終了する viewModelScope.launch()

Slide 146

Slide 146 text

146 コルーチンスコープと構造化された並⾏性 © 2019 Ubie, Inc. • コルーチンを直列で実⾏する場合は実⾏コンテキスト切り替え以外は基本的に気にしなくてよい • コルーチンを分岐させる場合は並⾏性を構造化する必要がある • 並⾏性の構造化とは分岐と合流の範囲を明⽰すること • launch/asyncが分岐を表し、コルーチンスコープが範囲を表す • coroutineScope関数を使って⼦スコープ（分岐と合流の範囲）を作ることができる • 分岐と合流の範囲を構造化することで、処理とエラーの範囲を決められる

Slide 147

Slide 147 text

Slide 148

Slide 148 text

Slide 149

Slide 149 text

Slide 150

Slide 150 text

Slide 151

Slide 151 text

Slide 152

Slide 152 text

Slide 153

Slide 153 text

Slide 154

Slide 154 text

Slide 155

Slide 155 text

Slide 156

Slide 156 text

Slide 157

Slide 157 text

157 コルーチンスコープとアプリケーションライフサイクルを合わせる © 2019 Ubie, Inc. プロセス UIアプリケーション（Android） Viewmodel GlobalScope lifecylceScope Activity Fragment lifecycle-runtime-ktx:2.2.0-alpha01 or higher viewModelScope lifecycle-viewmodel-ktx:2.1.0-beta01 or higher LiveData

Slide 158

Slide 158 text

158 コルーチンスコープとアプリケーションライフサイクルを合わせる © 2019 Ubie, Inc. プロセス UIアプリケーション（Android） Viewmodel GlobalScope lifecylceScope Activity Fragment lifecycle-runtime-ktx:2.2.0-alpha01 or higher viewModelScope lifecycle-viewmodel-ktx:2.1.0-beta01 or higher LiveData liveData lifecycle-livedata-ktx:2.2.0-alpha01 or higher

Slide 159

Slide 159 text

159 コルーチンスコープとアプリケーションライフサイクルを合わせる © 2019 Ubie, Inc. プロセス UIアプリケーション（Android） Viewmodel GlobalScope lifecylceScope Activity Fragment lifecycle-runtime-ktx:2.2.0-alpha01 or higher viewModelScope lifecycle-viewmodel-ktx:2.1.0-beta01 or higher LiveData liveData lifecycle-livedata-ktx:2.2.0-alpha01 or higher 幸いなことにKotlinコルーチンのサポートが様々なプラットフォームで進んでおり、⾃前で⽤意する必要はほとんどなくなった

Slide 160

Slide 160 text

Slide 161

Slide 161 text

Slide 162

Slide 162 text

Slide 163

Slide 163 text

163 suspend関数はメインセーフティで実装する © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } }

Slide 164

Slide 164 text

164 suspend関数はメインセーフティで実装する © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } } ブロッキングする関数を使ってるので...

Slide 165

Slide 165 text

165 suspend関数はメインセーフティで実装する © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } } メインスレッドから安全に呼び出せるようにする

Slide 166

Slide 166 text

166 suspend関数はメインセーフティで実装する © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } } メインスレッドから安全に呼び出せるようにする suspend関数をメインスレッドから呼び出す時に、実⾏スレッドを意識させない

Slide 167

Slide 167 text

Slide 168

Slide 168 text

168 コルーチンはメインセーフティで起動する © 2019 Ubie, Inc. class MainViewModel(val dataSource: ProfileDataSource) : ViewModel() { val profile: LiveData val viewState: LiveData fun loadContent() { viewModelScope.launch { try { viewState.value = ViewState.Progress profile.value = dataSource.loadProfile(10L) } catch (e: IOException) { viewState.value = ViewState.Error(e) } finally { viewState.value = ViewState.Loaded } } } (PPE

Slide 169

Slide 169 text

169 コルーチンはメインセーフティで起動する © 2019 Ubie, Inc. class MainViewModel(val dataSource: ProfileDataSource) : ViewModel() { val profile: LiveData val viewState: LiveData fun loadContent() { viewModelScope.launch { try { viewState.value = ViewState.Progress profile.value = dataSource.loadProfile(10L) } catch (e: IOException) { viewState.value = ViewState.Error(e) } finally { viewState.value = ViewState.Loaded } } } Android JetpackのViewModel (PPE

Slide 170

Slide 170 text

170 コルーチンはメインセーフティで起動する © 2019 Ubie, Inc. class MainViewModel(val dataSource: ProfileDataSource) : ViewModel() { val profile: LiveData val viewState: LiveData fun loadContent() { viewModelScope.launch { try { viewState.value = ViewState.Progress profile.value = dataSource.loadProfile(10L) } catch (e: IOException) { viewState.value = ViewState.Error(e) } finally { viewState.value = ViewState.Loaded } } } ViewModelのコルーチンスコープ Mainディスパッチャーで動作する (PPE

Slide 171

Slide 171 text

171 コルーチンはメインセーフティで起動する © 2019 Ubie, Inc. class MainViewModel(val dataSource: ProfileDataSource) : ViewModel() { val profile: LiveData val viewState: LiveData fun loadContent() { viewModelScope.launch { try { viewState.value = ViewState.Progress profile.value = dataSource.loadProfile(10L) } catch (e: IOException) { viewState.value = ViewState.Error(e) } finally { viewState.value = ViewState.Loaded } } } メインスレッドで動作する (PPE

Slide 172

Slide 172 text

172 コルーチンはメインセーフティで起動する © 2019 Ubie, Inc. class MainViewModel(val dataSource: ProfileDataSource) : ViewModel() { val profile: LiveData val viewState: LiveData fun loadContent() { viewModelScope.launch(Dispatchers.IO) { try { viewState.postValue(ViewState.Progress) profile.postValue(dataSource.loadProfile(10L)) } catch (e: IOException) { viewState.postValue(ViewState.Error(e)) } finally { viewState.postValue(ViewState.Loaded) } } } /PU(PPE

Slide 173

Slide 173 text

173 コルーチンはメインセーフティで起動する © 2019 Ubie, Inc. class MainViewModel(val dataSource: ProfileDataSource) : ViewModel() { val profile: LiveData val viewState: LiveData fun loadContent() { viewModelScope.launch(Dispatchers.IO) { try { viewState.postValue(ViewState.Progress) profile.postValue(dataSource.loadProfile(10L)) } catch (e: IOException) { viewState.postValue(ViewState.Error(e)) } finally { viewState.postValue(ViewState.Loaded) } } } 異なるスレッドで動かす /PU(PPE

Slide 174

Slide 174 text

174 コルーチンはメインセーフティで起動する © 2019 Ubie, Inc. class MainViewModel(val dataSource: ProfileDataSource) : ViewModel() { val profile: LiveData val viewState: LiveData fun loadContent() { viewModelScope.launch(Dispatchers.IO) { try { viewState.postValue(ViewState.Progress) profile.postValue(dataSource.loadProfile(10L)) } catch (e: IOException) { viewState.postValue(ViewState.Error(e)) } finally { viewState.postValue(ViewState.Loaded) } } } ⼀応LiveDataの場合postValueを使えばメインセーフティな操作ができる /PU(PPE

Slide 175

Slide 175 text

175 コルーチンはメインセーフティで起動する © 2019 Ubie, Inc. class MainViewModel(val dataSource: ProfileDataSource) : ViewModel() { val profile: LiveData val viewState: LiveData fun loadContent() { viewModelScope.launch(Dispatchers.IO) { try { viewState.postValue(ViewState.Progress) profile.postValue(dataSource.loadProfile(10L)) } catch (e: IOException) { viewState.postValue(ViewState.Error(e)) } finally { viewState.postValue(ViewState.Loaded) } } } ブロッキングする関数だとしても問題なく動作できるが... /PU(PPE

Slide 176

Slide 176 text

176 コルーチンはメインセーフティで起動する © 2019 Ubie, Inc. class MainViewModel(val dataSource: ProfileDataSource) : ViewModel() { val profile: LiveData val viewState: LiveData fun loadContent() { viewModelScope.launch(Dispatchers.IO) { try { viewState.postValue(ViewState.Progress) profile.postValue(dataSource.loadProfile(10L)) } catch (e: IOException) { viewState.postValue(ViewState.Error(e)) } finally { viewState.postValue(ViewState.Loaded) } } } ブロッキングする関数だとしても問題なく動作できるが... メインセーフティでない関数を呼び出すかもしれないことを意識させるべきではない /PU(PPE

Slide 177

Slide 177 text

177 コルーチンはメインセーフティで起動する © 2019 Ubie, Inc. class MainViewModel(val dataSource: ProfileDataSource) : ViewModel() { val profile: LiveData val viewState: LiveData fun loadContent() { viewModelScope.launch { try { viewState.value = ViewState.Progress profile.value = dataSource.loadProfile(10L) } catch (e: IOException) { viewState.value = ViewState.Error(e) } finally { viewState.value = ViewState.Loaded } } } (PPE

Slide 178

Slide 178 text

Slide 179

Slide 179 text

Slide 180

Slide 180 text

Slide 181

Slide 181 text

Slide 182

Slide 182 text

182 コルーチンのテストライブラリ © 2019 Ubie, Inc. testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test: 1.3.0" testImplementation "androidx.test.ext:truth:1.2.0" testImplementation "io.mockk:mockk:1.8.13.kotlin13" testImplementation "io.mockk:mockk-android:1.8.13.kotlin13" build.gradle (Android)

Slide 183

Slide 183 text

183 コルーチンのテストライブラリ © 2019 Ubie, Inc. testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test: 1.3.0-RC2" testImplementation "androidx.test.ext:truth:1.2.0" testImplementation "io.mockk:mockk:1.8.13.kotlin13" testImplementation "io.mockk:mockk-android:1.8.13.kotlin13" build.gradle (Android) アサーションとモックライブラリ

Slide 184

Slide 184 text

Slide 185

Slide 185 text

Slide 186

Slide 186 text

186 suspend関数のテスト © 2019 Ubie, Inc. @Test fun loadProfileSuccess(): Unit = runBlocking { val dataSource = ProfileDataSource(mockk { every { getProfile(any()) } returns Profile() }) val profile = dataSource.loadProfile(10) assertThat(profile).isNotNull() } class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } }

Slide 187

Slide 187 text

187 suspend関数のテスト © 2019 Ubie, Inc. @Test fun loadProfileSuccess(): Unit = runBlocking { val dataSource = ProfileDataSource(mockk { every { getProfile(any()) } returns Profile() }) val profile = dataSource.loadProfile(10) assertThat(profile).isNotNull() } class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } } ブロッキングでコルーチンを実⾏

Slide 188

Slide 188 text

188 suspend関数のテスト © 2019 Ubie, Inc. @Test fun loadProfileSuccess(): Unit = runBlocking { val dataSource = ProfileDataSource(mockk { every { getProfile(any()) } returns Profile() }) val profile = dataSource.loadProfile(10) assertThat(profile).isNotNull() } class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } } ApiClientをモック

Slide 189

Slide 189 text

189 suspend関数のテスト © 2019 Ubie, Inc. @Test fun loadProfileSuccess(): Unit = runBlocking { val dataSource = ProfileDataSource(mockk { every { getProfile(any()) } returns Profile() }) val profile = dataSource.loadProfile(10) assertThat(profile).isNotNull() } class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } } suspend関数を呼び出す

Slide 190

Slide 190 text

190 suspend関数のテスト © 2019 Ubie, Inc. @Test fun loadProfileSuccess(): Unit = runBlocking { val dataSource = ProfileDataSource(mockk { every { getProfile(any()) } returns Profile() }) val profile = dataSource.loadProfile(10) assertThat(profile).isNotNull() } class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } } アサーション

Slide 191

Slide 191 text

191 suspend関数のテスト © 2019 Ubie, Inc. @Test fun loadProfileSuccess(): Unit = runBlocking { val dataSource = ProfileDataSource(mockk { every { getProfile(any()) } returns Profile() }) val profile = dataSource.loadProfile(10) assertThat(profile).isNotNull() } class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { apiClient.getProfile(id) } }

Slide 192

Slide 192 text

192 suspend関数のテスト © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { coroutineScope { val profile = async { apiClient.getProfile(id) } val articles = async { apiClient.getArticles(id) } Profile(profile.await(), articles.await()) } } }

Slide 193

Slide 193 text

193 suspend関数のテスト © 2019 Ubie, Inc. class ProfileDataSource(private val apiClient: ApiClient) { suspend fun loadProfile(id: Long): Profile = withContext(Dispatchers.IO) { coroutineScope { val profile = async { apiClient.getProfile(id) } val articles = async { apiClient.getArticles(id) } Profile(profile.await(), articles.await()) } } } 呼び出し元と異なるスコープでコルーチンを起動しない限りはこういう形などでも問題ない

Slide 194

Slide 194 text

Slide 195

Slide 195 text

195 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } }

Slide 196

Slide 196 text

196 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } JetpackのViewModel

Slide 197

Slide 197 text

197 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } JetpackのRoomで、DAOでsuspend関数を宣⾔している

Slide 198

Slide 198 text

198 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } 通常の関数呼び出しからコルーチンを起動する

Slide 199

Slide 199 text

199 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } suspend関数を呼び出す

Slide 200

Slide 200 text

200 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. @RunWith(AndroidJUnit4::class) class ReadingHistoryViewModelTest { val app by lazy { ApplicationProvider.getApplicationContext() } val database by lazy { Room.databaseBuilder(app, Database::class.java, "database") .allowMainThreadQueries() .build() } @Test fun insertTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(0) viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(1) } }

Slide 201

Slide 201 text

201 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. @RunWith(AndroidJUnit4::class) class ReadingHistoryViewModelTest { val app by lazy { ApplicationProvider.getApplicationContext() } val database by lazy { Room.databaseBuilder(app, Database::class.java, "database") .allowMainThreadQueries() .build() } @Test fun insertTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(0) viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(1) } } Roomを動かすためにAndroidJUnit4で動かす

Slide 202

Slide 202 text

202 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. @RunWith(AndroidJUnit4::class) class ReadingHistoryViewModelTest { val app by lazy { ApplicationProvider.getApplicationContext() } val database by lazy { Room.databaseBuilder(app, Database::class.java, "database") .allowMainThreadQueries() .build() } @Test fun insertTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(0) viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(1) } } RoomDatabaseを初期化する

Slide 203

Slide 203 text

203 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. @RunWith(AndroidJUnit4::class) class ReadingHistoryViewModelTest { val app by lazy { ApplicationProvider.getApplicationContext() } val database by lazy { Room.databaseBuilder(app, Database::class.java, "database") .allowMainThreadQueries() .build() } @Test fun insertTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(0) viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(1) } } アサーションのためにDAOを操作するのでrunBlockingで動かす

Slide 204

Slide 204 text

204 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. @RunWith(AndroidJUnit4::class) class ReadingHistoryViewModelTest { val app by lazy { ApplicationProvider.getApplicationContext() } val database by lazy { Room.databaseBuilder(app, Database::class.java, "database") .allowMainThreadQueries() .build() } @Test fun insertTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(0) viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(1) } } Caused by: expected: 1 but was : 0

Slide 205

Slide 205 text

205 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } }

Slide 206

Slide 206 text

206 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } テストではここまで到達して中断し、制御が戻る（アサーションに進んでしまう）

Slide 207

Slide 207 text

207 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch(Dispatchers.IO) { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } もしメインセーフティな実⾏じゃない場合はここで⽌まる /PU(PPE

Slide 208

Slide 208 text

208 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } この実⾏をテストスレッドで⾏いたい

Slide 209

Slide 209 text

209 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. @RunWith(AndroidJUnit4::class) class ReadingHistoryViewModelTest { val app by lazy { ApplicationProvider.getApplicationContext() } val database by lazy { Room.databaseBuilder(app, Database::class.java, "database") .allowMainThreadQueries() .build() } @Test fun insertTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(0) viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(1) } }

Slide 210

Slide 210 text

210 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. @RunWith(AndroidJUnit4::class) class ReadingHistoryViewModelTest { val app by lazy { ApplicationProvider.getApplicationContext() } val database by lazy { Room.databaseBuilder(app, Database::class.java, "database") .allowMainThreadQueries() .setQueryExecutor { it.run() } .build() } @Test fun insertTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(0) viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(1) } }

Slide 211

Slide 211 text

211 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. @RunWith(AndroidJUnit4::class) class ReadingHistoryViewModelTest { val app by lazy { ApplicationProvider.getApplicationContext() } val database by lazy { Room.databaseBuilder(app, Database::class.java, "database") .allowMainThreadQueries() .setQueryExecutor { it.run() } .build() } @Test fun insertTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(0) viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(1) } } テストスレッドで実⾏するようにする

Slide 212

Slide 212 text

212 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. @RunWith(AndroidJUnit4::class) class ReadingHistoryViewModelTest { val app by lazy { ApplicationProvider.getApplicationContext() } val database by lazy { Room.databaseBuilder(app, Database::class.java, "database") .allowMainThreadQueries() .setQueryExecutor { it.run() } .build() } @Test fun insertTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(0) viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(1) } } テストスレッドで実⾏するようにする Main以外のディスパッチャを使うsuspend関数は、ディスパッチャを書き換えられるようにしておくのが望ましい

Slide 213

Slide 213 text

213 間接的にコルーチンを起動する関数 © 2019 Ubie, Inc. @RunWith(AndroidJUnit4::class) class ReadingHistoryViewModelTest { val app by lazy { ApplicationProvider.getApplicationContext() } val database by lazy { Room.databaseBuilder(app, Database::class.java, "database") .allowMainThreadQueries() .setQueryExecutor { it.run() } .build() } @Test fun insertTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(0) viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(database.readingHistoryDao().historyCount()).isEqualTo(1) } } OK

Slide 214

Slide 214 text

Slide 215

Slide 215 text

215 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @Test fun viewStateTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) }

Slide 216

Slide 216 text

216 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @Test fun viewStateTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) } ViewStateの変化をテストする

Slide 217

Slide 217 text

217 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @Test fun viewStateTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) } expected: Progress but was : Completed

Slide 218

Slide 218 text

218 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } コルーチンの実⾏タイミングを制御する

Slide 219

Slide 219 text

219 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } コルーチンの実⾏タイミングを制御する関数を呼び出したら最後までブロッキングで実⾏する

Slide 220

Slide 220 text

220 © 2019 Ubie, Inc. class ReadingHistoryViewModel(private val database: Database) : ViewModel() { private val _viewState = MutableLiveData() val viewState: LiveData = _viewState fun addReadingHistory(history: RoomReadingHistory) { viewModelScope.launch { try { _viewState.value = ViewState.Progress database.readingHistoryDao().insert(history) _viewState.value = ViewState.Completed } catch (e: Exception) { _viewState.value = ViewState.Error(e) } } } } コルーチンの実⾏タイミングを制御する⼀旦ここまで進めてアサーションして続きを進めたい

Slide 221

Slide 221 text

221 © 2019 Ubie, Inc. class CoroutinesTestRule( val testDispatcher: TestCoroutineDispatcher = TestCoroutineDispatcher() ) : TestWatcher() { override fun starting(description: Description?) { super.starting(description) Dispatchers.setMain(testDispatcher) } override fun finished(description: Description?) { super.finished(description) Dispatchers.resetMain() testDispatcher.cleanupTestCoroutines() } } コルーチンの実⾏タイミングを制御する

Slide 222

Slide 222 text

222 © 2019 Ubie, Inc. class CoroutinesTestRule( val testDispatcher: TestCoroutineDispatcher = TestCoroutineDispatcher() ) : TestWatcher() { override fun starting(description: Description?) { super.starting(description) Dispatchers.setMain(testDispatcher) } override fun finished(description: Description?) { super.finished(description) Dispatchers.resetMain() testDispatcher.cleanupTestCoroutines() } } コルーチンの実⾏タイミングを制御する経過時間を制御できるディスパッチャ

Slide 223

Slide 223 text

223 © 2019 Ubie, Inc. class CoroutinesTestRule( val testDispatcher: TestCoroutineDispatcher = TestCoroutineDispatcher() ) : TestWatcher() { override fun starting(description: Description?) { super.starting(description) Dispatchers.setMain(testDispatcher) } override fun finished(description: Description?) { super.finished(description) Dispatchers.resetMain() testDispatcher.cleanupTestCoroutines() } } コルーチンの実⾏タイミングを制御するテスト開始時にMainディスパッチャーを書き換える

Slide 224

Slide 224 text

224 © 2019 Ubie, Inc. class CoroutinesTestRule( val testDispatcher: TestCoroutineDispatcher = TestCoroutineDispatcher() ) : TestWatcher() { override fun starting(description: Description?) { super.starting(description) Dispatchers.setMain(testDispatcher) } override fun finished(description: Description?) { super.finished(description) Dispatchers.resetMain() testDispatcher.cleanupTestCoroutines() } } コルーチンの実⾏タイミングを制御するテスト完了時の後処理

Slide 225

Slide 225 text

225 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @Test fun viewStateTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) }

Slide 226

Slide 226 text

226 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = runBlocking { val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) }

Slide 227

Slide 227 text

227 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) }

Slide 228

Slide 228 text

228 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) }

Slide 229

Slide 229 text

229 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) } expected: Progress but was : Completed "

Slide 230

Slide 230 text

230 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val readingHistoryDao: ReadingHistoryDao = mockk { coEvery { insert(any()) } coAnswers { delay(100) Unit } } val database: Database = mockk { every { readingHistoryDao() } returns readingHistoryDao } val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) }

Slide 231

Slide 231 text

231 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val readingHistoryDao: ReadingHistoryDao = mockk { coEvery { insert(any()) } coAnswers { delay(100) Unit } } val database: Database = mockk { every { readingHistoryDao() } returns readingHistoryDao } val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) } Roomデータベースをモックする

Slide 232

Slide 232 text

232 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val readingHistoryDao: ReadingHistoryDao = mockk { coEvery { insert(any()) } coAnswers { delay(100) Unit } } val database: Database = mockk { every { readingHistoryDao() } returns readingHistoryDao } val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) } テスト内で使われるDAOや関数をモックする

Slide 233

Slide 233 text

233 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val readingHistoryDao: ReadingHistoryDao = mockk { coEvery { insert(any()) } coAnswers { delay(100) Unit } } val database: Database = mockk { every { readingHistoryDao() } returns readingHistoryDao } val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) } 任意の時間待たせる

Slide 234

Slide 234 text

234 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val readingHistoryDao: ReadingHistoryDao = mockk { coEvery { insert(any()) } coAnswers { delay(100) Unit } } val database: Database = mockk { every { readingHistoryDao() } returns readingHistoryDao } val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) } この時点ではReadingHistoryDao.insertを実⾏中

Slide 235

Slide 235 text

235 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val readingHistoryDao: ReadingHistoryDao = mockk { coEvery { insert(any()) } coAnswers { delay(100) Unit } } val database: Database = mockk { every { readingHistoryDao() } returns readingHistoryDao } val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ advanceTimeBy(200) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) }

Slide 236

Slide 236 text

236 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val readingHistoryDao: ReadingHistoryDao = mockk { coEvery { insert(any()) } coAnswers { delay(100) Unit } } val database: Database = mockk { every { readingHistoryDao() } returns readingHistoryDao } val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ advanceTimeBy(200) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) } テストディスパッチャの時間を200ms進める関数

Slide 237

Slide 237 text

237 コルーチンの実⾏タイミングを制御する © 2019 Ubie, Inc. @get:Rule val rule = CoroutinesTestRule() @Test fun viewStateTest() = rule.testDispatcher.runBlockingTest { val readingHistoryDao: ReadingHistoryDao = mockk { coEvery { insert(any()) } coAnswers { delay(100) Unit } } val database: Database = mockk { every { readingHistoryDao() } returns readingHistoryDao } val viewModel = ReadingHistoryViewModel(database) assertThat(viewModel.viewState.value).isNull() viewModel.addReadingHistory(createDummyReadingHistory(1)) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Progress) // ॲཧ͕׬ྃޙ advanceTimeBy(200) assertThat(viewModel.viewState.value).isEqualTo(ReadingHistoryViewModel.ViewState.Completed) } OK