Orbit 多平台

Logo

联系我们

什么是 Orbit

Orbit 是一个类似 Redux/MVI 的库 - 但没有累赘。它如此简单，我们将其视为 MVVM+。

简单、类型安全、协程风格、可扩展的 API
多平台，支持 Android 和 iOS（iOS 支持处于 alpha 阶段，正在积极开发中）
完全支持 Kotlin 协程（毕竟它是建立在协程之上的）
生命周期安全的无限流收集
ViewModel 支持，以及 SavedState
可选的、简单的单元测试库
内置 Espresso idling resource 支持
通过协程包装器兼容 RxJava、LiveData 等
以及更多...

文档

文章和演讲

开始使用

implementation("org.orbit-mvi:orbit-core:<最新版本>")
// 或者，如果在 Android 上：
implementation("org.orbit-mvi:orbit-viewmodel:<最新版本>")
// 如果使用 Jetpack Compose，请包含
implementation("org.orbit-mvi:orbit-compose:<最新版本>")

// 测试
testImplementation("org.orbit-mvi:orbit-test:<最新版本>")

定义契约

data class CalculatorState(
    val total: Int = 0
)

sealed class CalculatorSideEffect {
    data class Toast(val text: String) : CalculatorSideEffect()
}

创建 ViewModel

实现 ContainerHost 接口
重写 container 字段，并使用 ViewModel.container 工厂函数在您的 ContainerHost 中构建 Orbit Container

class CalculatorViewModel: ContainerHost<CalculatorState, CalculatorSideEffect>, ViewModel() {

    // 包含 `orbit-viewmodel` 以使用工厂函数
    override val container = container<CalculatorState, CalculatorSideEffect>(CalculatorState())

    fun add(number: Int) = intent {
        postSideEffect(CalculatorSideEffect.Toast("将 $number 加到 ${state.total}！"))

        reduce {
            state.copy(total = state.total + number)
        }
    }
}

我们使用了 Android ViewModel 作为最常见的示例，但这并不是必需的。

在您的 Activity 或 Fragment 中连接到 ViewModel

class CalculatorActivity: AppCompatActivity() {

    // 使用 Koin 注入的示例，您的依赖注入系统可能不同
    private val viewModel by viewModel<CalculatorViewModel>()

    override fun onCreate(savedState: Bundle?) {
        ...

        addButton.setOnClickListener { viewModel.add(1234) }

        viewModel.observe(state = ::render, sideEffect = ::handleSideEffect)
    }

    private fun render(state: CalculatorState) {
        ...
    }

    private fun handleSideEffect(sideEffect: CalculatorSideEffect) {
        when (sideEffect) {
            is CalculatorSideEffect.Toast -> toast(sideEffect.text)
        }
    }
}

使用 Jetpack Compose 连接 ViewModel 如下：

@Composable
fun CalculatorScreen(viewModel: CalculatorViewModel) {

    val state = viewModel.collectAsState().value

    viewModel.collectSideEffect { handleSideEffect(it) }

    // 使用 'state' 中的数据渲染 UI
    ...
}

private fun handleSideEffect(sideEffect: CalculatorSideEffect) {
    when (sideEffect) {
        is CalculatorSideEffect.Toast -> toast(sideEffect.text)
    }
}