KINTO Tech Blog
Development

Structured Concurrency with Kotlin coroutines

Cover Image for Structured Concurrency with Kotlin coroutines

はじめに

こんにちは!KTCでAndroidエンジニアをしている長谷川(@gotlinan)です!
普段はmyrouteというアプリの開発をしています。myrouteのメンバーが書いた他の記事も是非読んで見てください!

本記事ではKotlin coroutinesを使用したStructured Concurrencyを解説します。
Structured Concurrencyは知っているけど、coroutineを使う方法はどんな感じ?って方は、並行処理のための便利関数をご確認ください。

Structured Concurrency?

Structured Concurrencyって何でしょう?日本語にすると「構造化された並行処理」みたいな感じだと思います。イメージとしては、二つ以上の処理を並行しながら、それぞれでキャンセルやエラーが発生した場合も正しく管理されていること、だと思います。本記事を通じて、Structured Concurrencyについて詳しくなりましょう!

今回は二つのよくある例をもとに紹介してみます。

1. エラーを協調したい

まずよくある例として処理1と処理2を実行後、その結果に応じて処理3を実行したい場合です。
図にすると、以下のようになります。


処理1と処理2を実行後、その結果に応じて処理3を実行する

この場合、処理1でエラーが発生した場合、処理2を継続しても無駄ですね。
したがって処理1でエラーが発生した場合、処理2をキャンセルする必要があります。
同様に処理2でエラーが発生した場合も、処理1をキャンセルして、処理3に進む必要はありません。

2. エラーを協調したくない

次によくある例として、画面内に複数のエリアがあり、それぞれ独立して表示する場合です。
図にすると、以下のようになります。


画面内に複数のエリアがあり、それぞれ独立して表示する

この場合、仮に処理1でエラーが発生しても、処理2や処理3の結果は表示したい場合があります。
したがって処理1でエラーが発生した場合でも処理2や処理3はキャンセルせずに継続する必要があります。



二つの例は理解できましたか?coroutineでは上記のような例を、Structured Concurrencyの考えをもとに簡単に実装することができます!
ただし理解するためにはcoroutineの基礎を理解する必要があります。次のセクションからは実際にcoroutineを学びましょう!
基礎は知っているよっていう方は、並行処理のための便利関数までスキップしてください。

coroutineの基礎

詳しい解説の前にcoroutineの基礎的な話をしましょう。

coroutineではCoroutineScopeからlaunch関数を呼ぶことで非同期の処理を開始できます。具体的には以下のような形です。

CoroutineScope.launch { 
  // 実行したいコード
}

ところでなぜCoroutineScopeを使用する必要があるのでしょうか?それは非同期処理では、「どのスレッドで実行するか」、「キャンセルやエラーが発生した時にどう振る舞うか」がとても重要だからです。CoroutineScopeCoroutineContextを持ちます。あるCoroutineScopeで実行されるcoroutineはCoroutineContextをもとに制御されます。

具体的にはCoroutineContextは以下の要素などから構成されます。

  • Dispatcher : どのスレッドで動くか
  • Job : キャンセルの実行、キャンセルやエラーの伝搬
  • CoroutineExceptionHandler : エラーハンドリング

CoroutineScopeを作成する際は、それぞれの要素を+演算子で渡すことが可能です。
そしてCoroutineContextはcoroutineの親子間で継承されます。例えば以下のようなコードがあったとします。

val handler = CoroutineExceptionHandler { _, _ -> }
val scope = CoroutineScope(Dispatchers.Default + Job() + handler)
scope.launch { // 親処理
    launch { // 子処理1
        launch {} // 子処理1-1
        launch {}// 子処理1-2
    }
    launch {} // 子処理2
}

この場合はCoroutineContextが以下のように継承されます。


CoroutineContextの継承

おや、画像を見るとJobは継承されずに新しく作成されているようですね?
これは間違いではないです。「CoroutineContextはcoroutineの親子間で継承されます」と述べましたが、厳密には「Job以外のCoroutineContextはcoroutineの親子間で継承される」の方が正しいです。それならJobはどうなるんだ?と思いますよね。

次のセクションではJobについて理解を深めてみましょう!

Jobとは

coroutineにおけるJobとは何でしょうか?それは短くまとめるのであれば、「coroutineの実行を制御する」ものだと思います。
Jobにはcancelメソッドがあり、開発者は開始されたcoroutineをいつでもキャンセルすることが可能です。

val job = scope.launch {
    println("start")
    delay(10000) // Long Process
    println("end")
}
job.cancel()

// start (printed out)
// end   (not printed out)

Androidエンジニアがよく利用するであろうviewModelScopelifecycleScopeに紐づくJobはそれぞれのライフサイクルの終わりの時にキャンセルされています。これによりユーザーが画面外にでた場合に継続中の処理があっても、開発者が意識せずに正しくキャンセルされます。

