nodeject-event-sourcing 是一个基于 Node.js 的事件溯源库，它提供了一种可重放的函数调用机制，用于实现高度可靠的数据持久化。该库具有高度的可配置性和可扩展性，支持多种存储介质，并且使用简单，十分适合在前端项目中使用。本篇文章为大家介绍 nodeject-event-sourcing 的基本用法，希望能够帮助初学者更快地上手。
安装
使用 npm 安装 nodeject-event-sourcing：
npm install nodeject-event-sourcing
基本使用
nodeject-event-sourcing 的核心概念是事件和事件源。事件表示一次状态变更，事件源表示状态的来源。通过使用该库提供的事件源接口，我们可以将事件源与事件进行绑定，并在事件源的生命周期内对其进行操作，简单来说，就是将诸多状态转化为事件的形式进行存储、读取和恢复。
使用 nodeject-event-sourcing，你只需要定义一个 event store：
-- -------------------- ---- ------- ------ - --------- --------------- - ---- ---------- ------ - ----------------- - ---- ------------------------- -- --- -------- -- ----- -------- - --- ---------- -- -- ----- ----- -- ----- ---------- - ---------------------------- --------- ------------------ - ------- ---------- ---- --------------------------------------- -- -- ---- -
接着，你可以通过调用 EventStoreFactory 创建 EventStore 的实例：
const store = eventStore.create<Event>(...args) // 参数参考下文
然后你可以将 store 绑定到你的逻辑代码中，在需要的时候进行事件写入、读取和恢复：
-- -------------------- ---- -------
-- -- ----- ------
-------------
-
--------- ---------
---------- -----------------
----- - --------- --------- -
-
-
-- -- ----- ---------
----- ------ - -----------------------------------
----- ----- - ------------------ --- -- ----------------------- --------- -----------------这样，你就可以使用 nodeject-event-sourcing 对状态进行可重放的持久化了。
EventStore 的参数
EventStore 接受一个泛型参数：
interface EventStore<TState extends RootState = RootState> {
commit(event: Event): void
getCommitsForEntity(entityId: EntityId): Array<Event>
replay(lastCommitId?: number): OngoingCommit<TState>
snapshot(entityId: EntityId, state: TState): Snapshot
restoreSnapshot(snapshot: Snapshot): Commit
pipe(dest: WritableStream): void
}其中 RootState 和 EntityId 分别为：
type RootState = { [key: string]: any }
type EntityId = string | number | symbol | object | undefined | null | void | booleanEventStoreFactory.create(...) 方法接收参数：
interface EventStoreFactoryOptions {
driver?: "in-memory" | "mongodb" // 数据存储驱动，默认为 "in-memory"
url?: string // 数据库 URL，仅针对 MongoDB 存储，默认为在内存中存储
localOnly?: boolean // 是否本地存储，默认为 false，即启用远程存储
scope?: string // 作用域，仅针对 MongoDB 存储，用于在多租户模式下将多个实例存储于同一个库中
}示例代码
下面是一个简单的示例代码：
-- -------------------- ---- -------
------ - --------- --------------- - ---- ----------
------ - ----------------- - ---- -------------------------
--------- ---- -
--------- ------
--------- ------
-
-- --- -------- --
----- -------- - --- ----------
-- -- ----- ----- --
----- ---------- - ----------------------------
---------
------------------
- ------- ---------- ---- --------------------------------------- --
-
-- ---- ---- ------
----- ---- -
------- ---- ------
------- ---------- ------
------- ---------- ------
--------------- ------- --------- ------- --------- ------- -
-------- - --
-------------- - --------
-------------- - --------
-
------ --- ----- ------ -
------ --------
-
------ --- ----------- ------ -
------ --------------
-
------ --- ------------------ ------- -
-------------- - --------
-
------ --- ----------- ------ -
------ --------------
-
------ --- ------------------ ------- -
-------------- - --------
-
------ ------ --------------- ---- - ---- -
------ ----
-
------ ------ ----------------- ------- ----- ----- ---- -
------ ----------- -
---- -----------------
------ --- ------------- -------------- --------------
---- ------------------
------ --- ------------- -------------- ---------
---- ------------------
------ --- ------------- --------- --------------
--------
----- --- -------------- ----- ------
-
-
------ ------ --- -------------- ------ -
------ ----
-
------ ------ --- ------------------- ------ -
------ ---------
-
-
-- --------
----- ----- - -------------------------
-- ----
--------------
--------- ---------
---------- -----------------
----- -
--- ---------
--------- ----------
--------- ---------
--
--
-- -----
--------------
--------- ---------
---------- ------------------
----- -
--- ---------
--------- ----------
--
--
-- ----
--------------
--------- ---------
---------- ------------------
----- -
--- ---------
--------- -----------
--
--
-- ------
----- ------ - -----------------------------------
----- ---- - -------------------- ---- - ----- ------ -- ---------------------------- ------------ --------------------
-----------------输出结果：
User { _id: 'user-1', _username: 'janedoe', _password: 'p@ssw0rd' }使用建议
nodeject-event-sourcing 的使用技巧可以总结为几个关键：
- 需要清晰地定义事件和事件源的概念，将“状态变化”转化为“事件”，并以“事件源”形式将其进行存储。
- 需要在实践中注意异步和并发的处理，例如通过使用 Promise 和 await，或是使用流式数据处理等技巧。
- 需要为事件源和事件定义良好的地方性和方法性接口，以便在复杂场景中进行扩展和维护。
最后，非常推荐在使用 nodeject-event-sourcing 时与 Node.js 生态中的其他工具进行结合，例如 Express、Koa 等 HTTP 框架、TypeORM、Mongoose 这样的 ORM 工具等，可以大大提升代码的可维护性和可扩展性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055cbf81e8991b448da552