前言：由于框架本身也在不断地迭代，因此文章中的部分代码可能存在更新或者过时，如果你想阅读源码或者查看代码的在项目中的实际使用方法，可以查看笔者目前在维护的compose项目：Spacecraft: 《Spacecraft - 我的安卓技术实践平台》-查看代码请进入develop分支 (gitee.com)
本篇内容主要为如何把ViewModel改造成状态和事件的容器，如果你没有看过上一篇，请跳转至安卓MVI架构真的来了？动手试着封装吧（一）
当状态遇上了事件
- 状态
View在监听UI状态的时候，会记录初始值并初始化自身，如果后续的监听中，View发现了UI状态的值与之前发生了变化，就会更新自身（或者调用与之相关的逻辑代码）
- 当状态中混杂了事件
可见，如果你把事件（例如toast事件）也当成UI状态的一部分的时候，那么这个只需要显示一次的toast就会被携带到下次UI重构中，以一种“状态”的方式复活，即数据倒灌。
事件与状态分手吧
如果我们不希望事件以一种状态的方式被倒灌到下次UI重构中，就把它从状态中提取出来吧。在谷歌的开发者文档中，UiState是用kotlin语言中的StateFlow实现的，而StateFlow是一种特殊的SharedFlow，因此使用SharedFlow来表示事件流，而状态就用原本的StateFlow。
如果你对SharedFlow和StateFlow还不是特别理解，可以参考以下的文档（为掘金其他优秀作者撰写，仅供参考）：
- 协程进阶技巧 - StateFlow和SharedFlow - 掘金 (juejin.cn)
- [Kotlin Tutorials 19] Kotlin Flows, SharedFlow and StateFlow in Android - 掘金 (juejin.cn)
回到正题，我们先定义两个接口，分别代表状态和事件，然后用一个容器去存放他们。
@Keep
interface UiState
@Keep
interface UiSingleEvent
我并不希望对ViewModel进行直接封装成容器本身，即实现一套类似BaseViewModel的东东，这种继承重写的方式也许可以实现我的需求，但是过于生硬，也不容易对现有的代码进行重构（修改基类过于蛋疼），因此我更希望容器和viewModel的关系更像activity和viewModel的关系。
//activity中的viewModel
private val viewModel by viewModels<FriendViewModel>()
//希望实现类似的api
private val container by containers()
接下来，写一个容器接口，容器拥有状态和事件的流。
/**
* 状态容器，分别存储UI状态和单次事件，如果不包含单次事件，则使用[Nothing]
*/
interface Container<STATE : UiState, SINGLE_EVENT : UiSingleEvent> {
//ui状态流
val uiStateFlow: StateFlow<STATE>
//单次事件流
val singleEventFlow: Flow<SINGLE_EVENT>
}
我们对原来的接口增加一个直接子类，增加2个修改方法。这样做参考了List和MutableList的关系，MutableContainer是对内提供的（例如给viewModel使用），允许取值和修改；Container是对外提供的（例如activity，fragment等），只允许取值，这样避免了UI绕过viewModel直接修改UI状态的值，确保数据单向流动。
interface MutableContainer<STATE : UiState, SINGLE_EVENT : UiSingleEvent> :
Container<STATE, SINGLE_EVENT> {
//更新状态
fun updateState(action: STATE.() -> STATE)
//发送事件
fun sendEvent(event: SINGLE_EVENT)
}
最后，得出一个实现类，RealContainer，其中UI状态使用了StateFlow，UI事件则使用SharedFlow（确保事件不会倒灌）。
internal class RealContainer<STATE : UiState, SINGLE_EVENT : UiSingleEvent>(
initialState: STATE,
private val parentScope: CoroutineScope,
) : MutableContainer<STATE, SINGLE_EVENT> {
private val _internalStateFlow = MutableStateFlow(initialState)
private val _internalSingleEventSharedFlow = MutableSharedFlow<SINGLE_EVENT>()
override val uiSteFlow: StateFlow<STATE> = _internalStateFlow
override val singleEventFlow: Flow<SINGLE_EVENT> = _internalSingleEventSharedFlow
override fun updateState(action: STATE.() -> STATE) {
_internalStateFlow.update { action(_internalStateFlow.value) }
}
override fun sendEvent(event: SINGLE_EVENT) {
parentScope.launch {
_internalSingleEventSharedFlow.emit(event)
}
}
}
到这里，其实容器已经可以直接使用的了：在ViewModel中新增一个成员变量，然后new一个容器对象，viewModel对容器对象进行赋值操作，View层分别订阅2个流即可完成状态和事件的分离，即可完成状态和事件的分离。
class FriendViewModel : ViewModel() {
//对内容器
private val _myContainer=RealContainer<FriendUiState,YsSingleEvent>(FriendUiState(),viewModelScope)
//对外容器
val myContainer:Container<FriendUiState,YsSingleEvent> = _myContainer
}
为了进一步封装和屏蔽容器类的构造细节，我们参考viewModel在kotlin中的使用方法，实现一套委任模式。给ViewModel添加一个扩展函数containers()，然后返回Lazy对象，这样实现了懒加载和函数封装的功能。
/**
* 构建viewModel的Ui容器，存储Ui状态和一次性事件
*/
fun <STATE : UiState, SINGLE_EVENT : UiSingleEvent> ViewModel.containers(
initialState: STATE,
): Lazy<MutableContainer<STATE, SINGLE_EVENT>> {
return ContainerLazy(initialState, viewModelScope)
}
class ContainerLazy<STATE : UiState, SINGLE_EVENT : UiSingleEvent>(
initialState: STATE,
parentScope: CoroutineScope
) : Lazy<MutableContainer<STATE, SINGLE_EVENT>> {
private var cached: MutableContainer<STATE, SINGLE_EVENT>? = null
override val value: MutableContainer<STATE, SINGLE_EVENT> = cached
?: RealContainer<STATE, SINGLE_EVENT>(initialState, parentScope).also {
cached = it
}
override fun isInitialized() = cached != null
}
使用了扩展方法+委任模式后的代码，代码减少了许多，同时屏蔽了容器的构造参数细节。
class FriendViewModel @Inject constructor(
private val friendRepository: FriendRepository,
) : ViewModel() {
//定义UI状态
data class FriendUiState(
//朋友列表
val friendBeanList: List<FriendBean> = emptyList(),
//是否刷新中
val refreshing: Boolean = false,
//是否加载更多
val loadMore: Boolean = false,
//是否还有更多数据
val noMoreData: Boolean = false,
) : UiState
//定义一次性事件
sealed class FriendSingleEvent : UiSingleEvent {
class ToastEvent(val message: String, val short: Boolean = false) :
FriendSingleEvent()
}
//对内容器
private val _container by containers<FriendUiState, FriendSingleEvent>(FriendUiState())
//对外容器
val container: Container<FriendUiState, FriendSingleEvent> = _container
现在，我们已经可以直接在viewModel中对状态流和事件流进行操作
//更新状态
_container.updateState {
copy(
friendBeanList =
//如果是刷新，则清空列表
if (refresh) data.list
//如果不是刷新，则添加在列表的后面
else friendBeanList + data.list,
//没有数据
noMoreData = data.list.isEmpty()
)
}
//发送事件
_container.sendEvent(FriendSingleEvent.ToastEvent(it))
