[译]使用 MVI 编写响应式 APP — 第五部分 — 简单的调试

  • 原文地址:REACTIVE APPS WITH MODEL-VIEW-INTENT - PART5 - DEBUGGING WITH EASE
  • 原文作者:Hannes Dorfmann
  • 译文出自:掘金翻译计划
  • 本文永久链接:github.com/xitu/gold-m…
  • 译者:pcdack
  • 校对者:zhaochuanxing, hanliuxin5,

使用 MVI 编写响应式 APP — 第 5 部分 — 简单的调试

在前面的系列博客中我们已经讨论了 Model-View-Intent(MVI)模式和它的特征。在第一部分我们已经讨论了关于单向数据流的重要性和“业务逻辑”驱动型的应用状态的概念。在这篇博客中我们将看到如何通过 debug 来简化开发者的开发工作。

你以前有没有收到一个崩溃报告,并且你不能复现报告中的 bug?听起来很熟悉?我也觉得很熟悉!在花费数小时看 stacktrace 和我们的源代码,我选择在 issue 跟踪中关闭掉了这样的报告,而且跟随着一个小的 comment 像“不能复现这个 bug”或者“这一定是一个奇怪设备/厂商(大厂)导致的错误”。

用我们在这系列博客里开发的购物车 app 做例子:当在 home 页面,我们的用户可以做下拉刷新,崩溃的报告显示,由于某种未知的原因,当下拉刷新加载新数据的时候,会触发 NullPointerException 异常。

你做为开发这开始在 home 页面进行上拉刷新操作,但是,这个 App 并没有崩溃。它像预期的那样工作。因此,你关闭了代码。但是,你不能看到 NullPointException 在这里如何被抛出的。接着你开始了断点调试,一步一步地运行相关组件的代码,但是它仍旧是在正常工作。特喵的怎么才能重现这个 bug 呢?

这个问题是你不能够重现当崩溃发生的时候的场景。如果有用户在遇到崩溃问题时,能够给你崩溃报告,包含 App(发生崩溃前)的状态信息和调用堆栈信息,岂不美哉?伴随着单项数据流和 Model-View-Intent 模式那么这种情况将变得十分简单。我们简单记录用户触发的所有的 intent 和渲染到 view 上的 model(model 代表了 app 的状态、view 的状态)。 让我们在 home 页面上这样去做,在 HomePresenter 类上添加 log (对于更多的细节可以看第三部分 在第三部分中我们已经讨论过状态折叠器的优点)。在下面的代码中我将贴出我们使用 Crashlytics(类似于 Bugly) 的代码片段,但是它应当与其他的 crash 报告工具的使用是相同的。

class HomePresenter extends MviBasePresenter<HomeView, HomeViewState> {

  private final HomeViewState initialState; // Show loading indicator

  public HomePresenter(HomeViewState initialState){
    this.initialState = initialState;
  }

  @Override protected void bindIntents() {

    Observable loadFirstPage = intent(HomeView::loadFirstPageIntent)
          .doOnNext(intent -> Crashlytics.log("Intent: load first page"))
          .flatmap(...); // business logic calls to load data

    Observable pullToRefresh = intent(HomeView::pullToRefreshIntent)
          .doOnNext(intent -> Crashlytics.log("Intent: pull-to-refresh"))
          .flatmap(...); // business logic calls to load data

    Observable nextPage = intent(HomeView::loadNextPageIntent)
          .doOnNext(intent -> Crashlytics.log("Intent: load next page"))
          .flatmap(...); // business logic calls to load data

    Observable allIntents = Observable.merge(loadFirstPage, pullToRefresh, nextPage);
    Observable stateObservable = allIntents
          .scan(initialState, this::viewStateReducer) // call the state reducer
          .doOnNext(newViewState -> Crashlytics.log( "State: "+gson.toJson(newViewState) ));

    subscribeViewState(stateObservable, HomeView::render); // display new state
  }

  private HomeViewState viewStateReducer(HomeViewState previousState, PartialState changes){
    ...
  }
}
复制代码

应用RxJava的 .doOnNext() 操作符,在每个 intent、每个 intent 的结果和之后渲染到 view 上的状态上添加日志,我们序列化 view 状态为json对象(我们稍后来讨论这个)。

我们可以看一下这些 logs:

看一下这些 log,我们不仅可以看应用崩溃前的最新状态,而且可以看到用户达到这个状态的整个过程。为了更好的可读性,我已经强调了状态过滤,并且用_[…]_替换掉“数据”(这些项将被显示到 recycler view 上)。 因此,用户开启这个 app -加载第一页的意图。然后加载指示条显示"loadFirstPage"。然后,真的数据就被加载进来了(data[…])。 接下来用户滑动列表项并且到达了 recyclerView 的底部,这将触发加载下一页的意图去加载更多数据(分页),这将造成状态转换成"loadingNextPage":对。一旦下一页被加载的数据(data[…])已经被更新并且"loadNextPage":错误已经被矫正。用户第二次做同样的事情。并且它开始采用下拉刷新意图并且状态,状态转变为“loadingPullRefresh”:true。突然 App 崩溃了(没有更多之后的 log 信息)。

