KC Blog

Kotlin Flow 重構ネットワーク接続 詳細手順ガイド

8 min read
ProgrammingLang#Android#Kotlin

前書き

Kotlinは強力なツールFlowを提供しています

Kotlin Flowはコルーチンに基づく非同期プログラミングライブラリで、 

データストリームを処理するためのリアクティブな方法を提供し、

非同期操作とシームレスに統合できます。

Kotlin Flowをネットワークリクエストに適用することで、

非同期タスクをエレガントかつ簡潔に処理でき、

コードの可読性と保守性が向上します。

<div class="c-border-content-title-4">
    数年前にRxJavaのバージョンも共有しましたので、興味があればご覧ください。
</div>
<div class="table_container">
  <a href="/ja/posts/android-kt-rxjava">
  <img src="/images/cover/ea-website-rxjava-cover-photo-new-1.png" alt="Cover" class="w-quarter prose-img" >
  Android開発 - RxJavaを使ったネットワークリクエスト：トークン再取得と再リクエストの実装</a>
</div>

Kotlin Flowの実際の使用

実際にFlowを呼び出して収集（collect）する際には、Coroutine Scopeに追加する必要があります。以下のように：

コード解説

上記のコードでは、Coroutine ScopeのlifecycleScopeを使用してflowを操作しています。

作成したAPIを通じてflowを取得し、collectを行います。

途中でcheckStatusAndRefreshTokenを追加してトークンの有効期限を確認し、

有効期限が切れている場合は自動的にリフレッシュしてリクエストを再送します。

次に、catch関数を使用して発生する可能性のある例外をキャッチし、

例外処理で適切な操作を実行します。

前述のステップが成功した場合、

collectで戻り値を取得し、

ロジック処理を行います。

Kotlin Flowの実際の開発

Kotlin Flowを使用して、元のretrofitコールのコールバックやRxJavaのオペレーターを置き換えます。コードは以下の通りです。

コード解説

上記のコードでは、

目標データを含むFlowを返すstartLogin()関数を定義しています。

次にリクエストボディを追加し、

login APIリクエストを実行します。

ここでは、verifyResponse関数を使用して実行されたAPIリクエストの戻り値が期待通りかどうかを確認します。

（下でverifyResponseのコードを説明します）。

問題がなければ、emitを使用して結果をFlowに発射します。

注意してください

このFlowのスレッドをIOスレッドに切り替えています（.flowOn(Dispatchers.IO)）。

これにより、ネットワークリクエストがメインスレッド以外で実行されることが保証されます。

verifyResponseを追加してAPIリクエストが期待通りかどうかを確認する

コードの説明

上記のコードでは、

ジェネリック型Tを使用して、関数がさまざまなAPIの戻り値に対応できるようにしています。

まず、APIリクエストのHTTPステータスコードが200から300の間にあるかどうかを確認します。

次に、サーバーから返されたレスポンスの内容が空でないかを確認します。

これらの条件が満たされる場合、

対応する例外をスローします。

checkStatusAndRefreshTokenを追加して、APIリクエストのトークンが期限切れの場合に自動的にトークンをリフレッシュし、元のAPIを再リクエストする

コードの説明

上記のコードでは、

拡張関数を使用し、

Flow<BaseResult<T>>として定義しています。

主にAPIリクエストのレスポンスをチェックするために使用します。

ジェネリック型の戻り値を使用して、複数のAPIの戻り値に対応できるようにしています。

関数タイプの変数tokenRefreshとapiCallを渡し、

それぞれトークンを再取得するための呼び出しと、再呼び出しの対象となるAPIエンドポイントを指定します。

上記のコードでは、条件がカスタムエラーコードに一致する場合にemitを発行するようにしています。

結論

まとめ

Kotlin Flowを使用してネットワークリクエストを再構築し、RxJavaやRetrofitのコールバックを置き換えることで、

より強力で柔軟な非同期プログラミング能力を得ることができます。

Kotlin Flowを使用することで、コードの可読性と保守性が向上し、

非同期操作をより優雅に処理する方法を提供します。

コードの変更過程で、

Kotlin Flowを使用して元のRetrofitコールバックを置き換え、APIリクエストをFlowにカプセル化し、

emitを通じてターゲットデータを発行しました。同時に、APIリクエストが期待通りかどうかを確認するためにverifyResponse関数を追加し、

HTTPステータスコードが200〜300の範囲内にあるかどうかやレスポンスの内容が空でないかを確認しました。

さらに、

checkStatusAndRefreshToken関数を導入し、

APIリクエストのトークンが期限切れの場合に自動的にトークンをリフレッシュし、元のAPIリクエストを再発行できるようにしました。

このメカニズムにより、APIリクエストの円滑な実行が保証されます。

総括すると、

Kotlin Flowを使用することでネットワークリクエストのコード構造を改善し、

非同期操作をより管理しやすく、処理しやすくします。

コードの可読性、保守性、拡張性が向上し、より良い非同期プログラミング体験を提供します。

また、

retrofitのコールをflowに変換するlibもいくつかあります。

これをretrofitのインターフェースに直接適用することができます。

しかし、このようなlibは第三者や個人の共有に偏っていることが多く、

特定のプロジェクトや製品では、libの導入を評価する必要があるため、

あまり使用されないlibを導入しないことがあります。

その場合、自分で実装することになります。

もちろん、使用できる方法はすべて良い方法です。

プロジェクト環境に最も適した方法を見つけ、効率的に問題を解決することも重要です！