【Orbit-mvi】Android MVI 框架推荐与示例,简洁优雅的实现MVI代码结构

项目介绍

示例程序

  • 预览
  • 添加依赖项到build.gradle
scss 复制代码
implementation("org.orbit-mvi:orbit-core:9.0.0")
implementation("org.orbit-mvi:orbit-viewmodel:9.0.0")

代码结构

  1. 为页面创建一个状态类XXState,包含所有状态信息,注意state中的字段是val的,不可变的,每次页面刷新都是发出一个新的state对象
kotlin 复制代码
data class MyState(
    val isLike: Boolean = false, // 是否点赞
    val likeCount: Int = 0, // 点赞数
)
  1. 为页面创建一个副作用类XXEffect,一些一次性事件,类如Toast, Loading都放在这里
kotlin 复制代码
sealed class MyEffect {
    data class Loading(val show: Boolean, val text: String? = null) : MyEffect()
    data class Toast(val text: String) : MyEffect()
}
  1. 为页面创建ViewModel, 实现ContainerHost接口
kotlin 复制代码
class MyViewModel : ViewModel(), ContainerHost<MyState, MyEffect> {
    override val container = container<MyState, MyEffect>(MyState(likeCount = 232))

    fun like() = intent {
        if (state.isLike) {
            postSideEffect(MyEffect.Toast("已点赞,不可重复点赞")) // 发送toast事件
            return@intent
        }
        postSideEffect(MyEffect.Loading(show = true, text = "请稍候...")) // 发送loading
        delay(500) // 模拟网络请求
        reduce {
            // 在此处生成新的state对象, 以便UI观察这个新state而改变
            state.copy(isLike = true, likeCount = state.likeCount + 1)
        }
        postSideEffect(MyEffect.Loading(show = false)) // 关闭loading
        postSideEffect(MyEffect.Toast("点赞成功"))
    }
}
  1. 实现页面逻辑, 此处为Activity
kotlin 复制代码
// 监听state变化和sideEffect事件
viewModel.observe(this, state = ::render, sideEffect = ::handleEffect)

// 点击事件,此处无需过度封装为一个Intent, 直接调viewmodel函数就行
binding.tvLike.setOnClickListener {
    viewModel.like()
}

// 渲染UI
fun render(state: MyState) {
    ...
    binding.textView.text = state.likeCount.toString() // 更新点赞数
}

// 处理副作用
fun handleEffect(effect: MyEffect) {
    when (effect) {
        is MyEffect.Toast -> {
            Toast.makeText(this, effect.text, Toast.LENGTH_SHORT).show()
        }
    }
}

总结

  • 可以看到, 框架已经帮我们封装好了Kotlin协程和Flow的实现,我们只需要在viewModel中使用intent{}即可, 并且侵入性较小,只需要viewModel实现一个接口就行
  • 对于副作用,例如Toast,使用postSideEffect()发出新的Effect对象
  • 对于页面刷新,例如变更点赞数,使用reduce{},将state.copy()出一个新的对象并发出
  • 本实例程序源码: Github
相关推荐
二流小码农1 小时前
鸿蒙开发:router组件升级,彻底告别手动配置
android·ios·harmonyos
Digitally1 小时前
如何在安卓设备上使用 4 种简单方法将应用移动到 SD 卡
android
wy_hhxx3 小时前
《Agent设计模式 图解可复用智能体架构》上篇内容整理
设计模式·架构·ai agent
booboosui3 小时前
录一遍就会:8 种步骤、6 类失败,卡住时只修那一步
android
阿杰m3 小时前
Android源码第十五章:Camera2 与 CameraService——一帧图像怎样回到应用
android
用户7615593836383 小时前
如何绕过 Rust 孤儿规则
架构
HelloWorld0013 小时前
面对不可逆外部支付回调:基于 TCC 与最大努力通知保证分布式资产终态一致性
架构
你三大爷4 小时前
Seata全局锁泄漏:从上游PR-backport到生产零事故发布实战
架构
Dawson Zhu5 小时前
【分布式训练⑧】通信优化:NCCL、Ring AllReduce与计算通信重叠
人工智能·语言模型·架构·aigc·agi
一条Go6 小时前
Webhook 签名:钉钉、企业微信、飞书的四种算法差异
后端·架构·github