在Android中, 我們用到的數據有可能是一次性的, 也有可能是需要多個值的. 本文介紹Android中結合協程(coroutines)的MVVM模式如何處理這兩種情況. 重點介紹協程`Flow`在Android中的應用. ...
Coroutines in Android - One Shot and Multiple Values
在Android中, 我們用到的數據有可能是一次性的, 也有可能是需要多個值的.
本文介紹Android中結合協程(coroutines)的MVVM模式如何處理這兩種情況. 重點介紹協程Flow在Android中的應用.
One-shot vs multiple values
實際應用中要用到的數據可能是一次性獲取的(one-shot), 也可能是多個值(multiple values), 或者稱為流(stream).
舉例, 一個微博應用中:
- 微博信息: 請求的時候獲取, 結果返回即完成. -> one-shot.
- 閱讀和點贊數: 需要觀察持續變化的數據源, 第一次結果返回並不代表完成. -> multiple values, stream.
MVVM構架中的數據類型
一次性操作和觀察多個值(流)的數據, 在架構上看起來會有什麼不同呢?
- One-shot operation: ViewModel中是
LiveData, Repository和Data source中是suspend fun.
class MyViewModel {
val result = liveData {
emit(repository.fetchData())
}
}多個值的實現有兩種選擇:
- Multiple values with LiveData: ViewModel, Repository, Data source都返回
LiveData. 但是LiveData其實並不是為流式而設計的, 所以用起來會有點奇怪. - Streams with Flow: ViewModel中是
LiveData, Repository和Data source返回Flow.
可以看出兩種方式的主要不同點就是ViewModel消費的數據形式, 是LiveData還是Flow.
後面會從ViewModel, Repository和Data source三個層面來說明.
Flow是什麼
既然提到了Flow, 我們先來簡單講一下它是什麼, 這樣大家能在same page.
Kotlin中的多個值, 可以存儲在集合中, 比如list, 也可以靠計算生成sequence, 但如果值是非同步生成的, 需要將方法標記為suspend來避免阻塞主線程.
flow和sequence類似, 但flow是非阻塞的.
看這個例子:
fun foo(): Flow<Int> = flow {
// flow builder
for (i in 1..3) {
delay(1000) // pretend we are doing something useful here
emit(i) // emit next value
}
}
fun main() = runBlocking<Unit> {
// Launch a concurrent coroutine to check if the main thread is blocked
launch {
for (k in 1..3) {
println("I'm not blocked $k")
delay(1000)
}
}
// Collect the flow
foo().collect { value -> println(value) }
}這段代碼執行後輸出:
I'm not blocked 1
1
I'm not blocked 2
2
I'm not blocked 3
3- 這裡用來構建Flow的
flow方法是一個builder function, 在builder block里的代碼可以被suspend. emit方法負責發送值.- cold stream: 只有調用了terminal operation才會被激活. 最常用的是
collect().
如果熟悉Reactive Streams, 或用過RxJava就可以感覺到, Flow的設計看起來很類似.
ViewModel層
發送單個值的情況比較簡單和典型, 這裡不再多說, 主要說發送多個值的情況. 每次又分ViewModel消費的類型是LiveData還是Flow兩種情況來討論.
發射N個值
LiveData -> LiveData
val currentWeather: LiveData<String> = dataSource.fetchWeather()Flow -> LiveData
val currentWeatherFlow: LiveData<String> = liveData {
dataSource.fetchWeatherFlow().collect {
emit(it)
}
}為了減少boilerplate代碼, 簡化寫法:
val currentWeatherFlow: LiveData<String> = dataSource.fetchWeatherFlow().asLiveData()後面都直接用這種簡化的形式了.
發射1+N個值
LiveData -> LiveData
val currentWeather: LiveData<String> = liveData {
emit(LOADING_STRING)
emitSource(dataSource.fetchWeather())
}emitSource()發送的是一個LiveData.
Flow -> LiveData
用Flow的時候可以用上面同樣的形式:
val currentWeatherFlow: LiveData<String> = liveData {
emit(LOADING_STRING)
emitSource(
dataSource.fetchWeatherFlow().asLiveData()
)
}這樣寫看起來有點奇怪, 可讀性不好, 所以可以利用Flow的API, 寫成這樣:
val currentWeatherFlow: LiveData<String> =
dataSource.fetchWeatherFlow()
.onStart{emit(LOADING_STRING)}
.asLiveData()Suspend transformation
如果想在ViewModel中做一些轉換.
LiveData -> LiveData
val currentWeatherLiveData: LiveData<String> = dataSource.fetchWeather().switchMap {
liveData { emit(heavyTransformation(it)) }
}這裡不太適合用map來做轉換, 因為是在主線程.
Flow -> LiveData
用Flow來做轉換就很方便:
val currentWeatherFlow: LiveData<String> = dataSource.fetchWeatherFlow()
.map{ heavyTransformation(it) }
.asLiveData()Repository層
Repository層通常用來組裝和轉換數據.
LiveData被設計的初衷並不是做這些轉換的.
Flow則提供了很多有用的操作符, 所以顯然是一種更好的選擇:
val currentWeatherFlow: Flow<String> =
dataSource.fetchWeatherFlow()
.map { ... }
.filter { ... }
.dropWhile { ... }
.combine { ... }
.flowOn(Dispatchers.IO)
.onCompletion { ... }Data Source層
Data Source層是網路和資料庫, 通常會用到一些第三方的庫.
如果用了支持協程的庫, 如Retrofit和Room, 那麼只需要把方法標記為suspend的, 就行了.
- Retrofit supports coroutines from 2.6.0
- Room supports coroutines from 2.1.0
One-shot operations
對於一次性操作比較簡單, 數據層的只要suspend方法返回值就可以了.
suspend fun doOneShot(param: String) : String = retrofitClient.doSomething(param)如果所用的網路或者資料庫不支持協程, 有辦法嗎? 答案是肯定的.
用suspendCoroutine來解決.
比如你用的第三方庫是基於callback的, 可以用suspendCancellableCoroutine來改造one-shot operation:
suspend fun doOneShot(param: String): Result<String> =
suspendCancellableCoroutine { continuation ->
api.addOnCompleteListener { result ->
continuation.resume(result)
}.addOnFailureListener { error ->
continuation.resumeWithException(error)
}.fetchSomething(param)
}如果協程被取消了, 那麼resume會被忽略.
驗證代碼如期工作後, 可以做進一步的重構, 把這部分抽象出來.
Data source with Flow
數據層返回Flow, 可以用flow builder:
fun fetchWeatherFlow(): Flow<String> = flow {
var counter = 0
while(true) {
counter++
delay(2000)
emit(weatherConditions[counter % weatherConditions.size])
}
}
如果你所用的庫不支持Flow, 而是用回調, callbackFlow builder可以用來改造流.
fun flowFrom(api: CallbackBasedApi): Flow<T> = callbackFlow {
val callback = object: Callback {
override fun onNextValue(value: T) {
offer(value)
}
override fun onApiError(cause: Throwable) {
close(cause)
}
override fun onCompleted() = close()
}
api.register(callback)
awaitClose { api.unregister(callback) }
}可能並不需要LiveData
在上面的例子中, ViewModel仍然保持了自己向UI暴露的數據是LiveData類型. 那麼有沒有可能不用LiveData呢?
lifecycleScope.launchWhenStarted {
viewModel.flowToFlow.collect {
binding.currentWeather.text = it
}
}這樣其實和用LiveData是一樣的效果.
參考
視頻:
文檔:
博客:
- Coroutines On Android (part III): Real work
- Lessons learnt using Coroutines Flow in the Android Dev Summit 2019 app
最後, 歡迎關註微信公眾號: 聖騎士Wind
