Office SDK 总览
了解 Office SDK 的三个组成部分:Web SDK、Server SDK 和 AI SDK,以及它们如何共同构建 Office 应用。
Univer Office SDK 包含 Web SDK、Server SDK 和 AI SDK,支持电子表格、文档、演示文稿、关系型表格、画布和 PDF。
Web SDK 提供统一的内容引擎,既可以运行浏览器编辑器,也可以通过 Headless 在服务端处理内容。Server SDK 与 AI SDK 都依赖这一 Headless 能力,分别提供协同、文件处理等服务端能力,以及 Agent 的内容操作与验证能力。
浏览全部功能
进入功能总览,按产品和分类查看完整功能、支持状态、开源标记与接入范围;也可以查看图表、文件转换、协同、Worktree、嵌入等跨产品能力。
快速开始:从一个需求模板和三个可运行实例开始,再了解应用接入、构建与部署。
SDK 架构与分工
Web SDK:统一内容引擎
面向需要在产品中展示、编辑或处理 Office 内容的开发者。使用 Facade API 操作文档、数据和界面,既支持浏览器中的编辑器,也支持 Node.js 无头运行。
Web SDK 采用插件化架构,产品能力、编辑器界面,以及查找替换等具体功能,都可以通过插件组合。你可以从预设(Preset)快速开始,也可以根据实际需要选择产品与功能插件,按插件依赖关系组装自己的 Office 应用。
你还可以开发自定义插件来扩展业务功能,无需修改 Univer 核心代码。同一内容引擎通过不同的插件组合适配运行环境:浏览器中加载编辑器 UI,Headless 场景则不加载浏览器 UI 插件。详见 Univer 架构:插件化设计。
统一的 Canvas 渲染。 Office 内容统一采用基于 Canvas 的渲染体系,让不同内容类型复用排版与绘制能力,并支持内容嵌套。例如,电子表格单元格中的文本与文档复用排版和渲染能力,保持一致的内容呈现。详见渲染引擎架构设计。
前后端混合计算。 公式引擎支持前端计算与服务端 Rust 引擎配合的混合计算模式,兼顾编辑时的交互响应与大规模公式计算的处理性能。相关能力见公式功能与服务端计算。
从电子表格快速开始,或选择文档、演示文稿、关系型表格、画布和 PDF。
Server SDK:连接协作与文件
面向需要多人协同、文件转换和服务端扩展的开发者。基于 Web SDK 的 Headless 内容能力,将所需模块集成到自己的后端,沿用业务身份、权限与存储。
实时协同。 基于 OT(操作转换)处理行列变更、内容修改等并发操作,让编辑先在本地生效,再使多端副本最终一致,并尽可能保留用户意图;可进一步组合历史记录、评论与 Worktree。详见协同编辑设计与协同接入。
文件格式转换。 在 Office 文件与 Univer 文档数据之间转换,打通导入、编辑、导出流程,也可不启用协同服务。转换 API 见Office 文件导入导出,上传、任务与下载接口见文件交换集成。
部署与扩展。 将模块组装进自己的 Node.js 应用,从单机部署开始,按负载拆分文件转换服务,再扩展到多协同节点。详见应用架构与部署指引。
AI SDK:为 Agent 提供操作入口
面向为现有 Agent、自动化流程和业务 CLI 接入 Office 能力的开发者。基于 Web SDK 的 Headless 运行时与 Facade API,提供内容操作、计算与检查能力。
接入已有 Agent 体系。 通过 TypeScript API 或组装后的业务 CLI 提供 Office 工具。模型选择、任务编排与 Skills 由接入方组织,Agent 获取执行结果与检查反馈后,继续自己的工作流。
创建可继续编辑的内容。 Agent 读取文档结构、定位区域或段落,再通过 Facade API 创建和修改表格、文档、幻灯片等内容,并执行公式计算。成果保留内容结构与编辑能力,用户可以继续完善。见内容操作。
检查结果,再继续修正。 回读数值与公式结果,通过截图核对实际页面;幻灯片还可使用布局检查定位文字出界、溢出与重叠问题。Agent 根据反馈修正,再次验证,形成“读取 → 编辑与计算 → 检查 → 修正”的循环。见视觉检查。
连接 Server SDK 后,可通过 Worktree隔离 Agent 的中间修改,再交由人类在 Web 中审阅和合并。进入 AI SDK 总览。
应用中的协作流程
- 嵌入式编辑器:使用 Web SDK,在应用中展示和编辑内容。
- 多人协同应用:组合 Web SDK 与 Server SDK,让用户共同编辑共享文档。
- 人类与 Agent 协作:通过 AI SDK 让 Agent 编辑和验证草稿,Server SDK 管理版本与合并,Web 应用承载人的查看、比较和审阅交互。完整的审阅流程由三者共同完成。
共同基础与依赖关系
Web SDK 可以独立用于编辑器或 Headless 内容处理。Server SDK 与 AI SDK 均依赖 Web SDK 的 Headless 能力;无需浏览器界面,也需要内容运行时。按需启用的是具体服务和模块,应用通常组合三个 SDK 完成人类与 Agent 的协作流程。
按你的需求开始
| 我想要 | 建议从这里开始 |
|---|---|
| 在应用里嵌入电子表格编辑器 | Web SDK · 快速开始 |
| 选择其他 Office 编辑器 | 文档、演示文稿、关系型表格、画布、PDF |
| 让多个用户共同编辑一份文档 | Server SDK · 协同快速开始 |
| 导入或导出 Office 文件 | Server SDK · 文件转换 |
| 让 Agent 或 CLI 操作文档 | AI SDK · 总览与接入路径 |
| 审阅 Agent 对共享文档的修改 | AI SDK · Worktree |
下一步
从 Web SDK 的内容运行时开始,结合 Server SDK 与 AI SDK 跑通应用的第一个完整流程,再逐步增加所需模块。保持相关 Univer 包版本匹配,并根据所选模块准备运行环境、身份权限和许可证。
你觉得这篇文档如何?