因此如何利用这些信息帮助我们修复这个 bug?显然,我们知道那个意图用户触发了,因此我们可以人工去复现 bug。此外,我们可以将我们的 app 的状态快照成 json。我们可以简单的将最后一个状态反序列化 json,并且成为我们的初始状态去修复这个 Bug:

String json ="  {\"data\":[...],\"loadingFirstPage\":false,\"loadingNextPage\":false,\"loadingPullToRefresh\":false} ";
HomeViewState stateBeforeCrash = gson.fromJson(json, HomeViewState.class);
HomePresenter homePresenter = new HomePresenter(stateBeforeCrash);
复制代码

然后,我们打开调试工具,触发下拉刷新的意图(intent)。它将出现在如果用户已经向下滑第二次滑到第二页没有更多的数据存在,并且,我们的 app 没有正确的处理,因此下拉刷新造成了崩溃。

总结

制作 app 的状态"快照"让我们的开发工作更加轻松。不仅我们可以容易的复现崩溃场景,另外,我们可以序列化状态去写回归测试,不用额外消耗任意代码。记住这仅仅适用于如果 app 的状态遵循单项数据流(被业务逻辑驱动),不变性和纯函数的原则。Model-View-Intent 带领我们去正确的方向,因此我们构建“可快照”的 app 是非常好和十分有用,这就是这种架构的“副作用”。

"可快照的" app 有什么缺点?显然我们序列化 app 的状态(例如:使用 Gson)。这将添加额外的计算时间。在我的一般大小的 app 中,首次使用 Gson 序列化需要大约 30 毫秒。因为 Gson 需要使用反射来扫描类去决定需要序列化的字段。随后的状态序列化在 Nexus 4 中平均需要花费 6 毫秒。当序列化运行在 .doOnNext() 这是一般运行在其他线程,但是,我 app 的用户不得不等 6 毫秒比那些没有快照的 app。我的观点是等 6 毫秒用户是很难察觉到。无论如何,关于快照状态的一个讨论是当崩溃发生时,从用户的设备通过崩溃日志工具向服务器上传的数据量是十分巨大的。如果用户连接着 wifi 没什么大不了的,但可能对于在使用手机流量的用户确实是一个问题。最后但是也很重要的一点,你也许泄露了伴随着状态的敏感数据的崩溃日志。要么就不要在上传的崩溃报告中去序列化那些敏感的数据(因此报告可能不完整并且几乎没啥用),要么就将这敏感数据加密(这可能需要一些额外的CPU时间)。

总结一下:就我个人而言,在给我的 app 做快照处理时我发现了很多益处,然而,你也不得不做一些权衡.也许你可以在内部版本或者 beta 版本上启用快照功能,看看在你自己的 app 上工作得如何。

红利:时间旅行

在开发时,如果可以拥有时间旅行的选择项,岂不美哉。也许嵌入一个调试侧边栏像 Jake Wharton 的 u2020 dome app。

所有我们需要类似于调试侧边栏只需要两个按钮“前一个状态”和“后一个状态”因此我们可以一步一步地从一个状态及时的到前一个状态(或下一个状态)。例如:如果我们已经做了一个 HTTP 请求作为状态变化的一部分,可以确定的是,在往前回溯时,我们并不想再次进行真正的 http 请求,因为与此同时后端的数据也可能会发生变化。

时间旅行要求一些额外的层,像一个代理层在一个 app 的边界部分。因此我们可以“录制”和“回放”状态像 http 请求(同理 sqlite等等)。对这类事情十分的感兴趣?这就像我的朋友 Felipe 为OKHttp做类似的事情。可以随意联系他来得到他正在写的库的更多细节。

你是否正在找一个十分有用的安卓库,可以录制和回放 OkHttp 网络交互,比如说 Espresso 测试?

— Felipe Lima (@felipecsl) 28. Februar 2017

这篇博客是使用 MVI 开发响应式 APP 的一部分。 这里是内容表:

  • Part 1: Model
  • Part 2: View and Intent
  • Part 3: State Reducer
  • Part 4: Independent UI Components
  • Part 5: Debugging with ease
  • Part 6: Restoring State
  • Part 7: Timing (SingleLiveEvent problem)

这是中文翻译:

  • 第一部分:Model
  • 第二部分:View 和 Intent
  • 第三部分:状态折叠器
  • 第四部分:独立 UI 组件开发

掘金翻译计划 是一个翻译优质互联网技术文章的社区,文章来源为 掘金 上的英文分享文章。内容覆盖 Android、iOS、前端、后端、区块链、产品、设计、人工智能等领域,想要查看更多优质译文请持续关注 掘金翻译计划、官方微博、知乎专栏。

你可能感兴趣的:(json,后端,ui)