Skip to Content
🎉 Univer 0.8.3 版本已发布。查看详情 →
GuidesUniver Sheets引入高级功能服务端集成Univer Server 事件同步机制

事件同步机制

事件同步机制提供一种将协同引擎内部发生事件发布出去的通道,客户系统能够消费这些事件,结合自身的业务做下一步事情。

事件同步

事件同步了哪些内容?

目前协同事件同步支持:

  • 协同编辑:成功落库的 changeset

如何使用事件同步机制

开始使用事件同步机制非常简单:

  1. 开启事件同步开关
  2. 启动 Consumer 消费事件

开启事件同步开关

添加下述自定义配置以开启,可以前往生产部署了解如何应用自定义配置。

在.env.custom文件中写入

EVENT_SYNC=true # 设置true为开启

消费者代码示例

参考 https://github.com/dream-num/univer-event-sync-example-go

关键的数据结构

message EventSyncData { string eventId = 1; string eventType = 2; // type of event, now support changeset int32 createdAt = 3; oneof event { univer.ChangesetAck csAckEvent = 4; // more event types in the future. } } message ChangesetAck { univer.Changeset cs = 1; } message Changeset { string unitID = 1; // unitID of the Univer document univer.constants.UniverType type = 2; int32 baseRev = 3; int32 revision = 4; string userID = 5; repeated Mutation mutations = 6; string memberID = 7; } message Mutation { string id = 1; // ID of the mutation string data = 2; // serialized params }
Last updated on