見出し画像

社内のチャットAIでKotlin Coroutinesをおさらいしてみた

トリ

こんにちは、トリです。Androidアプリのエンジニアをしています。
今回は社内AIツール「note AI」を活用して、Kotlin Coroutines（コルーチン）の基礎を復習してみました。

※この記事はnote株式会社 Advent Calendar 2023の17日目の記事です。


ときには復習も大切

最近、技術調査の補助にnote AIを活用しているのですが、いい感じの結果が簡単に出力できてとても助かっています。

直近はCoroutinesに関する質問をよく投げていたので、いっそ基礎から学び直して理解を深めることにしました。
Coroutinesはnote Androidアプリで利用している技術の一つです。

さっそくnote AIに聞いた

上司と部下でやり取りする想定でnote AI（上司）に質問してみます。
まず、人物設定を行いました。

### 登場人物の設定
- note AI
    - Coroutinesを極めたAndroidアプリエンジニア
- トリ
    - note AIの部下
    - Coroutinesをよく理解しないまま使用しているAndroidアプリエンジニア

そして、文体を指定することで気さくな上司になってもらいました。

###　文体の指定
- 読者に寄り添うような親しみやすい口調で、専門用語を使う場合はその都度簡単に説明する。

ここから、note AIの出力内容を会話形式でお送りします。

※内容を適宜編集していますが、70%くらいはnote AIで出力したままのはずです。

Q1. Coroutinesってなに？


トリ：
Coroutinesは一体どういうものなのか教えてください。
スレッドとの違いがよくわからないんですよね。

note AI：
もちろんです、トリ君。Coroutinesについて詳しく説明するね。

Coroutinesは、非同期処理を簡単かつ効率的に書くためのツールだよ。

ネットワークのリクエストや大きなデータを処理するとき、メインスレッドをブロックしないために非同期処理が必要だよね。
Coroutinesを使えば、非同期処理をシンプルに記述できるんだ。

スレッドとの違いはね、スレッドはOSが管理するプロセスの実行単位で、リソース（CPUやメモリなど）をそれなりに消費するんだ。

一方、Coroutinesは「軽量スレッド」とも呼ばれるけど、実際にはスレッドではなく、スレッド上で動作するタスクの一種だよ。

Coroutinesは、スレッドよりもはるかに少ないリソースで多くの非同期タスクをこなせる。
これは、Coroutinesが必要に応じてスレッド間で移動したり、一時停止したり再開したりできるからなんだ。

トリ：
言葉だけだと難しいので、図示化して説明してもらえませんか？

note AI：
もちろんできますよ、トリ君。

❶ スレッド:
[ スレッド1 ]    |---タスク1---|---タスク2---|---タスク3---|
[ スレッド2 ]    |---タスク4---|---タスク5---|


❷ Coroutines:
[ スレッド1 ]    |コA開始|---|コA一時停止|コB開始|---|コB一時停止|コA再開|---|コA終了|

※画像を作成できないと謝りながら文字で図示化してくれました。

note AI：
上の図を見ながら説明するね。
❶スレッドの場合、各スレッドはタスクを一つ終えるまで次のタスクに移れないよ。タスクが終わるまでの間、スレッドはそのタスクに専念しているんだ。

❷Coroutinesの場合、コルーチンはスレッド上で複数のタスクを交互に実行できるよ。

コルーチンA（コA）が何かの理由で待たなければならない
（データダウンロードとか）
↓
コルーチンA一時停止
↓
同じスレッド上で別のコルーチン（コB）実行
↓
コルーチンAが再開できる状態になった
↓
コルーチンB一時停止して、コルーチンAを再開

このようにCoroutinesは、一つのスレッド上で複数のタスクを効率的に切り替えながら実行できるので、スレッドのリソースを有効活用できるんだ。

Q2: Coroutinesのメリットは？


トリ：
Coroutinesのメリットをもっと詳しく教えてもらえませんか？

