背景

上期《Google Android 架构设计拆解及改善建议》侧重拆解官方架构 “领域层” 设计误区，并给出改善建议 —— 通过 MVI-Dispatcher 承担 Event-Handler，

然有小伙伴表示，不仅要 MVI-Dispatcher，还想看看 Kotlin 版 MVI 实践

故这期，我们肝个 MVI-Dispatcher-KTX 示例项目而来。

项目简介

“单向数据流” 是近年公认 “图形化客户端开发” 领域最佳实践，

MVI-Dispatcher 抹除 “单向数据流” 学习成本，使开发者在不熟 mutable、MVI 情况下，仅根据简明易懂 input-output 设计亦可自动实现 “单向数据流” 开发，

KTX 版接口与 MVI-Dispatcher 保持一致，可彻底消除 mutable 样板代码；杜绝 setValue/emit 误用滥用；且可无缝整至 Jetpack MVVM 项目中。

以下排坑测试花絮：

SharedFlow 也 “丢” 事件？

同 MVI-Dispatcher，KTX 版在 sample module 提供一系列常规 + 暴力测试，

我们于 ComplexRequester 安排 4 组事件选项，事件 1 可轮询通知事件 4 回推 UI，事件 2 延迟 200 毫秒后可回推 UI，事件 3 可直接回推 UI，

class ComplexRequester : MviDispatcherKTX<ComplexEvent>() {
  override suspend fun onHandle(event: ComplexEvent) {
    when (event) {
      is ComplexEvent.ResultTest1 -> interval(100).collect { input(ComplexEvent.ResultTest4(it)) }
      is ComplexEvent.ResultTest2 -> timer(1000).collect { sendResult(event) }
      is ComplexEvent.ResultTest3 -> sendResult(event)
      is ComplexEvent.ResultTest4 -> sendResult(event)
    }
  }
  ...
}

与此同时，我们在 MainActivity 通过 output 函数注册观察 MVI-Dispatcher-KTX，并通过 input 函数向 MVI-Dispatcher-KTX 发起事件 1、2、3，

class MainActivity : BaseActivity() {

  ...
  
  override fun onOutput() {
    complexRequester.output(this) { complexEvent ->
      when (complexEvent) {
        is ComplexEvent.ResultTest1 -> Log.d("e", "---1")
        is ComplexEvent.ResultTest2 -> Log.d("e", "---2")
        is ComplexEvent.ResultTest3 -> Log.d("e", "---3")
        is ComplexEvent.ResultTest4 -> Log.d("e", "---4 " + complexEvent.count)
      }
    }
  }
  
  override fun onInput() {
    super.onInput()
    
    complexRequester.input(ComplexEvent.ResultTest1())
    
    complexRequester.input(ComplexEvent.ResultTest2())
    complexRequester.input(ComplexEvent.ResultTest2())
    complexRequester.input(ComplexEvent.ResultTest2())
    complexRequester.input(ComplexEvent.ResultTest2())
    
    complexRequester.input(ComplexEvent.ResultTest3())
    complexRequester.input(ComplexEvent.ResultTest3())
    complexRequester.input(ComplexEvent.ResultTest3())
  }
}

结果出人意料：

com.kunminx.purenote_ktx D/e: ---4 0
com.kunminx.purenote_ktx D/e: ---4 1
com.kunminx.purenote_ktx D/e: ---4 2
com.kunminx.purenote_ktx D/e: ---4 3
com.kunminx.purenote_ktx D/e: ---4 4
com.kunminx.purenote_ktx D/e: ---4 5
com.kunminx.purenote_ktx D/e: ---4 6
com.kunminx.purenote_ktx D/e: ---4 7
com.kunminx.purenote_ktx D/e: ---2
com.kunminx.purenote_ktx D/e: ---2
com.kunminx.purenote_ktx D/e: ---2
com.kunminx.purenote_ktx D/e: ---2
com.kunminx.purenote_ktx D/e: ---4 8
com.kunminx.purenote_ktx D/e: ---4 9
com.kunminx.purenote_ktx D/e: ---4 10
com.kunminx.purenote_ktx D/e: ---4 11
com.kunminx.purenote_ktx D/e: ---4 12

