Web SDK

应用架构

了解 Web SDK、Server SDK 与 AI SDK 的职责,以及如何组合它们构建应用。

Univer Office SDK 包含三个 SDK:Web SDK 提供嵌入式编辑器和无头内容处理能力,Server SDK 提供协同与文件导入导出能力,AI SDK 提供 Agent 工作流能力。

Univer 是一套用于构建人类与 AI Agent 共同操作 Office 内容的开发工具集。一个 Univer 应用可以同时提供面向人类的 Web、面向 AI Agent 的 CLI,以及二者共享的 Server,也可以只采用 其中一部分。

SDK 组成

100%
组件运行环境主要 SDKSDK 提供应用负责
Web浏览器Web SDK交互式 Office 内容展示与编辑UI、产品交互与浏览器集成
CLINode.jsAI SDK面向 AI Agent 的内容检查与修改入口AI Agent workflow、工具调用与任务边界
ServerNode.jsServer SDK(Collaboration、Exchange)自托管协同、Office 文件导入导出业务 API、身份、权限、文件存储与部署

文档按 Web SDKServer SDKAI SDK 组织,分别介绍编辑器、协同与导入导出服务、AI Agent 内容操作。

AI SDK 会复用 Web SDK 的 headless 内容能力。这里的三个组件表示主要开发入口和运行位置, 并非三套互不依赖的技术栈,也不是开箱即用的完整产品。

导入导出如何接入

Office 文件与 Univer 文档数据之间的转换由 Server SDK 中的 @univerjs-pro/exchange-node 提供。 应用自行集成转换模块,并提供上传、转换和下载接口;Web SDK 负责浏览器中的导入导出交互, CLI 则可以在 Node.js 中调用转换模块。各产品的浏览器配置仍在对应的 Web SDK 文档中介绍。

  • 不使用协同编辑: 将文件转换为文档快照,在浏览器中打开和编辑;导出时将最新快照交给转换模块生成文件。此流程需要服务端转换能力,但不需要协同服务。
  • 使用协同编辑: 将导入结果保存为协同文档,Web 与 AI SDK 通过文档 ID 操作同一份内容;导出前先同步当前修改,再读取最新文档数据进行转换。

仅做文件转换时,可以在本地 Node.js 进程或远程服务中使用 Exchange,无需同时接入 AI SDK 或协同编辑。 具体接入步骤见导入导出集成,转换模块的用法见Office 文件导入导出

部署形态

形态WebCLIServer适用范围
本机应用本机浏览器或桌面壳本机进程本机进程单机 Office 与本地 AI Agent
SaaS 应用浏览器用户机器或云端 AI Agent远程服务多用户与集中运维
Web + Server浏览器本机或远程暂不提供 AI Agent 入口
Web-only浏览器或桌面壳本地、单用户、非协同编辑

组件可以部署在同一台机器,也可以跨客户端与云端部署。部署位置不会改变组件职责;存在 Server 时, Web 与 CLI 都通过它访问共享内容和产品能力。

选择入口

目标从这里开始
在 Web 中嵌入 Office 编辑器Web SDK 文档
为编辑器接入 Office 文件导入导出导入导出集成
在 Node.js 中转换 Office 文件Office 文件导入导出
增加自托管多人协同Collaboration SDK 概览
让 AI Agent 读取和修改 Office 内容AI SDK 概览
了解 CLI 的 headless RuntimeRuntime 复用与 Daemon
隔离 AI Agent 修改并由人类审阅Worktree

如果还不确定选择哪条路径,请先阅读开始使用

你觉得这篇文档如何?

© 2026 DreamNum Co., Ltd.