そんな超重要なJobですが、coroutineの親子間でのキャンセルやエラーの伝搬の役割も持ちます。前のセクションではJobは継承されない話をしましたが、その例を使うと、以下の画像のようにJobは階層関係を持ちます。


Jobの階層関係

実際にJobの定義を一部抜粋すると、以下のようになっています。

public interface Job : CoroutineContext.Element {
    public val parent: Job?
    public val children: Sequence<Job>
}

親子関係を保持できるになっており、キャンセルやエラーが発生したときに親や子のJobを操作できそうですね。
次の章からはJobの階層関係を通じて、どのようにcoroutineがキャンセルやエラーを伝搬しているか確認してみましょう!

cancelの伝搬

coroutineがキャンセルされた場合、以下のような挙動になります。

  • 自身の子coroutineを全てキャンセルする
  • 自身の親coroutineには影響しない

CoroutineContextNonCancellableに変更することで親coroutineのキャンセルの影響を受けないcoroutineを実行することも可能です。Structured Concurrencyのテーマとは離れるため、今回は割愛します。

つまりキャンセルはJobの階層関係において下方向に影響します。
下記の例だと、Job2がキャンセルされた場合、Job2Job3Job4で動いているcoroutineがキャンセルされます。


Cancelの伝搬

エラーの伝搬

実はJobには大きく分けて、JobSupervisorJobがあります。
この種類によって、エラーが発生した場合の挙動が変わります。
自身のJobでエラーが発生したときと、子Jobでエラーが発生したときの挙動を二つの表にまとめました。

Job内でエラーが発生したとき

子Jobを 自身のJobを 親Jobに
Job 全てキャンセルする エラー終了する エラーを伝搬する
SupervisorJob 全てキャンセルする エラー終了する エラーを伝搬しない

エラーが子Jobから伝搬してきたとき

他の子Jobを 自身のJobを 親Jobに
Job 全てキャンセルする エラー終了する エラーを伝搬する
SupervisorJob 何もしない 何もしない エラーを伝搬しない

二つの表を参考にしてエラー発生時の挙動を表したイメージは、JobSupervisorJobの場合でそれぞれ以下のようになります。

Jobの場合


通常のJobのJob2でエラーが発生した場合

  1. 子JobであるJob3Job4はキャンセルされる
  2. 自身のJobであるJob2はエラー終了する
  3. エラーを親JobであるJob1に伝搬する
  4. Job1の他の子JobであるJob5をキャンセルする
  5. Job1がエラー終了する

SupervisorJobの場合


通常のJobのJob2でエラーが発生した場合

  1. 子JobであるJob3Job4はキャンセルされる
  2. 自身のJobであるJob2はエラー終了する
  3. エラーを親SupervisorJobであるJob1に伝搬する

意識してもらいたい点として、エラーが伝搬されたSupervisorJob1は、他の子Job(Job5)をキャンセルせず、自身も通常終了します。

ちなみにJobが、通常終了したのか、エラーにより終了したか、キャンセルにより終了したのかを確認する方法として、invokeOnCompletionを使用することができます。

val job = scope.launch {} // Some work
job.invokeOnCompletion { cause ->
    when (cause) {
        is CancellationException -> {}  // cancellation
        is Throwable -> {}              // other exceptions
        null -> {}                      // normal completions
        
    }
}

catchされなかった例外

ところでcoroutineで捕捉されなかった例外はどうなるのでしょうか?
例えば

  • TopLevelのJobでエラーが発生したり、伝搬してきた場合はどうなるの?
  • SupervisorJobでエラーが発生したり、伝搬してきた場合どうなるの?

などの疑問があると思います。

答えは

  1. CoroutineExceptionHandlerが指定されていれば、呼ばれる
  2. CoroutineExceptionHandlerが指定されていなければ、スレッドのデフォルトのUncaughtExceptionHandlerが呼ばれる

となります。

coroutineの基礎で前述のように、CoroutineExceptionHandlerCoroutineContextの仲間です。以下のように渡すことができます。

val handler = CoroutineExceptionHandler { coroutineContext, throwable ->
    // Handle Exception
}
val scope = CoroutineScope(Dispatchers.Default + handler)

もしCoroutineExceptionHandlerが指定されていない場合、スレッドのデフォルトのUncaughtExceptionHandlerが呼ばれます。
開発者が指定したい場合は以下のように記述します。

Thread.setDefaultUncaughtExceptionHandler { thread, exception ->
    // Handle Uncaught Exception
}