事件 3 回推结果呢？

MVI-Dispatcher 测试时无此问题，为何 KTX 版便有？

于是继续打 Log 观察：

class ComplexRequester : MviDispatcherKTX<ComplexEvent>() {
  override suspend fun onHandle(event: ComplexEvent) {
    when (event) {
      ...
      is ComplexEvent.ResultTest3 -> {
        Log.d("---", "ResultTest3-sendResult")
        sendResult(event)
      }
    }
  }
}

KTX 版基类中观察 SharedFlow 收集时机：

open class MviDispatcherKTX<E> : ViewModel() {
  fun output(activity: AppCompatActivity?, observer: (E) -> Unit) {
    initQueue()
    activity?.lifecycleScope?.launch {
      Log.d("---", "activity.lifecycleScope.launch")
      activity.repeatOnLifecycle(Lifecycle.State.STARTED) {
        Log.d("---", "activity.repeatOnLifecycle")
        _sharedFlow?.collect { observer.invoke(it) }
      }
    }
  }
  ...
}

继续输出结果：

com.kunminx.purenote_ktx D/---: activity.lifecycleScope.launch
com.kunminx.purenote_ktx D/---: ResultTest3-sendResult
com.kunminx.purenote_ktx D/---: ResultTest3-sendResult
com.kunminx.purenote_ktx D/---: ResultTest3-sendResult
com.kunminx.purenote_ktx D/---: activity.repeatOnLifecycle
com.kunminx.purenote_ktx D/e: ---4 0
com.kunminx.purenote_ktx D/e: ---4 1
com.kunminx.purenote_ktx D/e: ---4 2
com.kunminx.purenote_ktx D/e: ---4 3
com.kunminx.purenote_ktx D/e: ---4 4

发现端倪 —— sharedFlow.emit 事件 3 时机早于 activity.repeatOnLifecycle 时机，错过 sharedFlow 收集时，

故此处将 sharedFlow replay 值改为 1 验证下：

open class MviDispatcherKTX<E> : ViewModel() {
  private var _sharedFlow: MutableSharedFlow<E>? = null

  private fun initQueue() {
    if (_sharedFlow == null) _sharedFlow = MutableSharedFlow(
      replay = 1,
      onBufferOverflow = BufferOverflow.DROP_OLDEST,
      extraBufferCapacity = initQueueMaxLength()
    )
  }
  ...
}

这下收到，确实是时机问题，也即 sharedFlow 并非人眼感知到的 “丢事件”，而是其默认 replay = 0，不自动回推缓存数据给订阅者，该设计符合 “事件” 场景，

且此处如设置为 replay = 1，发射 3 次也仅能收到 1 次，故修改 replay 方案 pass。

com.kunminx.purenote_ktx D/---: activity.lifecycleScope.launch
com.kunminx.purenote_ktx D/---: ResultTest3-sendResult
com.kunminx.purenote_ktx D/---: ResultTest3-sendResult
com.kunminx.purenote_ktx D/---: ResultTest3-sendResult
com.kunminx.purenote_ktx D/---: activity.repeatOnLifecycle
com.kunminx.purenote_ktx D/e: ---3
com.kunminx.purenote_ktx D/e: ---4 0
com.kunminx.purenote_ktx D/e: ---4 1
com.kunminx.purenote_ktx D/e: ---4 2
com.kunminx.purenote_ktx D/e: ---4 3
com.kunminx.purenote_ktx D/e: ---4 4

那怎办，repeatOnLifecycle STARTED 回调相对 emit 存在时延，其实在 Activity 中易解决，即通过 View.post 时机，让 emit 处于 MessageQueue 中顺序执行，如此便能确保时机正确，

