原文:REACTIVE APPS WITH MODEL-VIEW-INTENT - PART7 - TIMING (SINGLELIVEEVENT PROBLEM)
作者:Hannes Dorfmann
译者:却把清梅嗅
在之前的文章中,我们探讨了正确状态管理的重要性,以及我为什么认为使用类似 Github上Google架构组件的这个repo 中的 SingleLiveEvent 并不是一个好主意——这种解决方案只是隐藏了真正的潜在问题,那就是状态管理。本文我将会阐述SingleLiveEvent
声称能解决的问题,在Model-View-Intent
中如何通过状态管理正确地解决。
译者注:关于
SingleLiveEvent
的这个issue 从17年讨论到19年至今还未close,各方大佬(还有google的巨佬)针对SingleLiveEvent
进行了激烈的讨论,堪称Android论坛的一场神仙大战,非常值得一看。
当error
发生时,Snackbar 将被展示—— 这是一个常见的场景可以用来描述这个问题。Snackbar
并非一直展示,当错误信息被展示几秒钟之后它将消失,问题在于,我们如何模拟这种错误状态并控制Snackbar
的消失呢?
通过下面的视频,你就能了解我在说什么:
这个示例显示了如何从 CountriesRepository 中加载国家的列表,当我们点击某个国家的条目时,程序将会跳转到第二个界面去展示“详情”(仅仅是国家的名称)。当我们返回到国家列表的界面时,我们希望和之前点击国家条目时的状态一致。
目前为止一切正常,但是当我们执行下拉刷新操作时,一个异常出现了,并通过在屏幕中展示一个Snackbar
来展示错误信息。正如您在视频中看到的,当我们再次从国家详情返回国家列表时,Snackbar
和相关的错误信息再次展示了出来,这和用户预期的并不一致,不是吗?
问题的根源是展示了错误的状态。Google基于ViewModel
和LiveData
的架构组件示例中使用了 SingleLiveEvent 来解决这个问题。其解决思路是:当View
重新订阅了其ViewModel
(当从“国家详情”界面返回时),SingleLiveEvent
确保错误的状态不会再次被发射,这确实预防了SnakeBar
的再次显示,但是这真的解决问题了吗?
时机就是一切(也适用于SnakeBar
)
重申,我依然认为这种解决方案并不恰当,我们能做的更好吗?我认为合理的运用 状态管理 和 单向的数据流 是更好的答案,而Model-View-Intent
架构模式遵循了这些规则。因此在MVI
中我们如何解决SnakeBar
的问题呢?首先,我们对Model
状态进行定义:
public class CountriesViewState {
// true意味着Progress将被展示
boolean loading;
// 被加载的国家列表
List<String> countries;
// true意味着`SwipeRefreshLayout`将被展示
boolean pullToRefresh;
// true意味着下拉刷新出现了error,SnakeBar将被展示
boolean pullToRefreshError;
}
MVI
的思想是View
层同时只会展示一个不可变的CountriesViewState
,因此当pullToRefreshError
为true
时SnakeBar
将被展示,反之则会消失。
public class CountriesActivity extends MviActivity<CountriesView, CountriesPresenter>
implements CountriesView {
private Snackbar snackbar;
private ArrayAdapter<String> adapter;
@BindView(R.id.refreshLayout) SwipeRefreshLayout refreshLayout;
@BindView(R.id.listView) ListView listView;
@BindView(R.id.progressBar) ProgressBar progressBar;
...
@Override public void render(CountriesViewState viewState) {
if (viewState.isLoading()) {
progressBar.setVisibility(View.VISIBLE);
refreshLayout.setVisibility(View.GONE);
} else {
// 展示国家列表
progressBar.setVisibility(View.GONE);
refreshLayout.setVisibility(View.VISIBLE);
adapter.setCountries(viewState.getCountries());
refreshLayout.setRefreshing(viewState.isPullToRefresh());
if (viewState.isPullToRefreshError()) {
showSnackbar();
} else {
dismissSnackbar();
}
}
}
private void dismissSnackbar() {
if (snackbar != null)
snackbar.dismiss();
}
private void showSnackbar() {
snackbar = Snackbar.make(refreshLayout, "An Error has occurred", Snackbar.LENGTH_INDEFINITE);
snackbar.show();
}
}
关键点在于 Snackbar.LENGTH_INDEFINITE,这意味着Snackbar
将会一直显示直到我们主动控制其消失——我们不需要让Android
系统控制它显示与否。
我们不会让Android
系统将状态搞乱,也不会让系统为UI引入一个与业务逻辑状态不一致的状态。我们宁愿让业务逻辑将CountriesViewState.pullToRefreshError
设置为true
两秒钟,然后将其设置为false
,而不愿使用Snackbar.LENGTH_SHORT
来显示Snackbar
两秒钟。
在RxJava
中我们怎么做呢?我们可以使用 Observable.timer() 和 startWith() 操作符:
public class CountriesPresenter extends MviBasePresenter<CountriesView, CountriesViewState> {
private final CountriesRepositroy repositroy = new CountriesRepositroy();
@Override protected void bindIntents() {
Observable<RepositoryState> loadingData =
intent(CountriesView::loadCountriesIntent).switchMap(ignored -> repositroy.loadCountries());
Observable<RepositoryState> pullToRefreshData =
intent(CountriesView::pullToRefreshIntent).switchMap(
ignored -> repositroy.reload().switchMap(repoState -> {
if (repoState instanceof PullToRefreshError) {
// 展示snakebar2秒中,然后dismiss它
return Observable.timer(2, TimeUnit.SECONDS)
.map(ignoredTime -> new ShowCountries()) // 仅仅展示列表
.startWith(repoState); // repoState == PullToRefreshError
} else {
return Observable.just(repoState);
}
}));
// 作为初始状态,展示加载中
CountriesViewState initialState = CountriesViewState.showLoadingState();
Observable<CountriesViewState> viewState = Observable.merge(loadingData, pullToRefreshData)
.scan(initialState, (oldState, repoState) -> repoState.reduce(oldState))
subscribeViewState(viewState, CountriesView::render);
}
CountriesRepositroy 的 reload()
方法返回了一个 Observable<RepoState>。RepoState
(前文中叫做PattialViewState
) 仅仅是个POJO
类,用来表示repository
是否取到数据,是成功的取到数据,或者产生了错误(点击查看源码)。
这之后,我们使用状态折叠器去计算View
的状态(通过scan()
操作符),如果您已阅读我之前的MVI系列文章,那么这应该此曾相识, “新”的东西是:
repositroy.reload().switchMap(repoState -> {
if (repoState instanceof PullToRefreshError) {
// 展示snakebar2秒中,然后dismiss它
return Observable.timer(2, TimeUnit.SECONDS)
.map(ignoredTime -> new ShowCountries()) // 仅仅展示列表
.startWith(repoState); // repoState == PullToRefreshError
} else {
return Observable.just(repoState);
}
这段代码执行以下操作:如果我们得到了一个error
(repoState instanceof PullToRefreshError
),我们会发射一个错误的状态(PullToRefreshError),这使得状态折叠器设置 CountriesViewState.pullToRefreshError = true。2秒后,Observable.timer()
将发射ShowCountries
状态,状态折叠器会设置 CountriesViewState.pullToRefreshError = false。
OK, 现在你可以看到MVI
中我们如何显示和隐藏SnakeBar
:
请记住这并非像是SingleLiveEvent
这样的解决方案。这是正确的状态管理,View只是显示或“渲染”给定的状态。因此用户如果再次从“国家详情”中返回,Snackbar
不再会被展示,因为状态在 CountriesViewState.pullToRefreshError = false 时已经发生了改变。
用户消除Snakebar
如果我们希望用户能够通过滑动操作主动消除Snakebar
呢。这非常简单,消除Snakebar 本身也是改变状态的一种intent
,要将它添加到目前的代码中,我们只需要确保定时器或者滑动的意图能够设置CountriesViewState.pullToRefreshError = false
。
我们唯一需要处理的是,如果在计时结束之前出发了滑动解除的intent
,我们必须结束定时器的计时行为,这听起来很复杂,但得益于RxJava
的优秀api
和操作符,这轻而易举:
Observable<Long> dismissPullToRefreshErrorIntent = intent(CountriesView::dismissPullToRefreshErrorIntent)
...
repositroy.reload().switchMap(repoState -> {
if (repoState instanceof PullToRefreshError) {
// 展示Snakebar,并在2秒后dismiss它
return Observable.timer(2, TimeUnit.SECONDS)
.mergeWith(dismissPullToRefreshErrorIntent) // 合并计时器和滑动dismiss的intent
.take(1) // 二者只会触发其中一个
.map(ignoredTime -> new ShowCountries()) // 展示列表
.startWith(repoState); // repoState == PullToRefreshError
} else {
return Observable.just(repoState);
}
使用mergeWith()
,我们将计时器和滑动消失的intent
组合成一个observable
,然后使用take(1)
仅将它们中的第一个事件进行发射。如果在计时器计时结束之前滑动Snakebar
,则取消计时器,反之则取消滑动消失的intent
。
结语
现在让我们来尝试将UI搞乱,我们尝试下拉刷新、并在计时过程中手动取消Snakebar
:
如你所见,无论我们如何尝试,都没有问题发生,由于 单向数据流 和 业务逻辑驱动的状态,View
可以正确显示UI小部件(View
层是无状态的,它从底层获取状态并只能对它进行展示)。比如,我们从未看到下拉刷新指示器和Snakebar
同时显示(除了Snackbar
退出过程中,两者的叠加情况)。
当然,Snackbar
这个示例非常简单,但我认为它证明了像Model-View-Intent
这样 严格规范下对状态进行管理 的架构模式的强大。不难想象这种模式对于更复杂的屏幕和使用场景同样也会非常棒。
本文的示例源码你可以从这里获取。
系列目录
《使用MVI打造响应式APP》原文
《使用MVI打造响应式APP》译文
《使用MVI打造响应式APP》实战
关于我
Hello,我是却把清梅嗅,如果您觉得文章对您有价值,欢迎 ❤️,也欢迎关注我的博客或者Github。
如果您觉得文章还差了那么点东西,也请通过关注督促我写出更好的文章——万一哪天我进步了呢?