歷史記錄
回看歷史版本、定位內容變更,並將選定版本還原至目前的共用文件。
歷史記錄把已協同確認的修改組織成可瀏覽的版本。每條已確認的修改都帶有作者、時間和操作,開發者和使用者可以據此開啟當時的內容、檢視差異,並在有權限時恢復某個版本。歷史記錄不隨編輯會話結束而消失,重新整理頁面後仍然可以檢視。
歷史記錄的原理
Mutation 是一條可以重放的內容變更,例如修改單元格或插入段落。Changeset 是一次協同提交,包含一組按順序排列的 Mutation。
1. 記錄變更
使用者或 Agent 的每次編輯都會產生 Mutation。Univer 把這些 Mutation 打包成一個 Changeset 提交,由協同服務確認並儲存。
提交確認後會獲得一個 Revision(修訂號),用來標識這次提交在文件歷史中的位置。History 為已確認的 Changeset 建立索引,按時間和操作分組,並建置版本時間線。
2. 重建歷史內容
Snapshot(快照) 是某個 revision 對應的完整內容狀態。選中某個歷史版本後,系統從基準 Snapshot 開始,載入該 Snapshot 之後直至目標 revision 的 Changeset,按順序重放其中的 Mutation,得到一份只讀的歷史檢視。
例如:revision 10 的 Snapshot + revision 11~15 的 Changeset = revision 15 的內容。
3. 還原為目前版本
選中恢復此版本後,執行流程如下:
選定目標版本 → 提交還原 Mutation → 協同確認 → 更新目前文件,產生新 revision
恢復操作本身會成為一條新的歷史記錄。此前的版本仍然保留。
查看版本與變更
- 在編輯器中開啟歷史記錄,選擇一個版本。
- 展開版本分組,檢視其中各個 revision。選中某個 revision,即可在只讀檢視器中檢視當時的內容和變化。
- 需要回退時,選擇恢復此版本。恢復操作透過協同更新共享文件,其他參與者會收到這次改動。
一個版本分組可能合併一段時間內的多次編輯,展開後才能看到各個 revision。一條歷史記錄不一定對應一次按鍵,也不一定對應一次生成的 Snapshot。
變更顏色
| 標記 | 含義 |
|---|---|
| 🟦 藍色:修改 | 已有內容發生變化。 |
| 🟩 綠色:新增 | 這一版中加入的內容。 |
| 🟥 紅色:刪除 | 這一版中移除的內容。 |
顏色表示變更型別。替換文字時可能同時產生新增和刪除。高亮範圍由各產品的檢視器決定。
五個產品的歷史視圖
下面的範例都來自同一個 Northstar 專案。範例內容為英文,時間線處於展開狀態,便於將文件與每次變更背後的操作對照檢視。
Sheets
Launch Budget 展示了預算和預測值的調整,以及行的新增與刪除。藉助工作表和操作時間線,可以定位每次改動影響的區域。
Docs
Product Launch Brief 涵蓋釋出日期、段落格式,以及為交付客戶新增的內容。被刪除的文字保留紅色刪除線,因此每個版本都保留了上下文。
Slides
在 Launch Review 中,可以追溯目標指標和頁面物件的變化。選中一條歷史記錄,更新、新增和移除的物件會直接標記在幻燈片上。
Relational Table
Launch Tracker 展示了任務、負責人和狀態的變化。記錄和欄位的變更結合表格上下文呈現,有助於說明業務資料何時發生變化、如何變化。
Canvases
Release Workspace 展示了規劃卡片和物件屬性。新增、刪除和修改的物件在畫布上原位保留標記,使一次規劃調整更容易理解。
Coming soon: PDF 歷史記錄尚未提供。
在應用程式中接入
歷史記錄由兩部分組成:Server SDK 的 History 擴充套件,以及 Web SDK 中各產品的歷史外掛。
- 伺服器端需要在核心協同之上接入 History Service、Endpoint 和持久化的 Database Adapter。該服務訂閱 Unit 建立和已確認的 Changeset,建立歷史索引,並對外提供版本和 Changeset 查詢。
- 在瀏覽器端,需要註冊通用歷史能力和對應產品的 History / History UI 外掛,然後連線歷史介面。檢視器載入選定的 revision 並展示其變更。自定義內容需要註冊對應的檢視器外掛。
- 身分和授權由應用提供,伺服器端檢查歷史讀取和恢復權限。歷史版本可能包含當前文件已經刪除的資料。
參見協同擴充套件模組,按 History 範例組裝服務,再透過上面的產品指南接入介面。
歷史索引是可重建的派生資料。已確認的 Changeset 仍是內容的權威來源。 持久化和保留策略由應用控制,歷史面板不能替代備份。
與其他能力的關係
| 能力 | 解決什麼問題 |
|---|---|
| 撤銷 / 重做 | 不需要歷史服務即可撤回或重做一次編輯操作。 |
| 歷史記錄 | 跨會話追溯已確認的版本,檢視變更並恢復共享內容。 |
| 內容比較 | 比較兩份內容,供介面或 Agent 使用。只讀比較不會恢復內容。 |
| Worktree | 隔離草稿中的修改,審閱後再合併到共享內容。 |
Agent 透過 Facade API 所做的修改,經協同確認後會進入同一條歷史鏈路。應用可以將歷史記錄與內容比較結合,用於自動審閱和檢查。
你覺得這篇文檔如何?