note AI：
もちろんです、トリ君。
Coroutinesのメリットはたくさんあるので、いくつか重要な点を挙げてみよう。

1. シンプルなコード :
Coroutinesを使うと非同期処理のコードが直感的に書けるから、読みやすくなる。
コードが深くネストされて読みにくくなることを避けられるんだ。

2. リソースの効率的な利用 :
Coroutinesは軽量で、多数の非同期タスクを少ないスレッドで実行できる。
アプリのパフォーマンスが向上し、メモリ使用量も抑えられるよ。

3. 構造化された並行処理 :
Coroutinesはスコープを持っていて、スコープに関連する非同期タスクをまとめて管理できるんだ。
この仕組みによってメモリリークを防ぐことができるよ。

4. 柔軟なコンテキスト切り替え :
Coroutinesでは、簡単にスレッドを切り替えられるよ。
UIの更新はメインスレッドで、重い処理はバックグラウンドスレッドで、といった具合に最適なスレッドで処理できるんだ。

5. エラー処理（エラーハンドリング）の容易さ :
Coroutinesのスコープ内でエラーが発生した場合、そのスコープ内でエラーをキャッチして処理できるよ。
これでアプリの安定性が向上するね。

これらのメリットにより、CoroutinesはAndroid開発において非常に強力なツールとなっているよ。
開発者が直面する非同期処理の複雑さを大幅に軽減してくれるんだ。

トリ：
なるほど、Coroutinesのメリットっていっぱいあるんですね。

Q3: Coroutinesの基本的な使い方は？


トリ：
Coroutinesの使い方について教えてくれませんか？

note AI：
もちろん、トリ君。
Coroutinesを使う際は、 launch や async といったビルダーを使ってCoroutinesを開始するんだ。

1. launch :
launch は新しいCoroutinesを開始し、その中で指定された処理を実行するんだ。
launch は処理の結果を返さないので、単に何かの処理を非同期で実行したいときに使うんだよ。

lifecycleScope.launch {

    // 非同期で実行する処理

}


2. async :
async も新しいCoroutinesを開始するんだけど、 launch と違って処理の結果を返すんだ。
async は非同期処理の結果を後で使用したいときに使うよ。
await() 関数を呼び出すと、非同期処理の結果を受けとれるんだ。

val deferred = viewModelScope.async {

    // 非同期で結果を返す処理

}
val result = deferred.await() // 結果をここで受け取る


これらのビルダーは、Coroutinesの実行コンテキストを指定するためにCoroutineScopeと一緒に使われるよ。

Q4: CoroutineScopeってなに？


トリ：
CoroutineScopeという単語が出てきましたが、詳しく教えてもらえますか？

note AI：
もちろん、トリ君。
CoroutineScopeはCoroutinesの実行範囲を定義するためのもので、Coroutinesのライフサイクルを管理する役割を持っているよ。

CoroutineScopeは、Coroutinesがどのライフサイクルに紐づいて実行されるかを決定するんだ。
たとえば、ActivityやFragmentなどで画面のライフサイクルに合わせてCoroutinesを実行したい場合、それに適したスコープを使用する。
そうすると、Activityを破棄したときに自動的にCoroutinesがキャンセルされて、メモリリークを防げるんだ。

主なCoroutineScopeを紹介するね。

1. GlobalScope :
アプリケーション全体のライフサイクルに紐づいていて、アプリが終了するまで生存する。
メモリリークのリスクがあり、通常は推奨されない。

2. CoroutineScope :
カスタムのスコープを作成するために使われ、開発者が指定した任意のライフサイクルにCoroutinesを紐づけられる。

3. viewModelScope :
ViewModelのライフサイクルに紐づいていて、ViewModelがクリアされると自動的にCoroutinesがキャンセルされる。

4. lifecycleScope :
ActivityやFragmentのライフサイクルに紐づいていて、それらのコンポーネントが破棄されると自動的にCoroutinesがキャンセルされる。

