Share
Embed
Flowing Things, not so strange in the MVI world (BlrDroid meetup)
Migrating an Rx MVI pattern completely to coroutines using Flow. In the MVI world, there was a missing piece from the coroutines framework and due to this, it always felt strange to completely adopt coroutines. Recently, with the introduction of Co-routines Flow library, things are not so strange anymore. In this talk we will have a look at Coroutines Flow library, its need and how it compares with the reactive world. We will then learn to migrate an Rx MVI pattern to use coroutines Flow.
ragdroid
November 17, 2019
Transcript
98 slides
-
What? • Chapter One : Coroutines and Flow • Chapter
Two : MVI • Chapter Three : Rx to Flow • Summary -
Coroutines • Coroutine Scope ★ ViewModel Scope ★ Lifecycle Scope
• Coroutine Builders ★ launch { } - fire and forget ★ async { } - await() result ★ within a scope, Structured Concurrency -
Flow • Cold asynchronous stream that sequentially emits values •
Utilizes coroutines and channels • Like Reactive Observable / Flowable • Experimental Stable APIs since 1.3.0 • Now 1.3.2 -
Flow Operators • Intermediate : ★ map, filter, take, zip,
etc. • Terminal : ★ collect, single, reduce, etc. -
Flow Operators fun main() = runBlocking { val flow =
flow { for (i in 1..10) { delay(500L) emit(i) } }.filter { it % 2 == 0 } flow.collect { println(it) } } 2 4 6 8 10 -
Context Preservation val flowA = flowOf(1, 2, 3) .map {
it + 1 } .flowOn(ctxA) val filtered = flowA .filter { it == 3 } withContext(Dispatchers.Main) { val result = filtered.single() myUi.text = result } https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/ // Will be executed in ctxA // Changes the upstream context: flowOf and map // Pure operator without a context yet // All non-encapsulated operators will be executed in Main: filter and single -
View ViewModel Data Intent newState Action Result previousState Reducer State
View Intention State MVI on top of MVVM -
View ViewModel Data Intent newState Action Result previousState Reducer State
View Intention State 4 3 5 1 2 MVI on top of MVVM -
State View Intention 1 3 2 4 5 Action Events
Actions to Results Reduce Results to new State Plugging-in the pieces State stream -
CHAPTER THREE VANISHING OF Rx FLOWABLES Migrating an Rx MVI
pattern to use Flow -
Actions sealed class MainAction { object PullToRefresh object LoadData data
class LoadDescription(val characterId: Long) } -
viewModel.onAction(MainAction.LoadData) viewModel.onAction(..) override fun onCharacterDescriptionClicked(itemId: Long) { viewModel.onAction(MainAction.LoadDescription(itemId)) } refreshLayout.setOnRefreshListener
{ viewModel.onAction(MainAction.PullToRefresh) } Action Events -
State View Intention 1 Action Events 3 2 4 5
Actions to Results Reduce Results to new State State stream Plugging-in the pieces -
State View Intention 1 Action Events 3 2 4 5
Actions to Results Reduce Results to new State State stream Plugging-in the pieces -
State View Intention 1 Action Events 3 2 4 5
Actions to Results Reduce Results to new State State stream Plugging-in the pieces same -
Actions to Results sealed class MainResult { object Loading object
LoadingError data class LoadingComplete(val characters: List<CharacterMarvel>) object PullToRefreshing: MainResult() object PullToRefreshError data class PullToRefreshComplete(val characters: List<CharacterMarvel>) sealed class DescriptionResult(val characterId: Long) { data class DescriptionLoading(private val id: Long) data class DescriptionError(private val id: Long) data class DescriptionLoadComplete(private val id: Long, val description: String) } } -
View ViewModel Data Intent newState Action Result previousState Reducer State
View Intention State -
View ViewModel Data Intent newState Action Result previousState Reducer State
View Intention State Repository Network -
Data Layer @GET("characters/{characterId}") fun getCharactersSingle(...): Single<List<CharacterMarvel>> fun fetchCharactersStream(): Flowable<List<CharacterMarvel>> =
marvelApi.getCharactersSingle( ... ).mergeWith(cache...) MarvelApi MainRepository -
Data Layer fun fetchCharactersFlow(): Flow<List<CharacterMarvel>> = flow { val characters
= marvelApi.getCharacters( ... ) emit(characters) } .merge(cacheFlow) MainRepository - Flow Room 2.2.0- alpha -
Merge Operator fun fetchCharactersFlow(): Flow<List<CharacterMarvel>> = flow { val characters
= marvelApi.getCharacters( ... ) emit(characters) } .merge(cacheFlow) Data Layer MainRepository - Flow -
Merge Operator • No merge operator at the time •
Creating operators with coroutines is comparatively easy • Home Work (Hint Look into channelFlow) -
fun loadingResult(actions: Flowable<...>) : Flowable<MainResult> = actions .observeOn(Schedulers.io()) .flatMap {
mainRepository.fetchCharactersStream() .map { MainResult.LoadingComplete } .startWith(MainResult.Loading) .onErrorReturn { error -> navigate(MainNavigation.Snackbar) MainResult.LoadingError } } fun loadingResult(actions: Flowable<MainAction.LoadData>) : Flowable<MainResult> = actions .observeOn(Schedulers.io()) .flatMap { mainRepository.fetchCharactersStream() .map { states -> MainResult.LoadingComplete(states) } .startWith(MainResult.Loading) .onErrorReturn { error -> navigate(MainNavigation.Snackbar(error.message) MainResult.LoadingError } } Actions to Results - Load Data RxViewModel -
fun loadingResult(actions: Flowable<...>) : Flowable<MainResult> = actions .observeOn(Schedulers.io()) .flatMap {
mainRepository.fetchCharactersStream() .map { MainResult.LoadingComplete } .startWith(MainResult.Loading) .onErrorReturn { error -> navigate(MainNavigation.Snackbar) MainResult.LoadingError } } RxViewModel FlowViewModel fun loadingResult(actionsFlow: Flow<MainAction.LoadData>) : Flow<MainResult> = actionsFlow .flatMapMerge { mainRepository.fetchCharactersFlow()) .map { MainResult.LoadingComplete(characters) } .onStart { emit(MainResult.Loading) } .catch { navigate(MainNavigation.Snackbar(it.message) emit(MainResult.LoadingError) } } Actions to Results - Load Data -
fun pullToRefreshResult(actions: Flowable<MainAction.PullToRefresh>) : Flowable<MainResult> = ... Actions to Results
- Pull To Refresh RxViewModel -
fun pullToRefreshResult(actions: Flowable<MainAction.PullToRefresh>) : Flow<MainResult> = ... Actions to Results
- Pull To Refresh FlowViewModel -
fun loadDesciptionResult(actions: Flowable<MainAction.LoadDescription>) : Flowable<MainResult> = ... Actions to Results
- Load Desciption RxViewModel -
fun loadDesciptionResult(actions: Flowable<MainAction.LoadDescription>) : Flow<MainResult> = ... Actions to Results
- Load Desciption FlowViewModel -
Repository emits Single? fun fetchCharactersStream(): Flowable<List<CharacterMarvel>> = marvelApi.getCharactersSingle( ... )
.mergeWith(cache...) MainRepository - Rx -
Repository exposes suspend function suspend fun fetchCharacters(): List<CharacterMarvel> = marvelApi.getCharacters(
... ) MainRepository - Coroutines -
Actions to Results fun Flow<MainAction>.actionsToResultTransformer(): Flow<MainResult> = flatMapMerge { flow
{ when(it) { is MainAction.PullToRefresh -> { ... } is MainAction.LoadData -> { try { emit(MainResult.Loading) val characters = mainRepository.fetchCharacters() emit(MainResult.LoadingComplete(characters)) } catch (exception: Exception) { navigate(MainNavigation.Snackbar(exception.message)) emit(MainResult.LoadingError(exception)) } } is MainAction.LoadDescription -> { … } } } } -
View ViewModel Data Intent newState Action Result previousState Reducer State
Repository Network State View Intention (Rx) -
View ViewModel Data Intent newState Action Result previousState Reducer State
View Intention (Co-routines) State Repository Network -
View ViewModel Data Intent newState Action Result previousState Reducer State
View Intention (Co-routines) State Repository Network -
State View Intention 3 2 4 5 Actions to Results
Reduce Results to new State State stream Plugging-in the pieces 1 Action Events same -
State View Intention 3 2 4 5 Actions to Results
Reduce Results to new State State stream Plugging-in the pieces 1 Action Events same -
Reduce Results to new State data class MainViewState(val characters: List<CharacterItemState>,
val emptyState: EmptyState, val loadingState: LoadingState): MviState sealed class EmptyState { object None: EmptyState() object NoData: EmptyState() object NoInternet: EmptyState() } sealed class LoadingState { object None: LoadingState() object Loading: LoadingState() object PullToRefreshing: LoadingState() } } State -
Reduce Results to new State fun reduce(result: MainResult): MainViewState {
return when (result) { is MainResult.Loading -> copy(loadingState = LoadingState.Loading) is MainResult.LoadingError -> copy(loadingState = LoadingState.None, emptyState = EmptyState.NoData) is MainResult.LoadingComplete -> { val characterStates = reduceCharactersList(null, result.characters, resources) copy(characterStates, loadingState = LoadingState.None, emptyState = EmptyState.None) } ... } RxReducer -
Reduce Results to new State FlowReducer fun reduce(result: MainResult): MainViewState
{ return when (result) { is MainResult.Loading -> copy(loadingState = LoadingState.Loading) is MainResult.LoadingError -> copy(loadingState = LoadingState.None, emptyState = EmptyState.NoData) is MainResult.LoadingComplete -> { val characterStates = reduceCharactersList(null, result.characters, resources) copy(characterStates, loadingState = LoadingState.None, emptyState = EmptyState.None) } ... } -
State View Intention 1 Action Events 3 2 4 5
Actions to Results Reduce Results to new State State stream Plugging-in the pieces same -
State View Intention 3 2 4 5 Actions to Results
Reduce Results to new State Plugging-in the pieces State stream 1 Action Events same -
State View Intention 3 2 4 5 Actions to Results
Reduce Results to new State Plugging-in the pieces State stream 1 Action Events same same -
State State stream data class MainViewState(val characters: List<CharacterItemState>, val emptyState:
EmptyState, val loadingState: LoadingState): MviState sealed class EmptyState { object None: EmptyState() object NoData: EmptyState() object NoInternet: EmptyState() } sealed class LoadingState { object None: LoadingState() object Loading: LoadingState() object PullToRefreshing: LoadingState() } } -
State LiveData fun stateLiveData(): LiveData<MainViewState> = stateLiveData private val stateLiveData
= MutableLiveData<MainViewState>() … stateLiveData.postValue(it) ViewModel -
State LiveData fun stateLiveData(): LiveData<MainViewState> = stateLiveData private val stateLiveData
= MutableLiveData<MainViewState>() … stateLiveData.postValue(it) ViewModel viewModel.stateLiveData() .observe(viewLifecycleOwner, Observer { render(it) }) View -
State Flow private val stateChannel = ConflatedBroadcastChannel<MainViewState>() val stateFlow =
stateChannel.asFlow() … stateChannel.offer(it) ViewModel -
State Flow private val stateChannel = ConflatedBroadcastChannel<MainViewState>() val stateFlow =
stateChannel.asFlow() … stateChannel.offer(it) ViewModel View viewModel.stateFlow.collect { render(it) } -
ConflatedBroadcastChannel State Flow private val stateChannel = ConflatedBroadcastChannel<MainViewState>() val stateFlow
= stateChannel.asFlow() … stateChannel.offer(it) ViewModel lifecycleScope.launch { viewModel.stateFlow.collect { render(it) } } View 2.2.0- alpha02 -
ConflatedBroadcastChannel • BroadcastChannel - multiple receivers • Conflate - combine
• Recent value is emitted • Like RxJava BehaviorSubject -
Render override fun render(state: MainViewState) { binding.refreshing = state.loadingState ==
MainViewState.LoadingState.PullToRefreshing binding.loading = state.loadingState == MainViewState.LoadingState.Loading val characterModelList = state.characters.map { CharacterItem(it, this) } adapter.replaceItems(characterModelList, true) } View -
State View Intention 4 5 Plugging-in the pieces State stream
3 2 Actions to Results Reduce Results to new State 1 Action Events same same -
State View Intention 1 Action Events 3 2 4 5
Actions to Results Reduce Results to new State Plugging-in the pieces State stream 3 2 Actions to Results Reduce Results to new State 1 Action Events same same -
State View Intention 1 Action Events 3 2 4 5
Actions to Results Reduce Results to new State Plugging-in the pieces State stream 3 2 Actions to Results Reduce Results to new State 1 Action Events same same same -
RxViewModel Plugging-in the pieces val actionsProcessor: PublishProcessor<Action> = PublishProcessor.create() fun
onAction(action: Action) { actionsProcessor.onNext(action) } -
FlowViewModel Plugging-in the pieces var broadcastChannel = ConflatedBroadcastChannel<MainAction>() fun onAction(action:
MainAction) = broadcastChannel.offer(action) var actionsFlow = broadcastChannel.asFlow() -
fun processActions() { actionsProcessor .compose(actionToResultTransformer) .scan(initialState) { state, result ->
reduce(state, result)} .subscribe({ stateLiveData.postValue(it) }, Timber::e) .bindToLifecycle() } Plugging-in the pieces RxViewModel fun processActions() { actionsProcessor .compose(actionToResultTransformer) .scan(initialState) { state, result: Result -> reduce(state, result)} .subscribe({ stateLiveData.postValue(it) }, Timber::e) .bindToLifecycle() } -
Plugging-in the pieces fun processActions() { actionsProcessor .compose(actionToResultTransformer) .scan(initialState) {
state, result -> reduce(state, result)} .subscribe({ stateLiveData.postValue(it) }, Timber::e) .bindToLifecycle() } fun processActions() { viewModelScope.launch { actionsFlow .actionToResultTransformer() .scan(initialState) { state, result -> reduce(state, result) } .collect { stateLiveData.postValue(it) } } } RxViewModel FlowViewModel -
State View Intention 5 Plugging-in the pieces 1 Action Events
3 2 4 Actions to Results Reduce Results to new State State stream 3 2 Actions to Results Reduce Results to new State 1 Action Events same same same -
State View Intention 5 Plugging-in the pieces 1 Action Events
3 2 4 Actions to Results Reduce Results to new State State stream 3 2 Actions to Results Reduce Results to new State 1 Action Events same same same -
What Did we learn? Rx Coroutines Single / Completable suspend
function Flowable/Observable Flow BehaviorSubject ConflatedBroadcastChannel (DataFlow proposal) Schedulers Dispatchers Disposables Scopes -
What Did we learn? Rx Flow just(“Hello”) flowOf(“Hello”) flatmap() flatmapMerge()
subscribe() collect() publish() broadcastIn() startWith() onStart() onErrorReturn() catch() map() map() scan() scan() ... ... -
Why Flow? • First Party support • Android libraries have
Flow support now like Room • Reducing complexity of business logic • Hopefully share more business logic -
RxJava Coroutines Interop • Yes org.jetbrains.kotlinx:kotlinx-coroutines-rx2:1.3.0 • Single.await(), Flowable.awaitX() •
rxSingle { }, rxFlowable { } … -
Non coroutine APIs to Coroutine APIs • Yes • suspendCoroutine
{ } • Continuation.resumeWith( ) Continuation.resumeWithException() -
Testing? • Yes • TestDispatcher • Dispatchers.setMain() • Inject a
DispatcherProvider? -
What Next? • kotlin-flow-extensions: https://github.com/akarnokd/kotlin-flow-extensions • CoroutineBinding: CoroutineBinding: https://github.com/satoshun/CoroutineBinding •
Flowing in the Deep: https://www.droidcon.com/media-detail?video=352670453 • DataFlow: https://github.com/Kotlin/kotlinx.coroutines/pull/1354/files • Flow Guide: https://github.com/Kotlin/kotlinx.coroutines/blob/1.3.0/docs/flow.md • Flow vs Channel: https://github.com/manuelvicnt/MathCoroutinesFlow • Demo Project: https://github.com/ragdroid/klayground/tree/kotlin-flow • DroidconNYC: https://www.droidcon.com/media-detail?video=362742238 -
References & Acknowledgements • https://github.com/brewin/mvi-coroutines • Manuel Vivo @manuelvicnt •
Hannes Dorfmann @sockeqwe • Android Team @Over • Ritesh Gupta @_riteshhh • https://medium.com/@elizarov - Roman Elizarov • https://medium.com/@objcode - Sean McQuillan • https://www.youtube.com/watch?v=PXBXcHQeDLE - MVI for Android, Benoît Quenaudon