Server SDK
為應用程式準備文件服務、儲存與存取權限。
Univer Server SDK 提供可組合的模組。 請將所需模組整合至自己的業務後端,再部署該應用程式。身分驗證、權限、文件歸屬、檔案儲存及維運由應用程式負責。
本頁介紹後端設定、儲存與權限。協同整合將編輯器連接到共用文件;檔案交換整合則介紹上傳、轉換與下載。請依所需功能選擇指南。需要授權的功能請先完成授權設定。僅在瀏覽器編輯不需要協同服務。
逐步完成整合
- 執行 Quick Start:兩個獨立瀏覽器工作階段驗證同一文件的雙向編輯。
- 加入持久化:重啟 SQLite 範例並確認資料。
- 加入身份與權限:驗證 editor 與 viewer。
- 連接業務前端:替換示範身份、文件建立與協定網址。
- 加入擴充:基礎流程成功後,再加入歷史、評論、Worktree 或 Exchange。僅轉換檔案可直接從 Exchange 開始。
選擇所需服務
| 需求 | 後端準備 | 實作指南 |
|---|---|---|
| 共用文件編輯 | Collaboration SDK、文件儲存與權限 | 協同快速開始 |
| Office 檔案匯入匯出 | 轉換、上傳、任務查詢與下載 | 檔案轉換與 Exchange 範例 |
| 歷史記錄或共用留言 | 各自的服務、儲存與權限 | 擴充模組 |
只選擇需要的能力。單純轉換檔案不需要協同編輯。請準備 SDK 環境,並保持 Univer 套件版本相容。
連接應用程式與儲存
先執行所選服務的範例,再接入自己的後端。協同文件由應用程式建立、記錄擁有者,並將 ID 傳回瀏覽器。建立 API 請參閱模組邊界。使用者、專案與資料夾仍由應用程式管理。
協同範例使用記憶體儲存,重啟後內容會遺失。請依資料庫介接器接入資料庫,並驗證已儲存文件在重啟後仍然存在。
檔案轉換也需要管理上傳、任務與下載的儲存及清理,請參考 Exchange 範例。
接入登入與權限
依身分與授權驗證既有登入憑證,並檢查使用者是否可讀取或修改文件。請替換範例中的固定使用者與全部允許規則。
對文件讀取、協同連線、編輯提交,以及已啟用的歷史記錄、留言與下載進行保護。瀏覽器編輯器設為唯讀不能取代伺服器權限檢查。
部署並連接前端
將介面部署到應用程式網域。協同編輯的代理伺服器須同時轉送 HTTP 與 WebSocket 流量;HTTPS 頁面應使用 WSS。限制檔案上傳,並處理轉換失敗與逾時。從單機走到拆分匯入匯出和多協同節點,參考部署指引。
後端準備完成後,繼續整合對應功能:
你覺得這篇文檔如何?