CoroutineScopeを適切に使い分けることで、リソースの管理が楽になるよ。

トリ：
CoroutineScopeって便利なんですね。

note AI： 
そうだね、トリ君。
次はDispatchersについて話そう。

Q5: Dispatchersってなに？


トリ：
Dispatchersとはどういうものですか？

note AI：
Dispatchers（ディスパッチャー）は、Coroutinesがどのスレッドで実行されるのかを制御するものなんだ。
主なDispatchersを紹介するね。

1. Dispatchers.Main :
UIの更新など、メインスレッド（UIスレッド）でのみ行うべき操作に使用する。

2. Dispatchers.IO :
データベース操作、ファイル読み書き、ネットワーク通信などのブロッキングな入出力（I/O）タスクに使用される。

3. Dispatchers.Default :
CPUを使った重い計算に適している。

Dispatchersを指定すると、Coroutinesの実行スレッドを適切に選択し、アプリのパフォーマンスを最適化できるよ。
たとえば、UIの更新処理は Dispatchers.Main を使い、データベースへのアクセスは Dispatchers.IO を使えば、UIがスムーズに動作し続けられるね。

lifecycleScope.launch(Dispatchers.Main) {
    // UIを更新する処理
}

lifecycleScope.launch(Dispatchers.IO) {
    // データベースへのアクセスなどのIO処理
}


Q6: エラーハンドリングはどうするの？


トリ：
そういえば、Coroutinesでエラーハンドリングはどうやるんですか？

note AI：
Coroutinesは、通常の同期処理コードと同様に try-catch ブロックを使用できるよ。
Coroutines内で発生した例外は、そのCoroutinesを起動したスコープ内でキャッチされ、適切に処理することが可能なんだ。

lifecycleScope.launch {
    try {
        // 何かの処理を行う
        // この処理中に例外が発生する可能性がある
    } catch (e: Exception) {
        // 例外をキャッチして処理する
        // 例外の種類に応じたエラーハンドリングを行う
    }
}

また、Coroutinesの階層構造において、親Coroutineは子Coroutineの例外をキャッチできるよ。
親Coroutineで子Coroutineのエラーを一元管理できるんだ。

さらに、Coroutinesのエラーハンドリングでは、以下の機能を利用できるよ。

1. CoroutineExceptionHandler :
CoroutineScope内で発生した例外をグローバルにハンドルできる仕組み。

val handler = CoroutineExceptionHandler { _, exception ->
    // キャッチできていない例外を処理する
}

val scope = CoroutineScope(Dispatchers.Default + handler)

scope.launch {
    // 例外が発生する可能性のある処理
}

2. SupervisorJob :
子Coroutineの一つが失敗しても他の子Coroutineの実行を妨げないようにできる。

val scope = CoroutineScope(SupervisorJob())

scope.launch {
    // 子Coroutine A
}

scope.launch {
    // 子Coroutine B
    // ここで例外が発生しても、子Coroutine Aには影響しない
}

エラーハンドリングは、アプリケーションの安定性と信頼性を保つために非常に重要なんだ。
Coroutinesを使用する際は、これらのエラーハンドリングのメカニズムを理解し、適切に例外を処理しようね。

Q7: サンプルコードはある？


トリ：
Coroutinesのことがわかってきた気がします。
 「launch」「async」「CoroutineScope」「Dispatchers」「エラーハンドリング」を取り入れた実践的なサンプルコードを見せてもらえませんか？

note AI：
もちろん、トリ君。
Coroutinesの基本的な要素を組み合わせた実践的なサンプルコードを以下に書くね。
この例では、ViewModel内で非同期処理を行い、結果をUIに表示する一連の流れを想定しているよ。

import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import kotlinx.coroutines.*

class MyViewModel : ViewModel() {