自分が本記事執筆まで誤解していたこととして、SupervisorJobを使用すれば、エラーが伝搬しないのでアプリケーションは終了しないという認識がありました。
しかしSupervisorJobはあくまでcoroutineのJobの階層関係上でエラーを伝搬しないだけです。従って上記の二種類のHandlerのどちらかを適宜定義しておかないと、意図した通りに動かない可能性があります。
例えばAndroidアプリではスレッドのデフォルトのUncaughtExceptionHandlerは、開発者が指定しない限りアプリケーションが終了(クラッシュ)するようになっています。一方で通常のKotlinコードを実行すると、ただエラーログを表示するだけとなります。

また、少し話は逸れますが、try-catchCoroutineExceptionHandlerのどちらを使用すればいいのか、という疑問があるかもしれません。CoroutineExceptionHandlerでエラーを捕捉したとき、coroutineのJobは既に終了しており、復帰することはできません。基本的に復帰可能なエラーはtry-catchを使用して、Structured Concurrencyの考えをもとに実装する際や、ログを出しておきたいときなどは、CoroutineExceptionHandlerを設定する方針が良さそうです。

並行処理のための便利関数

ここまでの説明が少し長くなってしまいましたが、coroutineではStructured Concurrencyを達成するために、coroutineScope()supervisorScope()のような関数があります。

coroutineScope()

1. エラーを協調したいを覚えていますか?このような例ではcoroutineScope()を使用することができます。coroutineScope()は起動した子coroutineが全て終了するまで待ちます。また子coroutineでエラーが発生した場合、他の子coroutineはキャンセルします。

以下のようにコードを記述すると、

  • 子処理1と子処理2は並行で実行
  • 子処理3は子処理1と子処理2が終わった後に実行
  • どの子処理でエラーが発生しても、他の子処理はキャンセルされる

などを達成することができます。

scope.launch {
    coroutineScope {
        launch {
            // 子処理1
        }
        launch {
            // 子処理2
        }
    }
    // 子処理3
}

supervisorScope()

2. エラーを協調したくないを覚えていますか?このような例ではsupervisorScope()を使用することができます。supervisorScope()も起動した子coroutineが全て終了するまで待ちます。また子coroutineでエラーが発生した場合でも、他の子coroutineはキャンセルしません。

以下のように記述すると、

  • 子処理1と子処理2と子処理3は並行で実行
  • どの子処理でエラーが発生しても、他の子処理に影響しない

などを達成することができます。

scope.launch {
    supervisorScope {
        launch {
            // 子処理1
        }
        launch {
            // 子処理2
        }
        launch {
            // 子処理3
        }
    }
}

まとめ

Structured Concurrencyは理解できましたか?
説明のための基礎的な内容が多かったかもしれませんが、基礎的な内容を理解しておくと、いざ複雑な実装に取り組む際の助けとなります。

そしてStructured Concurrencyをうまく記述できるようになると、比較的簡単にサービスの局所的なパフォーマンスの改善に繋げることができます。もし無駄に直列で実行しているようなボトルネックがあれば、Structured Concurrencyを考慮してみてはどうでしょうか?

以上です〜

Facebook

関連記事 | Related Posts

Hasegawa
Hasegawa
Cover Image for Structured Concurrency with Kotlin coroutines

Structured Concurrency with Kotlin coroutines

Hand-Tomi
Hand-Tomi
Cover Image for Android開発をする時に知っておかないとバグを引き起こしそうな「地域別の設定」について

Android開発をする時に知っておかないとバグを引き起こしそうな「地域別の設定」について

長谷川
長谷川
Cover Image for KotlinでOGPを取得する時に文字コードで苦労した話

KotlinでOGPを取得する時に文字コードで苦労した話

ソミ
ソミ
Cover Image for myroute Android AppでのJetpack Compose

myroute Android AppでのJetpack Compose

Rasel
Rasel
Cover Image for SwiftUIをCompose Multiplatformで使用する

SwiftUIをCompose Multiplatformで使用する

Romie
Romie
Cover Image for Compose超初心者のPreview感動体験

Compose超初心者のPreview感動体験

We are hiring!

【iOS/Androidエンジニア】モバイルアプリ開発G/東京・大阪

モバイルアプリ開発GについてKINTOテクノロジーズにおける、モバイルアプリ開発のスペシャリストが集まっているグループです。KINTOやmy routeなどのサービスを開発・運用しているグループと協調しながら品質の高いモバイルアプリを開発し、サービスの発展に貢献する事を目標としています。

【バックエンドエンジニア】my route開発G/東京

my route開発グループについてmy route開発グループは、my routeに関わる開発・運用に取り組んでいます。my routeの概要 my routeは、移動需要を創出するために「魅力ある地域情報の発信」、「最適な移動手段の提案」、「交通機関や施設利用のスムーズな予約・決済」をワンストップで提供する、スマートフォン向けマルチモーダルモビリティサービスです。