但发射一事件还要 View.post，显然易忘记、造成一致性问题，且 MVI-Dispatcher-KTX 采用内聚设计，故此处不妨往 input 方法注入 Activity，再于内部拿取 decorView 自动完成 post …

open class MviDispatcherKTX<E> : ViewModel() {
  ...
  fun input(event: E, activity: AppCompatActivity?) {
    activity?.window?.decorView?.post {
      viewModelScope.launch { onHandle(event) }
    }
  }
}

倒也行，不过每次 input 都额外注入个 Activity，这写法是不有点莫名其妙？

且如我想在 KTX 版子类内部 input “side effect” 怎办？故该方案暂且 pass。

… 还有无别的办法？

有，

考虑到 “错过事件” 情形较极端，常规 “从数据层取数据” 等操作，由于操作有其耗时，不易遇见；

如是页面 onCreate 环节末尾发送某 sealed.object 事件，由于毫不费时，则易先于 activity.repeatOnLifecycle(Lifecycle.State.STARTED)，错过时机，

故此处可于每次 input 时自动延迟 1 毫秒 ——

默认设置为 1 毫秒，且通过维护一 delayMap 自动判断时机取消延迟：

open class MviDispatcherKTX<E> : ViewModel() {

  ...
  
  fun input(event: E) {
    viewModelScope.launch {
      if (needDelayForLifecycleState) delayForLifecycleState().collect { onHandle(event) }
      else onHandle(event)
    }
  }

  private val needDelayForLifecycleState
    get() = delayMap.isNotEmpty()
}

输出 Log 看看：

com.kunminx.purenote_ktx D/---: activity.lifecycleScope.launch
com.kunminx.purenote_ktx D/---: activity.repeatOnLifecycle
com.kunminx.purenote_ktx D/---: ResultTest3-sendResult
com.kunminx.purenote_ktx D/e: ---3
com.kunminx.purenote_ktx D/---: ResultTest3-sendResult
com.kunminx.purenote_ktx D/e: ---3
com.kunminx.purenote_ktx D/---: ResultTest3-sendResult
com.kunminx.purenote_ktx D/e: ---3
com.kunminx.purenote_ktx D/e: ---4 0
com.kunminx.purenote_ktx D/e: ---4 1
com.kunminx.purenote_ktx D/e: ---4 2
com.kunminx.purenote_ktx D/e: ---4 3
com.kunminx.purenote_ktx D/e: ---4 4

至此，3 个事件 3 皆收到。

UnPeek-LiveData 如何？

让我们借一部说话，看看 UnPeek-LiveData 表现：

public class MainActivity extends BaseActivity {
  private UnPeekLiveData<String> unpeek = new UnPeekLiveData<>();
  
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    
    ...

    unpeek.observe(this,s -> {
      Log.d("----",s);
    });
    unpeek.setValue("hahaha");
  }
}

输出 Log 看看：

com.kunminx.unpeeklivedata D/----: hahaha

鉴于 UnPeek-LiveData 表现，加之 MVI-Dispatcher 内部维护定长队列，故默认无原生 LiveData “连发丢事件” 问题。

最后

MVI-Dispatcher-KTX + 排坑小故事至此已分享完毕，目前 MVI-Dispatcher 及 MVI-Dispatcher-KTX 正在公测中，欢迎各位大佬测试反馈：

Github：MVI-Dispatcher

Github：MVI-Dispatcher-KTX

License：本文封面 Android 机器人是在 Google 原创及共享成果基础上再创作而成，遵照知识共享署名 3.0 许可所述条款付诸应用。

repeatOnLifecycle + SharedFlow 隐藏坑排查与治理

背景

项目简介

SharedFlow 也 “丢” 事件？

UnPeek-LiveData 如何？

最后

猜你喜欢