在 Jetpack 架構(gòu)規(guī)范中， ViewModel 與 View 之間應(yīng)該遵循單向數(shù)據(jù)流的通信方式，Events 永遠(yuǎn)從 View 流向 VM ，而 State 從 VM 流向 View。

如果 ViewModel 對(duì) View 暴露了不適當(dāng)?shù)慕涌陬愋停瑒t會(huì)破壞單向數(shù)據(jù)流的形成。不適當(dāng)?shù)慕涌陬愋统Ｒ?jiàn)于以下兩點(diǎn)：

• 暴露 Mutable 狀態(tài)
• 暴露 Suspend 方法

暴露 Mutable 狀態(tài)

ViewModel 對(duì)外暴露的數(shù)據(jù)狀態(tài)，無(wú)論是 LiveData 或是 StateFlow 都應(yīng)該使用 Immutable 的接口類型進(jìn)行暴露而非 Mutable 的具體實(shí)現(xiàn)。View 只能單向訂閱這些狀態(tài)的變化，避免對(duì)狀態(tài)反向更新。

class MyViewModel: ViewModel() {
   private val _loading = MutableLiveData<Boolean>()
   val loading: LiveData<Boolean>
       get() = _loading
}

未來(lái)避免暴露 Mutable 類型，我們需要像上面這樣處理，將 loading 的具體實(shí)現(xiàn)定義為一個(gè) private 的 Mutable 類型，便于內(nèi)部更新。

private val _loading : MutableStateFlow<Boolean?> = MutableStateFlow(null)
val loading = _loading.asStateFlow()

StateFlow 的寫(xiě)法也類似，但是通過(guò) asStateFlow 可以少寫(xiě)一個(gè)類型聲明，但是要注意此時(shí)不要使用 custom get()， 不然 asStateFlow 會(huì)執(zhí)行多次。

每次都要多聲明一個(gè)帶劃線的私有變量會(huì)讓代碼顯得有些累贅，也正因如此，有 issue 希望 Kotlin 增加類似下面的語(yǔ)法使得對(duì)外對(duì)內(nèi)可以暴露不同類型。

//https://youtrack.jetbrains.com/issue/KT-14663
private val loading = MutableLiveData<Boolean>()
        public get(): LiveData<Boolean>

在新語(yǔ)法還未出現(xiàn)的當(dāng)下，一個(gè)讓代碼變整潔的思路是為 ViewModel 提取對(duì)外暴露的抽象類：

abstract class MyViewModel: ViewModel() {
   abstract val loading: LiveData<Boolean>
}
class MyViewModelImpl: MyViewModel() {
   override val loading = MutableLiveData<Boolean>()
   fun doSomeWork() {
     // ...
     loading.value = true
   }
}

如上， MyViewModelImpl 內(nèi)重寫(xiě)的 loading 可以作為 Mutable 類型使用。雖然這種做法會(huì)增加了一個(gè)抽象類代碼量不減反增，但是它使 MyViewModelImpl 內(nèi)的代碼更加簡(jiǎn)潔，而且對(duì)外可以隱藏更多 ViewModel 的實(shí)現(xiàn)細(xì)節(jié)，封裝性更好。

但是需要特別注意的是，為了創(chuàng)建 MyViewModel 必須使用自定義 Factory：

val vm : MyViewModel by viewModels { MyViewModelFactory() }

如果你的工程引入了 Hilt ，那么可以通過(guò) @Bind 綁定 ViewModel 的接口與實(shí)現(xiàn)，無(wú)需自定義 Factory 了，寫(xiě)法跟以前一樣，直接使用 by viewModels() 即可

@Module
@InstallIn(ViewModelComponent::class)
abstract class MyViewModule {
    @Binds
    abstract fun MyViewModel(instance: MyViewModelImpl): MyViewModel
}
@HiltViewModel
class MyViewModelImpl @Inject constructor() : MyViewModel()

暴露 Suspend 方法

相對(duì)于暴露 Mutable 狀態(tài)，暴露 Suspend 方法的錯(cuò)誤則更為常見(jiàn)。

按照單向數(shù)據(jù)流的思想 ViewModel 需要提供 API 給 View 用于發(fā)送 Events，我們?cè)诙x API 時(shí)需要注意避免使用 Suspend 函數(shù)，理由如下：

• 來(lái)自 ViewModel 的數(shù)據(jù)應(yīng)該通過(guò)訂閱 UiState 獲取，因此 ViewModel 的其他方法方法不應(yīng)該有返回值，而 suspend 函數(shù)會(huì)鼓勵(lì)返回值的出現(xiàn)。
• 理想的 MVVM 中 View 的職責(zé)僅僅是渲染 UI，業(yè)務(wù)邏輯盡量移動(dòng)到 ViewModel 執(zhí)行，利于單元測(cè)試的同時(shí)，ViewModelScope 可以保證一些耗時(shí)任務(wù)的穩(wěn)定執(zhí)行。如果暴露掛起函數(shù)給 View，則協(xié)程需要在 lifecycleScope 中啟動(dòng)，在橫豎屏等場(chǎng)景中會(huì)中斷任務(wù)的進(jìn)行。

因此，ViewModel 為 View 暴露的 API 應(yīng)該是非掛起且無(wú)法返回值的方法，以下是官網(wǎng)的代碼實(shí)例：

// DO create coroutines in the ViewModel
class LatestNewsViewModel(
    private val getLatestNewsWithAuthors: GetLatestNewsWithAuthorsUseCase
) : ViewModel() {
    private val _uiState = MutableStateFlow<LatestNewsUiState>(LatestNewsUiState.Loading)
    val uiState: StateFlow<LatestNewsUiState> = _uiState
    fun loadNews() {
        viewModelScope.launch {
            val latestNewsWithAuthors = getLatestNewsWithAuthors()
            _uiState.value = LatestNewsUiState.Success(latestNewsWithAuthors)
        }
    }
}
// Prefer observable state rather than suspend functions from the ViewModel
class LatestNewsViewModel(
    private val getLatestNewsWithAuthors: GetLatestNewsWithAuthorsUseCase
) : ViewModel() {
    // DO NOT do this. News would probably need to be refreshed as well.
    // Instead of exposing a single value with a suspend function, news should
    // be exposed using a stream of data as in the code snippet above.
    suspend fun loadNews() = getLatestNewsWithAuthors()
}

代碼中建議暴露一個(gè)普通的無(wú)返回值的 loadNews ，而 latestNewsWithAuthors 的信息應(yīng)該通過(guò)訂閱 LatestNewsUiState 獲得 。

有一點(diǎn)讓人迷惑的是，官方文檔上有這么一句話：

Suspend functions in the ViewModel can be useful if instead of exposing state using a stream of data, only a single value needs to be emitted.

鏈接

對(duì)于單發(fā)數(shù)據(jù)的請(qǐng)求允許使用掛起函數(shù)返回。但我建議大家忘掉這句話，理由有兩點(diǎn)：

• 掛起函數(shù)的口子一開(kāi)就容易不分場(chǎng)景的濫用，如果整體數(shù)據(jù)流結(jié)構(gòu)造成破壞反而因小失大，索性應(yīng)該從源頭禁止
• 理論上來(lái)說(shuō)，UI 上不存在單發(fā)數(shù)據(jù)請(qǐng)求的必要性，完全可以通過(guò)良好的設(shè)計(jì)轉(zhuǎn)化成 UiState ，這也更符合響應(yīng)式的編程模型。

到此這篇關(guān)于Android Jetpack架構(gòu)中ViewModel接口暴露的不合理探究的文章就介紹到這了,更多相關(guān)Android ViewModel接口內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論