    // CoroutineExceptionHandlerを定義
    private val coroutineExceptionHandler = CoroutineExceptionHandler { _, exception ->
        // キャッチできていない例外を処理する
        println("Caught $exception")
    }

    // 非同期処理を行い、結果を取得する関数
    fun fetchData() {
        // viewModelScopeを使ってCoroutinesを起動
        viewModelScope.launch(coroutineExceptionHandler) {
            try {
                // メインスレッドでUIの準備をする
                // ...

                // IOスレッドでデータを非同期に取得する
                val data = async(Dispatchers.IO) {
                    // 何か時間のかかるデータ取得処理
                    "Fetched Data"
                }.await()

                // メインスレッドでUIを更新する
                updateUI(data)
            } catch (e: Exception) {
                // エラーハンドリング
                handleError(e)
            }
        }
    }

    private fun updateUI(data: String) {
        // UIを更新する処理
        println("Update UI with $data")
    }

    private fun handleError(exception: Exception) {
        // エラーを処理する
        println("An error occurred: $exception")
    }

    override fun onCleared() {
        super.onCleared()
        // ViewModelがクリアされるときに、すべてのCoroutineがキャンセルされる
    }
}

以下の点を取り入れたよ：

  • viewModelScope を使用して、ViewModelのライフサイクルに紐づいたCoroutinesを起動している。

  •  async を使って非同期にデータを取得し、 await でその結果を待ち受けている。

  •  Dispatchers.IO を指定して、データ取得処理をIO専用のスレッドで実行している。

  •  CoroutineExceptionHandler を使って、キャッチできていない例外をグローバルにハンドリングしている。

  •  try-catch ブロックを使って、エラーハンドリングを行っている。


Q8: もっとCoroutinesを学ぶためには？


トリ：
わかりやすいサンプルをありがとうございます。
後日復習したいので、Coroutinesを学ぶための参考URLをいくつか教えてもらえませんか？

note AI：
もちろん、トリ君。
Coroutinesを学ぶための参考になるURLをいくつか紹介するね。

  1.  Coroutines basics | Kotlin Documentation 

    • Kotlinの公式ドキュメントで、Coroutineの基本的な概念を学べる。

  2. Coroutines and channels − tutorial | Kotlin Documentation 

    • Coroutineとチャネルを使ったより高度な使い方について学べるチュートリアル。

  3. Android での Kotlin コルーチン | Android デベロッパー

    • Android開発におけるCoroutineの使い方を解説しているページ。

  4. Coroutines guide | Kotlin Documentation

    • Coroutineのコア機能について、例を交えて詳しく解説しているガイド。

トリ：
おすすめのCodelabはありますか？

note AI：
はい、トリ君。
Kotlin Coroutinesに関するCodelabはいくつかあるよ。

  1. Use Kotlin Coroutines in your Android App

    • AndroidアプリでのKotlin Coroutinesの使用方法を学ぶCodelab。

  2. Introduction to Coroutines in Android Studio

    • Androidアプリとライフサイクル内でのCoroutinesの使用方法について学ぶCodelab。

  3. Learn advanced coroutines with Kotlin Flow and LiveData

    • LiveDataビルダーを使用してKotlin CoroutinesをLiveDataと組み合わせる方法、およびCoroutines Asynchronous Flowを使用して同じものを実装する方法を学ぶCodelab。

これらのリソースを通じて、Coroutinesの基礎から応用まで幅広く学ぶことができるよ。
自分のペースで進めて、Coroutinesについてしっかりと理解を深めていってね。

トリ：
note AIさん、ありがとうございました！


note AIと記事を書いた感想

普段は一つの問題を深掘りする調査目的でnote AIを使用しているので、質問の仕方をいろいろ試行錯誤できておもしろかったです。

記事を書く上では文章の読みやすさが大切なので、思ったより執筆（というより推敲）に時間がかかりました。
推敲もnote AIでやってもらえばいい話だと思うのですが、細かい手直しは文章の好みも影響するので手動になりました。

