Jetpack MVVM 使用错误(五):ViewModel 接口暴露不合理

简介: Jetpack 提倡单向数据流架构,ViewModel 对外暴露的接口如果不合理,将破坏数据流的单向流动。

在 Jetpack 架构规范中, ViewModel 与 View 之间应该遵循单向数据流的通信方式,Events 永远从 View 流向 VM ,而 State 从 VM 流向 View。

如果 ViewModel 对 View 暴露的接口类型不合理很容易会破坏数据的单向流动。不合理的接口常见于以下两点:

  1. 暴露 Mutable 状态
  2. 暴露 Suspend 方法

不合理1:暴露 Mutable 状态

ViewModel 对外暴露的数据状态,无论是 LiveData 或是 StateFlow 都应该使用 Immutable 的接口类型进行暴露而非 Mutable 的具体实现。View 只能单向订阅这些状态的变化,避免对状态反向更新。

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

未来避免暴露 Mutable 类型,我们需要像上面这样处理,将 loading 的具体实现定义为一个 private 的 Mutable 类型,便于内部更新。

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

StateFlow 的写法也类似,但是通过 asStateFlow 可以少写一个类型声明,但是要注意此时不要使用 custom get(), 不然 asStateFlow 会执行多次。
每次都要多声明一个带划线的私有变量会让代码显得有些累赘,也正因如此,有 issue 希望 Kotlin 增加类似下面的语法使得对外对内可以暴露不同类型。

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

在新语法还未出现的当下,一个让代码变整洁的思路是为 ViewModel 提取对外暴露的抽象类:

abstract class MyViewModel: ViewModel() {
   abstract val loading: LiveData<Boolean>
}

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

如上, MyViewModelImpl 内重写的 loading 可以作为 Mutable 类型使用。虽然这种做法会增加了一个抽象类代码量不减反增,但是它使 MyViewModelImpl 内的代码更加简洁,而且对外可以隐藏更多 ViewModel 的实现细节,封装性更好。
但是需要特别注意的是,为了创建 MyViewModel 必须使用自定义 Factory:

val vm : MyViewModel by viewModels { MyViewModelFactory() }

如果你的工程引入了 Hilt ,那么可以通过 @Bind 绑定 ViewModel 的接口与实现,无需自定义 Factory 了,写法跟以前一样,直接使用 by viewModels() 即可

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

@HiltViewModel
class MyViewModelImpl @Inject constructor() : MyViewModel()

不合理2:暴露 Suspend 方法

相对于暴露 Mutable 状态,暴露 Suspend 方法的错误则更为常见。
按照单向数据流的思想 ViewModel 需要提供 API 给 View 用于发送 Events,我们在定义 API 时需要注意避免使用 Suspend 函数,理由如下:

  1. 来自 ViewModel 的数据应该通过订阅 UiState 获取,因此 ViewModel 的其他方法方法不应该有返回值,而 suspend 函数会鼓励返回值的出现。
  2. 理想的 MVVM 中 View 的职责仅仅是渲染 UI,业务逻辑尽量移动到 ViewModel 执行,利于单元测试的同时,ViewModelScope 可以保证一些耗时任务的稳定执行。如果暴露挂起函数给 View,则协程需要在 lifecycleScope 中启动,在横竖屏等场景中会中断任务的进行。

因此,ViewModel 为 View 暴露的 API 应该是非挂起且无法返回值的方法,以下是官网的代码实例:

// 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()
}

代码中建议暴露一个普通的无返回值的 loadNews ,而 latestNewsWithAuthors 的信息应该通过订阅 LatestNewsUiState 获得 。

有一点让人迷惑的是,官方文档上有这么一句话:

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. <br/> https://developer.android.com/kotlin/coroutines/coroutines-best-practices#viewmodel-coroutines

对于单发数据的请求允许使用挂起函数返回。但我建议大家忘掉这句话,理由有两点:

  1. 挂起函数的口子一开就容易不分场景的滥用,如果整体数据流结构造成破坏反而因小失大,索性应该从源头禁止
  2. 理论上来说,UI 上不存在单发数据请求的必要性,完全可以通过良好的设计转化成 UiState ,这也更符合响应式的编程模型。

更多阅读

目录
相关文章
|
6月前
|
前端开发 测试技术 API
Jetpack MVVM 七宗罪之六:ViewModel 接口暴露不合理
Jetpack MVVM 七宗罪之六:ViewModel 接口暴露不合理
85 0
|
6月前
|
前端开发
Jetpack MVVM七宗罪之三:在 onViewCreated 中加载数据
Jetpack MVVM七宗罪之三:在 onViewCreated 中加载数据
66 0
|
6月前
|
前端开发 定位技术 开发工具
Jetpack MVVM七宗罪 之二:在 launchWhenX 中启动协程
Jetpack MVVM七宗罪 之二:在 launchWhenX 中启动协程
79 0
|
6月前
|
前端开发 Java API
Jetpack MVVM 七宗罪之五: 在 Repository 中使用 LiveData
Jetpack MVVM 七宗罪之五: 在 Repository 中使用 LiveData
116 0
|
30天前
|
存储 前端开发 测试技术
Kotlin教程笔记-使用Kotlin + JetPack 对旧项目进行MVVM改造
Kotlin教程笔记-使用Kotlin + JetPack 对旧项目进行MVVM改造
|
6月前
|
前端开发 JavaScript Android开发
Jetpack MVVM 七宗罪之四: 使用 LiveData/StateFlow 发送 Events
Jetpack MVVM 七宗罪之四: 使用 LiveData/StateFlow 发送 Events
149 0
|
4月前
|
XML 存储 API
Jetpack初尝试 NavController,LiveData,DataBing,ViewModel,Paging
Jetpack初尝试 NavController,LiveData,DataBing,ViewModel,Paging
|
6月前
|
前端开发 Android开发
Android架构组件JetPack之DataBinding玩转MVVM开发实战(四)
Android架构组件JetPack之DataBinding玩转MVVM开发实战(四)
Android架构组件JetPack之DataBinding玩转MVVM开发实战(四)
|
6月前
|
存储 设计模式 前端开发
构建高效安卓应用:Jetpack MVVM 架构的实践之路
【4月更文挑战第9天】 在移动开发的迅猛浪潮中,Android 平台以其开放性和灵活性受到开发者青睐。然而,随着应用复杂度的不断增加,传统的开发模式已难以满足快速迭代和高质量代码的双重要求。本文将深入探讨 Jetpack MVVM 架构模式在 Android 开发中的应用实践,揭示如何通过组件化和架构设计原则提升应用性能,实现数据驱动和UI分离,进而提高代码可维护性与测试性。我们将从理论出发,结合具体案例,逐步展开对 Jetpack MVVM 架构的全面剖析,为开发者提供一条清晰、高效的技术实施路径。
|
6月前
|
设计模式 前端开发 数据库
构建高效Android应用:使用Jetpack架构组件实现MVVM模式
【4月更文挑战第21天】 在移动开发领域,构建一个既健壮又易于维护的Android应用是每个开发者的目标。随着项目复杂度的增加,传统的MVP或MVC架构往往难以应对快速变化的市场需求和复杂的业务逻辑。本文将探讨如何利用Android Jetpack中的架构组件来实施MVVM(Model-View-ViewModel)设计模式,旨在提供一个更加模块化、可测试且易于管理的代码结构。通过具体案例分析,我们将展示如何使用LiveData, ViewModel, 和Repository来实现界面与业务逻辑的分离,以及如何利用Room数据库进行持久化存储。最终,你将获得一个响应迅速、可扩展且符合现代软件工
92 0