状态管理最佳实践
LobeHub 不同于传统 CRUD 的网页,存在大量的富交互能力,如何设计一个易于开发与易于维护的数据流架构非常重要。本篇文档将介绍 LobeHub 中的数据流管理最佳实践。
概念要素
| 概念名词 | 解释 |
|---|---|
| store | 状态库 (store),包含存储应用的状态、动作。允许在应用渲染中访问和修改状态。 |
| state | 状态 (state) 是指应用程序的数据,存储了应用程序的当前状态,状态的变化一定会触发应用的重新渲染,以反映新的状态。 |
| action | 动作 (action) 是一个操作函数,它描述了应用程序中发生的交互事件。动作通常是由用户交互、网络请求或定时器等触发。 action 可以是同步的,也可以是异步的。 |
| reducer | 归约器 (reducer) 是一个纯函数,它接收当前状态和动作作为参数,并返回一个新的状态。它用于根据动作类型来更新应用程序的状态。Reducer 是一个纯函数,不存在副作用,因此一定是 同步 函数。 |
| selector | 选择器 (selector) 是一个函数,用于从应用程序的状态中获取特定的数据。它接收应用程序的状态作为参数,并返回经过计算或转换后的数据。Selector 可以将状态的一部分或多个状态组合起来,以生成派生的数据。Selector 通常用于将应用程序的状态映射到组件的 props,以供组件使用。 |
| slice | 切片 (slice) 是一个概念,用于表达数据模型状态的一部分。它指定了一个状态切片(slice),以及与该切片相关的 state、action、reducer 和 selector。使用 Slice 可以将大型的 Store 拆分为更小的、可维护的子类型。 |
结构分层
在不同的复杂度下,我们可以将 Store 的结构组织可以由很大的不同:
- 较低复杂度:一般包含 2~5 个 state 、3 ~ 4 个 action。此时的结构一般直接一个
store.ts+ 一个initialState.ts即可。
- 一般复杂度 :一般复杂度存在 5 ~ 15 个 state、 5 ~ 10 个 action,可能会存在 selector 实现派生状态,也有可能存在 reducer 简化部分数据变更的复杂度。此时的结构一般为一个
store.ts+ 一个initialState.ts+ 一个selectors.ts/reducer.ts。
- 中等复杂度 : 中等复杂度存在 15 ~ 30 个 state、 10 ~ 20 个 action,大概率会存在 selector 来聚合派生状态,大概率存在 reducer 简化部分数据变更的复杂度。
此时结构,用单一的 action store 已经较难维护,往往会拆解出来多个 slice 用于管理不同的 action。 下方的代码代表了 SortableTree 组件的内部数据流:
- 高等复杂度:高等复杂度存在 30 个以上的 state、 20 个以上的 action。必然需要 slice 做模块化内聚。在每个 slice 中都各自声明了各自的 initState、 action、reducer 与 selector。
下述这个数据流的目录结构是之前一版 SessionStore,具有很高的复杂度,实现了大量的业务逻辑。但借助于 slice 的模块化和分形架构的心智,我们可以很容易地找到对应的模块,新增功能与迭代都很易于维护。
LobeHub SessionStore 目录结构最佳实践
在 LobeHub 应用中,由于会话管理是一个复杂的功能模块,因此我们采用了 slice 模式 来组织数据流。下面是 LobeHub SessionStore 的目录结构,其中每个目录和文件都有其特定的用途:
SessionStore 的实现
旧 SessionStore 保留会话选择、界面状态和兼容动作,各个 Slice 负责相关的一组行为。下面用简化示例说明如何将动作类组合进 store:
store.ts
在这个 store.ts 文件中,我们创建了一个 useSessionStore 钩子,它使用 zustand 库来创建一个全局状态管理器。我们通过共享的 flattenActions 工具函数,将 initialState 和每个 Slice 的动作合并,以创建完整的 SessionStore。旧 SessionStore 管理会话选择和界面状态。Agent 与侧边栏列表由 HomeStore 中基于 replica 的 Agent 列表负责加载和缓存。
slices/session/action.ts
下面的动作切片展示现有的 switchSession 动作:检查当前 Agent ID,然后通过带调试标签的状态写入更新 activeAgentId。
createSessionSlice 返回动作类实例,flattenActions 将它的公开方法暴露到旧 store 上,SessionAction 则由这些方法推导。列表加载和持久化由对应的列表资源负责;这个选择动作只更新界面状态。