即時協同
以 OT 協調並行編輯,結合 HTTP、WebSocket、持久化與應用部署。
即時協同使多個使用者和接入協同的 Agent 可以操作同一份文件。編輯先在本地生效,伺服器端隨後確定這些編輯的順序,再將其分發給其他參與者。使用者因此能立即獲得反饋,所有參與者最終看到的內容保持一致。
並行編輯與衝突
Univer 使用 OT(操作轉換)協調並行編輯。客戶端將編輯操作組織為 changeset,伺服器端在提交前按已確認的 revision 轉換 changeset。各客戶端在收到彼此的修改後收斂到同一份內容。
例如,Alice 正在編輯 C2,Bob 同時在 B 列之前插入一列,轉換後的編輯位置會隨單元格移動到 D2。撤銷和重做同樣會考慮遠端操作。OT 力求保留使用者意圖,但無法自動解決所有業務衝突。
如果某個操作既無法轉換也無法執行,客戶端會進入衝突狀態,並停止該文件的編輯。CollaborationConflict 會給出原因以及尚未得到確認的本地修改。應用可以據此恢復,或先儲存使用者的工作,但在重新載入之前必須保留本地資料。詳見衝突恢復,原理見 OT 演算法與協同編輯設計。
通道與斷線復原
| 通道 | 職責 |
|---|---|
| HTTP | 載入快照和 changeset、取得 Session Ticket、提交 changeset。 |
| WebSocket | 維持協同 Session 和文件 Room,接收 ACK、遠端修改及線上狀態通知。 |
客戶端用一次性 Session Ticket 換取一條 WebSocket 連線,然後加入對應文件的 Room。Presence 透過這條連線同步線上成員、游標和選區。伺服器端每確認一個 revision,客戶端的狀態就向前推進。連線正常或 HTTP 請求成功,並不代表修改已經儲存。 儲存狀態應結合 ACK、協同狀態和待確認的修改來判斷。
斷線期間,客戶端可以快取尚未確認的修改。重新連線後,它按 revision 取回缺失的修改,並重發待確認的提交。伺服器端會對提交去重,重試不會被執行兩次。見同步狀態與重發和 Presence。
持久化與版本快照
協同服務儲存已確認的 changeset 和 revision,並按自身策略生成版本快照。載入文件時,先從快照恢復內容,再應用之後的修改。並非每次編輯都需要重新生成快照。
快照生成期間的計算,見無頭與伺服器端計算。歷史面板、評論和 Agent 草稿審閱屬於獨立的協同擴充套件模組,可按需接入。
部署架構
- 單節點:在 Node.js 應用中組裝 Transport、Endpoint、Service 和 Database Adapter。Memory 可用於臨時驗證,SQLite 適合本地和小規模部署,其他資料庫透過應用提供的 Adapter 接入。
- 擴容設計:僅共享持久化並不足夠。跨節點的文件廣播、Presence、Session Ticket 驗證和儲存一致性都需要一併處理,僅增加服務程序無法解決。具體方案以所整合版本的部署設計為準。
- 拆分重任務:檔案轉換這類 CPU 密集型任務可單獨部署,以減少對協同響應的影響。
完整組裝見模組分工,部署步驟見部署指引,也可參考多節點範例。
效能與容量
當前版本的效能基準測試與容量資料待補充。 實際容量和協同延遲取決於文件大小、編輯頻率、單文件的協作者數量以及部署環境。
評估系統時,應關注提交確認耗時、遠端修改顯示耗時、每秒 changeset 數、廣播量以及活躍文件佔用的記憶體。
接入與範圍
先閱讀協同總覽瞭解各模組之間的關係,再按快速開始執行雙瀏覽器範例,驗證編輯、確認和廣播。身分與授權透過應用的 Middleware 接入。如需長期儲存資料,應選擇持久化的 Database Adapter,並驗證服務重啟後內容仍然保留。
適用邊界
核心服務支援 Sheet、Doc、Slide、Canvases 和 Relational Table,PDF 不在這五個產品的核心協同範圍內。身分、授權、檔案管理和儲存策略由應用提供;歷史記錄、評論和 Worktree 屬於獨立擴充套件。
你覺得這篇文檔如何?