MVI 架構(gòu)更佳實(shí)踐：支持 LiveData 屬性監(jiān)聽

作者：程序員江同學(xué) 2022-03-04 15:44:45

開發(fā) 架構(gòu)

本文主要介紹如何通過監(jiān)聽LiveData的屬性，來實(shí)現(xiàn)MVI架構(gòu)下的局部刷新。

前言

前面我們介紹了MVI架構(gòu)的基本原理與使用：MVVM 進(jìn)階版：MVI 架構(gòu)了解一下~

MVI架構(gòu)為了解決MVVM在邏輯復(fù)雜時需要寫多個LiveData(可變+不可變)的問題,使用ViewState對State集中管理，只需要訂閱一個 ViewState 便可獲取頁面的所有狀態(tài)。

通過集中管理ViewState，只需對外暴露一個LiveData，解決了MVVM模式下LiveData膨脹的問題。

但頁面的所有狀態(tài)都通過一個LiveData來管理，也帶來了一個嚴(yán)重的問題，即頁面不支持局部刷新。

雖說如果是RecyclerView可以通過DifferUtil來解決，但畢竟不是所有頁面都是通過RecyclerView寫的，支持DifferUtil也有一定的開發(fā)成本。

因此直接使用MVI架構(gòu)會帶來一定的性能損耗，相信這是很多人不愿意用MVI架構(gòu)的原因之一。

本文主要介紹如何通過監(jiān)聽LiveData的屬性，來實(shí)現(xiàn)MVI架構(gòu)下的局部刷新。

Mavericks框架介紹

Mavericks框架是Airbnb開源的一個MVI框架，Mavericks基于Android Jetpack與Kotlin Coroutines，主要目標(biāo)是使頁面開發(fā)更高效，更容易，更有趣，目前已經(jīng)在Airbnb的數(shù)百個頁面上使用。

下面我們來看下Mavericks是怎么使用的。

// 1. 包含頁面所有狀態(tài)的data class
data class CounterState(val count: Int = 0) : MavericksState
// 2.負(fù)責(zé)處理業(yè)務(wù)邏輯的ViewModel,易于單元測試
class CounterViewModel(initialState: CounterState) : MavericksViewModel<CounterState>(initialState) {
    // 通過setState更新頁面狀態(tài)
    fun incrementCount() = setState { copy(count = count + 1) }
}
// 3. View層，必須實(shí)現(xiàn)MavericksView接口    
class CounterFragment : Fragment(R.layout.counter_fragment), MavericksView {
    private val viewModel: CounterViewModel by fragmentViewModel()
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        counterText.setOnClickListener {
            viewModel.incrementCount()
        }
    }
    //4. 頁面刷新回調(diào)，每當(dāng)狀態(tài)刷新時會回調(diào)這里
    override fun invalidate() = withState(viewModel) { state ->
        counterText.text = "Count: ${state.count}"
    }
}

如上所示，看上去也很簡單，主要包括幾個模塊：

包括頁面所有狀態(tài)的Model層，其中的狀態(tài)全都是不可變的，并且有默認(rèn)值。
負(fù)責(zé)處理業(yè)務(wù)邏輯的ViewModel，在其中通過setState來更新頁面狀態(tài)。
View層，必須實(shí)現(xiàn)MavericksView接口，每當(dāng)狀態(tài)刷新時都會回調(diào)invalidate函數(shù),在這里渲染UI。

可以看出，Mavericks中View層與Model層的交互，也并沒有包裝成Action，而是直接暴露的方法。

上篇文章也的確有很多同學(xué)說使用Action交互比較麻煩，看起來Action這層的確可要可不要,Airbnb也沒有使用，主要看個人開發(fā)習(xí)慣吧。

支持局部刷新

上面介紹了Mavericks的簡單使用，下面我們來看下Mavericks是怎么實(shí)現(xiàn)局部刷新的。

data class UserState(
    val score: Int = 0,
    val previousHighScore: Int = 150,
    val livesLeft: Int = 99,
) : MavericksState {
    val pointsUntilHighScore = (previousHighScore - score).coerceAtLeast(0)
    val isHighScore = score >= previousHighScore
}
class CounterFragment : Fragment(R.layout.counter_fragment), MavericksView {
    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
     //直接監(jiān)聽State的屬性,并且支持設(shè)置監(jiān)聽模式  
        viewModel.onEach(UserState::pointsUntilHighScore,deliveryMode = uniqueOnly()) {
            //..
        }
  viewModel.onEach(UserState::score) {  
            //...
        }    
    }
}

如上所示，Mavericks可以只監(jiān)聽State的其中一個屬性來實(shí)現(xiàn)局部刷新，只有當(dāng)這個屬性發(fā)生變化時才觸發(fā)回調(diào)。
onEach也可以設(shè)置監(jiān)聽模式，主要是為了防止數(shù)據(jù)倒灌，例如Toast這些只需要彈一次，頁面重建時不應(yīng)該恢復(fù)的狀態(tài)，就適合使用uniqueOnly的監(jiān)聽模式。

