ドキュメントや関連記事を見てもよく意味が分からないような複雑なオペレーターの機能が、一見するだけでで分かることがよくありました。
👉 ReactiveX - FlatMap operator
Kotlin Flow のオペレーターたちも、これらの名前や機能を元に作られているので、上記 ReactiveX サイトのマーブル図を見れば大体は分かりますが。
Kotlin Flow 向けにも公開してる方がいます。
マーブルをドラッグもできます。
ソースコードも確認できるようです。
👉 rougsig/flowmarbles: Interactive diagrams of Kotlin Flow https://flowmarbles.com
パラレルで同じライフサイクルの場合だけども。
launch をネストしていますね!
👉 A safer way to collect flows from Android UIs | by Manuel Vivo | Android Developers | Medium
StateFlow のインスタンスは、distinctUtilChanged 演算子がに適用されているように動作するので、distinctUntilChanged を StateFlow に適用しても効果はないことに注意してください。
オペレータの組み合わせ
flowOn、conflate、buffer CONFLATED/RENDEZVOUS、capacity、distinctUntilChanged、cancelable のいずれかの演算子を StateFlow に適用しても効果はありません。
SharedFlow で StateFlow を作ることができます。StateFlow は ある設定をした SharedFlow です。
👉 StateFlow の View への公開
👉 【MVVM】Flow vs LiveData
👉 【Kotlin】SharedFlow と BroadcastChannel
以下のような ViewModel があったとして、バッキングプロパティ部分。
どう書いてますか。
class CounterModel {
private val _counter = MutableStateFlow(0)
??? counter ??? = _counter ???
fun inc() {
_counter.update { count -> count + 1 }
}
}
以下の登場時の開発の様子を参考に。
👉 Introduce StateFlow · Issue #1973 · Kotlin/kotlinx.coroutines
StateFlow は、状態を表す更新可能な値の Flow です。
- StateFlow
インターフェイスは、現在の値にアクセスするための読み取り専用で、値の更新を collect するための Flow を実装しています。
- MutabaleStateFlow
インターフェースは、値を変更する操作を追加しています。
- MutableStateFlow(x) のコンストラクタ関数が用意されています。この関数は、与えられた初期値を持つ MutableStateFlow の実装を返します。値への高速で非リアクティブなアクセスが必要な場合は StateFlow
として、値への更新のリアクティブな表示のみが必要な場合は Flow として、外部に公開することができます。
次のようにまとめることができます。
package kotlinx.coroutines.flow
interface StateFlow<T> : Flow<T> {
val value: T // always availabe, reading it never fails
}
interface MutableStateFlow<T> : StateFlow<T> {
override var value: T // can read & write value
}
fun <T> MutableStateFlow(value: T): MutableStateFlow<T> // constructor fun
よって、以下、ありがちな記述。(ないか。)
var counter = _counter // NG
val counter = _counter // NG
val counter: MutableStateFlow<Int> = _counter // NG
val counter: StateFlow<Int> = _counter // NG
val counter get() = _counter // NG
val counter: MutableStateFlow<Int> get() = _counter // NG
開発者の間でも、好き嫌いはあるようですが、以下の2パターンが良さげ。Read Only であることが大事。
val counter: StateFlow<Int> get() = _counter // OK
val counter = _counter.asStateFlow() // OK
よって、
class CounterModel {
private val _counter = MutableStateFlow(0)
val counter = _counter.asStateFlow()
fun inc() {
_counter.update { count -> count + 1 }
}
}
最近の言語の仕様は、オフィシャルドキュメントでは分かりずらいポリシーが多くあるように思います。
👉 【MVVM】 Kotlin Flow で使える5つの利用パターン
👉 StateFlow は distinctUtilChanged 不要
👉 Using LiveData & Flow in MVVM — Part I - ProAndroidDev
Kotlin Flow の登場で盛り上がってきました。
どれにします? どの流れにします?
Result を返す。
Flow<Result>を返す。
Result を受けて、LiveData<Result> を渡す。
Flow<Result> を受けて、LiveData<Result> を渡す。
LiveData<Result> を受け取る。
Flow<Result> を受け取る。
override fun onActivityCreated(savedInstanceState: Bundle?) {
super.onActivityCreated(savedInstanceState)
viewModel = ViewModelProviders.of(
this,
viewModelFactory
).get(WeatherForecastDataStreamFlowViewModel::class.java)
// Consume data when fragment is started
lifecycleScope.launchWhenStarted {
// Since collect is a suspend function it needs to be called
// from a coroutine scope
viewModel.weatherForecast.collect {
when (it) {
Result.Loading -> {
Toast.makeText(context, "Loading", Toast.LENGTH_SHORT).show()
}
is Result.Success -> {
tvDegree.text = it.data.toString()
}
Result.Error -> {
Toast.makeText(context, "Error", Toast.LENGTH_SHORT).show()
}
}
}
}
}
WeatherForecastDataStreamFlowFragment #L47-L75
とはいえ、今はまだ、完全に LiveData は捨てれんよの。
👉 Kotlin で Result
👉 Kotlin Flow vs Android LiveData - Stack Overflow
👉 From RxJava 2 to Kotlin Flow: Threading - ProAndroidDev
