# Yjs CRDT 模式 ## 核心概念 ### 共享类型 Yjs提供了六种共享类型。您主要会使用三个： * `Y.Map` \- 键值对（如 JavaScript Map） * `Y.Array` \- 有序列表（如 JavaScript 数组） * `Y.Text` \- 带格式的富文本其他三个（“Y.XmlElement”、“Y.XmlFragment”、“Y.XmlText”）用于富文本编辑器集成。 ### 客户端 ID 每个 Y.Doc 在创建时都会获得一个随机的“clientID”。此 ID 用于解决冲突 - 当两个客户端同时写入同一个密钥时，**较高的 clientID 获胜**，而不是较晚的时间戳。 const doc = new Y.Doc(); console.log(doc.clientID); // 随机数，如 1090160253 来自 dmonad（Yjs 创建者）： > “‘获胜者’由文档的‘ydoc.clientID’（生成的数字）决定。较高的 clientID 获胜。” > > — [GitHub 问题 #520]() 源代码中的实际比较（[updates.js#L357]()）：返回 dec2.curr.id.client - dec1.curr.id.client; // clientID 越高越好这是确定性的（所有客户端收敛到相同的状态），但不直观（以后的编辑可能会丢失）。 ### 共享类型无法移动一旦将共享类型添加到文档中，**它就永远无法移动**。 “移动”数组中的一项实际上是删除+插入。 Yjs 不知道这些操作是相关的。 ## 关键模式 ### 1\.单写入器键（计数器、投票、存在） **问题**：多个写入者更新相同的密钥会导致写入丢失。 // 不好：两个客户端都读 5，都写 6，一键丢失函数增量（ymap）{ const count = ymap.get('count') || 0; ymap.set('计数', 计数 + 1); } **解决方案**：按clientID分区。每个作家都拥有自己的密钥。 // 好：每个客户端写入自己的密钥函数增量（ymap）{ const key = ymap.doc.clientID; const count = ymap.get(key) || 0; ymap.set(key, count + 1); } 函数 getCount(ymap) { 令总和 = 0； for (ymap.values() 的常量值) { 总和+=值； } 返回总和； } ### 2\.分数索引（重新排序） **问题**：使用删除+插入进行拖放重新排序会导致重复和丢失更新。 // 不好：“移动”=删除+插入=损坏函数移动（yarray，从，到）{ const [item] = yarray.delete(from, 1); yarray.insert(to, [项目]); } **解决方案**：添加一个“index”属性。按索引排序。重新排序=更新属性。 // 好：通过更改索引属性重新排序函数移动（yarray，从，到）{ const Sorted = [...yarray].sort((a, b) => a.get('index') - b.get('index')); const item = 排序[来自]； const 较早 = 从 > 到； const before = 排序[更早？到 - 1 : 到]; const after = 排序[之前？到 : 到 + 1]; const start = before?.get('index') ?? 0; const end = 之后？.get('index') ?? 1; // 添加随机性以防止碰撞 const 索引 = (结束 - 开始) * (Math.random() + Number.MIN_VALUE) + 开始; item.set('索引', 索引); } ### 3\.用于避免冲突的嵌套结构 **问题**：在一个键下存储整个对象意味着任何属性更改都会与任何其他属性发生冲突。 // 不好：Alice 更改可为 null，Bob 更改默认值，其中一方失败 schema.set('标题', { 类型：'文本'，可空：true，默认值：“无标题”， }); **解决方案**：使用嵌套的 Y.Maps，这样每个属性都是一个单独的键。 // 好：每个属性都是独立的 const titleSchema = schema.get('标题'); // Y 地图 titleSchema.set('类型', '文本'); titleSchema.set('可空', true); titleSchema.set('默认', '无标题'); // Alice 和 Bob 编辑不同的密钥 = 没有冲突 ## 存储优化 ### 键值数据的 Y.Map 与 Y.Array `Y.Map` 墓碑永远保留着钥匙。每个 ymap.set(key, value) 都会创建一个新的内部项目并删除前一个项目。对于高流失率的键值数据（经常更新的行），请考虑“yjs/y-utility”中的“YKeyValue”： // YKeyValue 将 {key, val} 对存储在 Y.Array 中 // 删除是结构性的，而不是每个键的墓碑从 'y-utility/y-keyvalue' 导入 { YKeyValue }； const kv = new YKeyValue(yarray); kv.set('myKey', { data: '值' }); **何时使用 Y.Map** ：有界键，很少更改值（设置、配置）。 **何时使用 YKeyValue** ：密钥多、更新频繁、存储敏感。 ### 基于纪元的压缩如果您的架构使用版本化快照，您将获得免费压缩： // 通过重新编码当前状态来压缩 Y.Doc const snapshot = Y.encodeStateAsUpdate(doc); const freshDoc = new Y.Doc({ guid: doc.guid }); Y.applyUpdate(freshDoc, 快照); // freshDoc 具有相同的内容，没有历史记录开销 ## 常见错误 ### 1\.假设“最后写入获胜”意味着时间戳事实并非如此。较高的 clientID 获胜，而不是较晚的时间戳。围绕此进行设计或使用“y-lwwmap”添加显式时间戳。 ### 2\.使用 Y.Array 位置进行用户控制的订单数组位置用于仅附加数据（日志、聊天）。用户可重新排序的列表需要分数索引。 ### 3\.忘记文档集成使用前必须将 Y 类型添加到文档中： // 不好：孤儿 Y.Map const 孤儿 = new Y.Map(); orphan.set('键', '值'); // 可以工作但不同步 // 好：附加到文档中 const Attach = doc.getMap('myMap'); Attached.set('键', '值'); // 同步到对等点 ### 4\.存储不可序列化的值 Y 类型存储 JSON 可序列化数据。没有函数，没有类实例，没有循环引用。 ### 5\.期待采取措施保护身份 // 这将创建一个新项目，而不是移动的项目 yarray.delete(0); yarray.push([sameItem]); // 内部不同的Y.Map实例对“已移动”项目的任何并发编辑都会丢失，因为您删除了原始项目。 ## 调试技巧 ### 检查文档状态 console.log(doc.toJSON()); // 完整文档为纯 JSON ### 检查客户端 ID // 看看谁会赢得冲突 console.log('我的ID：', doc.clientID); ### 注意墓碑膨胀如果文档意外增长，请检查： * 频繁的 Y.Map 键覆盖 * 数组上的“移动”操作 * 缺少纪元压缩 ## 参考文献 * [学习 Yjs]() \- 互动教程 * [Yjs 文档]() \- API 参考 * [Yjs INTERNALS.md]() \- Yjs 内部如何工作 * [GitHub 问题 #520]() \- 与 dmonad 的冲突解决讨论 * [yjs/y-utility]() \- YKeyValue 和助手 * [y-lwwmap]() \- 基于时间戳的 LWW * [fractional-indexing]() \- 生产库 * [YATA论文]() \- 学术基础

yj

包含技能