Mavericks實(shí)現(xiàn)屬性監(jiān)聽的原理也很簡單，我們一起來看下源碼。

fun <VM : MavericksViewModel<S>, S : MavericksState, A> VM._internal1(
    owner: LifecycleOwner?,
    prop1: KProperty1<S, A>,
    deliveryMode: DeliveryMode = RedeliverOnStart,
    action: suspend (A) -> Unit
) = stateFlow
    // 通過對象取出屬性的值
    .map { MavericksTuple1(prop1.get(it)) }
    // 值發(fā)生變化了才會觸發(fā)回調(diào)  
    .distinctUntilChanged()
    .resolveSubscription(owner, deliveryMode.appendPropertiesToId(prop1)) { (a) ->
        action(a)
    }

主要是通過map將State轉(zhuǎn)化為它的屬性值。
通過distinctUntilChanged方法開啟防抖，相同的值不會回調(diào)，只有值修改了才會回調(diào)。
需要注意的是因?yàn)槭褂昧薑Property1，因此State的承載數(shù)據(jù)類必須避免混淆。

如上，就是Mavericks的基本介紹，想了解更多的同學(xué)可參考：https://github.com/airbnb/mavericks。

LiveData實(shí)現(xiàn)屬性監(jiān)聽

上面介紹了Mavericks是怎么實(shí)現(xiàn)局部刷新的，但直接使用它主要有兩個問題。

接入起來略微有點(diǎn)麻煩，例如Fragment必須實(shí)現(xiàn)MavericksView，有一定接入成本。
Mavericks的局部刷新是通過Flow實(shí)現(xiàn)的,但相信大多數(shù)人用的還是LiveData，有一定學(xué)習(xí)成本。

下面我們就來看下LiveData怎么實(shí)現(xiàn)屬性監(jiān)聽。

//監(jiān)聽一個屬性
fun <T, A> LiveData<T>.observeState(
    lifecycleOwner: LifecycleOwner,
    prop1: KProperty1<T, A>,
    action: (A) -> Unit
) {
    this.map {
        StateTuple1(prop1.get(it))
    }.distinctUntilChanged().observe(lifecycleOwner) { (a) ->
        action.invoke(a)
    }
}
//監(jiān)聽兩個屬性
fun <T, A, B> LiveData<T>.observeState(
    lifecycleOwner: LifecycleOwner,
    prop1: KProperty1<T, A>,
    prop2: KProperty1<T, B>,
    action: (A, B) -> Unit
) {
    this.map {
        StateTuple2(prop1.get(it), prop2.get(it))
    }.distinctUntilChanged().observe(lifecycleOwner) { (a, b) ->
        action.invoke(a, b)
    }
}
internal data class StateTuple1<A>(val a: A)
internal data class StateTuple2<A, B>(val a: A, val b: B)
//更新State
fun <T> MutableLiveData<T>.setState(reducer: T.() -> T) {
    this.value = this.value?.reducer()
}

如上所示，主要是添加一個擴(kuò)展方法，也是通過distinctUntilChanged來實(shí)現(xiàn)防抖。
如果需要監(jiān)聽多個屬性，例如兩個屬性有其中一個變化了就觸發(fā)刷新，也支持傳入兩個屬性。
需要注意的是LiveData默認(rèn)是不防抖的，這樣改造后就是防抖的了，所以傳入相同的值是不會回調(diào)的。
同時需要注意下承載State的數(shù)據(jù)類需要防混淆。

簡單使用

上面介紹了LiveData如何實(shí)現(xiàn)屬性監(jiān)聽，下面看下簡單的使用。

//頁面狀態(tài)，需要避免混淆
data class MainViewState(
    val fetchStatus: FetchStatus = FetchStatus.NotFetched,
    val newsList: List<NewsItem> = emptyList()
)
//ViewModel
class MainViewModel : ViewModel() {
    private val _viewStates: MutableLiveData<MainViewState> = MutableLiveData(MainViewState())
    //只需要暴露一個LiveData，包括頁面所有狀態(tài)
    val viewStates = _viewStates.asLiveData()
    private fun fetchNews() {
     //更新頁面狀態(tài)
        _viewStates.setState {
            copy(fetchStatus = FetchStatus.Fetching)
        }
        viewModelScope.launch {
            when (val result = repository.getMockApiResponse()) {
                //...
                is PageState.Success -> {
                    _viewStates.setState {
                        copy(fetchStatus = FetchStatus.Fetched, newsList = result.data)
                    }
                }
            }
        }
    }
}
//View層
class MainActivity : AppCompatActivity() {
 private fun initViewModel() {
        viewModel.viewStates.run {
            //監(jiān)聽newsList
            observeState(this@MainActivity, MainViewState::newsList) {
                newsRvAdapter.submitList(it)
            }
            //監(jiān)聽網(wǎng)絡(luò)狀態(tài)
            observeState(this@MainActivity, MainViewState::fetchStatus) {
                //..
            }
        }
    }
}