DesktopEditors 项目架构拆解:9 大核心组件与 super-repository 结构完全指南

原创2026-10-28 17:55:071,817 阅读

DesktopEditors 项目架构拆解:9 大核心组件与 super-repository 结构完全指南

DesktopEditors 是一套免费开源的桌面办公套件(文字、表格、幻灯片、PDF 编辑器与图表查看器),支持 Windows / macOS / Linux 三平台离线使用。本文完整拆解它的项目架构:9 大核心组件各自负责什么、super-repository(超仓库)如何组织源码,以及三任务两平台的构建模型是如何运转的,帮你快速看懂这个仓库。

一、项目定位:先看它是什么

在深入目录之前,先建立整体印象。DesktopEditors 基于 ONLYOFFICE DocumentServer 开发(见 ATTRIBUTION),采用 GNU AGPL v3 开源协议(LICENSE),当前版本为 9.3.6-rc.1(VERSION.txt)。

它的核心能力包括:

  • ✍️ 文档 / 表格 / 幻灯片 / PDF 的创建、编辑与导出
  • 📄 完整兼容 Office Open XML 格式(.docx、.xlsx、.pptx)
  • ☁️ 连接 Nextcloud、Moodle 等云端服务,支持实时协作
  • 🤖 内置 AI 助手、数字签名、密码保护、46 种界面语言

DesktopEditors 桌面办公套件主界面,展示文档、表格、演示与 PDF 编辑器入口

二、super-repository 结构:一个仓库,九个子模块

🔑 理解本项目架构的第一把钥匙:这是一个 super-repository(超仓库)——主仓库本身几乎不包含业务源码,真正的代码全部存放在 9 个 Git 子模块中,由根目录的 .gitmodules 统一声明。

# 子模块目录 核心职责
1 desktop-apps 桌面端前端 UI,构建所选操作系统上的程序界面,也是共享 CMake 构建定义的所在地
2 desktop-sdk 桌面 SDK,Desktop Editors 的核心组成部分
3 core Document Server 的服务端核心组件,负责 DOC/DOCX/ODT/PDF/HTML/XLS/XLSX/PPT/PPTX 等主流格式互转
4 sdkjs JavaScript SDK,为所有组件提供客户端交互 API
5 web-apps Document Server 的 Web 前端,用统一界面创建、编辑、保存文档
6 dictionaries 多语言拼写检查词典
7 document-templates 开箱即用的文档模板资源
8 core-fonts 核心字体资源,保证跨平台排版一致
9 sdkjs-forms 表单创建与 PDF 表单支持(Form Creator)

💡 新手最容易踩的坑:git clone 之后这些目录是空的。必须先执行 git submodule update --init --recursive 拉取全部子模块,否则任何构建都会失败。

三、组件协作关系:一次"打开文档"背后的分工

这 9 个组件并非孤立存在,而是分层协作:

  • 格式转换层:core(C++ 核心)负责解析与转换文档格式,并被编译为 WASM 供 Web 端运行;
  • 交互层:sdkjs + sdkjs-forms 提供客户端 API,web-apps 构建编辑器界面;
  • 桌面壳层:desktop-apps 负责各操作系统的原生界面,desktop-sdk 提供桌面端 SDK 核心;
  • 资源层:dictionaries、document-templates、core-fonts 提供词典、模板与字体等静态资产。

依赖版本则由 core/vcpkg.json(vcpkg manifest 模式)统一锁定,保证跨平台构建时第三方库版本完全一致。

四、构建体系:三任务、两平台的产出模型

所有构建相关逻辑集中在 build/ 目录,理解它的"大picture"只需记住一句话:

build-common 先编译与平台无关的编辑器 Web 载荷(JS + WASM),build-linux 和 build-windows 再各自把这份载荷"贴"到原生应用上——构建桌面端时你不需要重编编辑器。

构建任务 运行环境 产出
build-common Linux / Docker 平台无关的 JS + WASM 编辑器载荷
build-linux Linux / Docker 桌面应用 + Linux 安装包
build-windows Windows / MSVC 桌面应用 + ZIP / Inno 安装包(可选 MSI)

三个平台的入口文档:

几个值得新手注意的架构细节:

  • 构建定义 vs 构建编排是分离的:构建什么 由 desktop-apps/win-linux/CMakeLists.txt 这份跨平台共享 CMake 工程决定;怎么构建(准备工具链、拉依赖、打包)则按平台各自实现;
  • 编译器缓存方面,Linux 用 ccache、Windows 用 sccache,因此两端都统一采用 Ninja 生成器;
  • 版本号优先取 Git tag(如 v9.3.6-rc.1),本地构建则回落到 VERSION.txt。

五、配套文件速览:CI 工作流与项目资产

除 9 大组件外,仓库根目录还有几类关键文件:

  • 🤖 CI 工作流(.github/workflows/):build.yml 是主构建流水线(含 version → brand-assets → build-common → build-linux/windows/macos 的依赖链),check.yml 负责质量检查,update-submodules.yml 自动同步子模块;
  • 📋 CHANGELOG.md — 完整的版本变更日志;
  • 📄 ATTRIBUTION — 开源致谢与 ONLYOFFICE 上游说明;
  • 🏷️ VERSION.txt — 本地构建时的默认版本来源。

六、新手上手源码:三步走

1️⃣ 克隆仓库并拉取全部子模块(super-repository 的必经之路):

git clone https://gitcode.com/gh_mirrors/deskt/DesktopEditors.git
cd DesktopEditors
git submodule update --init --recursive

2️⃣ 阅读 build/README.md,理解"三任务、两平台"的构建模型;

3️⃣ 按自己的系统选择对应指南动手构建:build/linux/、build/windows/ 或 build/macos/。

结语

DesktopEditors 的架构精髓可以概括为三句话:主仓库只做聚合(super-repository + 9 个子模块),构建定义与编排分离(共享 CMake + 平台各自编排),平台无关载荷只编译一次(build-common 复用)。理解了这套结构,无论你想改编辑器界面、扩展插件,还是深入格式转换内核,都能迅速定位到正确的组件目录。

登录后查看全文
DesktopEditors