情報の正確性に関しては、文章の矛盾や誤情報があったりして一部手直しが必要でしたが、おおよその内容は合っていたと思います。
まだ拾えていないCoroutinesの基礎的な知識もあるので、包括的な情報を調べたい場合は、何から調べるか決めるための足がかりとして利用するとよさそうですね。

まだまだ使いこなせておらず、上手く出力できなかったところもあるので、これからもnote AIと対話していこうと思います。


▼noteエンジニアアドベントカレンダーはこちら

▼さらにnoteの技術記事が読みたい方はこちら

おまけ

note AIが提案した記事構成

トリ:
Coroutinesへの理解を深めることを目的としたキャッチーな記事を書きたいと思っています。
対象はCoroutinesをよく理解しないまま使用している初心者寄りのAndroidアプリエンジニアです。
ChatGPTと対話形式の文章でまとめたいのですが、どのような記事の構成・文体が良いでしょうか？

note AI:
素晴らしいアイデアですね！
対話形式は読者にとって理解しやすく、親しみやすいフォーマットです。
以下に、Coroutinesについての記事の構成案と文体の提案をいたします。

### 記事のタイトル:
"コルーチンの謎を解き明かす！Android開発者のためのQ&Aセッション"

### 記事の構成案:
#### イントロダクション:
- 読者に対話形式の記事の趣旨を説明し、Coroutinesの基本的な理解がどれだけ重要かを強調する。
- CoroutinesがAndroid開発においてどのように役立つのか、簡単な導入をする。
#### Q&Aセッション:
-  Q1: Coroutinesって一体何？
  - Coroutinesの基本的な定義と、スレッドとの違いについて説明する。
-  Q2: Coroutinesのメリットは？
  - 非同期処理の簡素化、コードの可読性向上などのメリットを挙げる。
-  Q3: Coroutinesを使うときの一般的なパターンは？
  - launch, asyncなどの基本的なビルダーとその使用例を紹介する。
-  Q4: Coroutinesスコープって何？どう使うの？
  - GlobalScope, CoroutineScopeの違いと、適切なスコープの選択方法について説明する。
-  Q5: エラーハンドリングはどうするの？
  - try/catchブロックの使用や、CoroutineExceptionHandlerの役割について解説する。
-  Q6: 実際にCoroutinesを使ったサンプルコードを見せてもらえる？
  - 簡単なサンプルコードを提示し、その解説を行う。
-  Q7: Coroutinesを学ぶためのリソースは？
  - 公式ドキュメント、チュートリアル、コミュニティフォーラムなどのリソースを紹介する。

#### コンクルージョン:
- Coroutinesの理解が深まったことを確認し、読者が学びを実践に移すことを奨励する。
- 読者にフィードバックを求め、疑問点があればコメントで質問するように促す。

### 文体の提案:
- 読者に寄り添うような親しみやすい口調で、専門用語を使う場合はその都度簡単に説明する。
- 対話形式であるため、質問者と回答者のキャラクターを設定し、それぞれの視点から情報を提供する。
- 読者が自分自身を質問者と同一視できるように、初心者が抱きがちな疑問をリアルに反映させる。
- 読者が実際にコードを試せるように、サンプルコードはシンプルで実用的なものにする。

この構成と文体を用いて、Coroutinesについての理解を深めることができる記事を作成することができるでしょう。
また、記事の最後には、さらなる学習のためのリソースや、読者が実際に試すことができる練習問題を提供することも有効です。


「Android ロボットは、Google が作成および提供している作品から複製または変更したものであり、クリエイティブ・コモンズ表示 3.0 ライセンスに記載された条件に従って使用しています。」

https://developer.android.com/distribute/marketing-tools/brand-guidelines?hl=ja

いいなと思ったら応援しよう！

この記事が参加している募集

#アドベントカレンダー

76件

#AIとやってみた

37,027件