KotlinのrunBlockingとは?初心者でもわかる同期処理とテストの使い方
生徒
「KotlinでrunBlockingっていうのを見かけたんですけど、これは何ですか?」
先生
「runBlockingは、非同期のコードを一時的に同期的に動かしたいときに使える便利な関数なんです。」
生徒
「非同期と同期ってどう違うんですか?」
先生
「簡単に言うと、非同期は『待たずに他の作業をする』ことで、同期は『終わるまで待つ』ってイメージです。これから例を交えて説明していきますね!」
1. runBlockingとは?
runBlockingは、Kotlinのコルーチン(軽量スレッド)を同期的に待機して動かすための関数です。
通常、コルーチンは非同期で動作するため、「順番に実行される」ように見えても、実際には裏で同時に進んでいたりします。
でも、時には「この処理が終わるまでちゃんと待ってから次に進みたい」ということがありますよね。そのときに使えるのがrunBlockingなんです。
2. runBlockingの基本的な使い方
まずは基本的な使い方を見てみましょう。以下のコードでは、delayを使って一時停止したあとに処理が進みます。
import kotlinx.coroutines.*
fun main() = runBlocking {
println("処理1:開始")
delay(2000)
println("処理2:2秒後に実行")
}
delayは非同期処理ですが、runBlockingで囲っているため、しっかり2秒待ってから次の処理が行われます。
3. runBlockingが使われる場面とは?
runBlockingは、主に次のような場面で使われます:
- メイン関数でコルーチンを動かしたいとき
- テストコードの中でコルーチンを使いたいとき
- サンプルコードや一時的な同期処理を確認したいとき
例えば、Androidアプリの本番コードでは基本的にrunBlockingは使いませんが、動作確認や学習目的ではとても役立ちます。
4. 非同期処理を同期で待つイメージ
通常、コルーチンのlaunchなどを使うと、処理が終わる前に次の行へ進みます。以下の例では、非同期処理の途中でメインの処理が完了してしまいます。
fun main() {
GlobalScope.launch {
println("非同期:処理スタート")
delay(1000)
println("非同期:処理完了")
}
println("メイン処理完了")
}
このコードでは「メイン処理完了」が先に表示されて、非同期の中の処理は途中で終了してしまう可能性があります。
しかし、runBlockingを使うと、処理が終わるまできちんと待ってくれます。
fun main() = runBlocking {
launch {
println("非同期:処理スタート")
delay(1000)
println("非同期:処理完了")
}
println("メイン処理完了")
}
この場合、「メイン処理完了」は非同期処理が終わるまで待ってから実行されます。
5. テストコードでrunBlockingを使う理由
実は、runBlockingはユニットテスト(一つの関数などをテストする方法)でもよく使われます。
非同期処理は時間がずれやすく、テストが終わる前に処理が完了していないと、うまく結果が出ません。
そのため、runBlockingで囲むことで、「非同期の処理が終わるのを待ってから判定する」ようにして、テストが安定するのです。
6. 複数の非同期処理をrunBlockingで管理する
runBlockingの中では、複数のlaunchを同時に使うこともできます。非同期で処理を走らせつつ、それらが全て終わるのを待つことも可能です。
fun main() = runBlocking {
launch {
delay(1000)
println("処理A完了")
}
launch {
delay(2000)
println("処理B完了")
}
println("すべての処理を待っています…")
}
このコードでは、AとBの処理が同時に始まり、それぞれ完了したあとに全体の処理が終わるという流れになります。
7. runBlockingの注意点
runBlockingは便利ですが、本番環境や画面表示中の処理では使わないように注意しましょう。
というのも、スレッドをブロック(停止)するという動作なので、アプリの画面が固まる原因になるからです。
あくまで「テストコード」や「練習用のコード」で使うものと覚えておきましょう。
8. runBlockingを使うときに覚えておくこと
初心者がコルーチンを学ぶとき、いきなり非同期だけだと動作確認が難しいこともあります。そんなときにrunBlockingを使えば、同期的に順番通りに実行されるので、理解しやすくなります。
「コルーチンを同期的に使いたいときはrunBlocking」と覚えておくと便利です。