Kotlin専用の仕組み「Flow」とは
ここまで紹介してきたように、LiveDataを利用すると、データソースの更新に連動して画面表示も自動的に変化し、非常に便利です。さらに、RoomによるLiveDataの自動生成機能を併用すると、より効率よくアプリ作成が行えます。このようなLiveDataと同じような機能を提供するKotlin専用の仕組みとしてFlowがあります。前節で作成したアプリを、Flowを利用するとどのようなコードになるかを、本節ではみていきます。
FlowもRoomで自動生成
これから紹介するFlowオブジェクトも、LiveData同様にRoomが自動生成してくれます。しかも、DAOインターフェースでの定義の際に、戻り値のデータ型をリスト11のようにFlowとするだけです。ジェネリクスによる型指定もLiveDataと同じです。
@Dao
interface CocktailmemoDAO {
@Query("SELECT * FROM cocktailmemos")
fun findAll(): Flow<MutableList<Cocktailmemo>>
:
}
これに伴い、CocktailmemoRepositoryのgetCocktailmemoList()の戻り値のデータ型も、MainViewModelのリストデータを保持するプロパティのデータ型も変わり、それぞれ、リスト12、リスト13のようになります。
fun getCocktailmemoList(): Flow<MutableList<Cocktailmemo>> {
:
}
class MainViewModel(application: Application) : AndroidViewModel(application) {
val cocktailmemoListFlow: Flow<MutableList<Cocktailmemo>>
:
}
オブザーバの代わりがコレクタ
このcocktailmemoListFlowにオブザーバを登録する処理が次に必要ですが、Flowの場合は、オブザーバとは言わず、コレクタといいます。このクラスをCocktailmemoListCollectorとすると、リスト14のコードとなります。
class MainActivity : AppCompatActivity() {
:
private inner class CocktailmemoListCollector : FlowCollector<MutableList<Cocktailmemo>> { // (1)
override suspend fun emit(cocktailmemos: MutableList<Cocktailmemo>) { // (2)
_cocktailListAdapter.changeCocktailmemoList(cocktailmemos)
}
}
}
コレクタの作り方のポイントは、（1）のように、FlowCollectorインターフェースを実装したクラスとします。その際、オブザーバ同様に、ジェネリクスとしてFlow内部に保持するデータと同じデータ型を指定します。そして、オブザーバのonChanged()メソッドの代わりとなるのが、（2）のemit()メソッドであり、これを実装します。引数は、オブザーバと同じものです。したがって、メソッド内の処理コードもオブザーバと同じになります。ただし、このemit()メソッドは、suspendメソッドである必要がある点がオブザーバと違うので、注意してください。
コレクタの登録
このようにして用意したコレクタも、オブザーバ同様に、Flowオブジェクトに登録する必要があります。これは、Flowオブジェクトのcollect()メソッドを利用し、その引数としてコレクタインスタンスを渡します。ただし、emit()メソッドがsuspendメソッドである関係上、このcollect()メソッドもsuspendメソッドであり、従って、コルーチンスコープ内で登録処理を行う必要があります。これは、リスト15のコードとなります。
class MainActivity : AppCompatActivity() {
:
override fun onCreate(savedInstanceState: Bundle?) {
:
lifecycleScope.launch { // (1)
repeatOnLifecycle(Lifecycle.State.STARTED) { // (2)
_mainViewModel.cocktailmemoFlow.collect(CocktailmemoCollector()) // (3)
}
}
:
}
:
}
実際のコレクタ登録コードは、リスト15の（3）です。これを、先述のようにコルーチンスコープ内で実行するため、（1）のようにlifecycleScopeのlaunch内で実行します。オブザーバがそうであったように、コレクタもアクティビティで登録処理を行います。そのため、コルーチンスコープは、lifecycleScopeとなります。
ただし、（1）と（3）のコードのみでは、アプリがバックグラウンドに回った際、すなわち、アクティビティのライフサイクルがonStopの状態でも、データストアの変更に対応した画面の変更処理が実行されてしまいます。そこで、onStartからonStopまでの間だけ処理を実行するように限定するコードが（2）です。このコードがキモになることに注意しておいてください。
MutableLiveDataの代わりとなるMutableStateFlow
最後に、前回紹介したCocktailmemo単体をLiveData化した場合の処理を、Flowを使って実現する方法を紹介します。前回では、Cocktailmemo単体をLiveData化する際に、MutableLiveDataを利用し、その内部に保持しているCocktailmemoオブジェクトを、valueプロパティを使って入れ替えることで、画面表示を変更していました。これとほぼ同様に、MainViewModelでは、リスト16のように、MutableStateFlowをプロパティとして保持し、コンストラクタで初期値を格納します。その際、MutableStateFlowはMutableLiveDataと違い、インスタンス生成時に必ず初期値を渡す必要があります。そのため、プロパティでは宣言のみとし、コンストラクタでインスタンスを生成するコードとなります。
class MainViewModel(application: Application) : AndroidViewModel(application) {
val cocktailmemoFlow: MutableStateFlow<Cocktailmemo>
:
init {
:
val cocktailmemo = Cocktailmemo(-1, "未選択", "")
cocktailmemoFlow = MutableStateFlow(cocktailmemo)
}
}
その後は、画面の変更処理を行うコレクタを、前項と同様の手順でこのcocktailmemoFlowに登録するだけで、cocktailmemoFlowのvalueプロパティに新たなCocktailmemoオブジェクトが代入されると、コレクタが自動実行されます。この仕組みは、MutableLiveDataと同じです。これにより、選択したカクテルの名称と金額の表示も、Flowを利用して実現できます。
まとめ
Android Jetpackについて紹介していく本連載の第5回は、いかがでしたでしょうか。
今回は、前回の続きとして、LiveDataの使い方として、Roomによる自動生成機能を紹介しました。さらに、このLiveDataと同等の機能を有するKotlin専用のFlowも紹介しました。
次回は、データと画面表示の連携をより自動化できるデータバインディングを紹介します。
