📚 ZerOS 文档中心

欢迎来到 ZerOS 文档中心

一个完整的虚拟操作系统开发文档集合

Documentation API Guide


📑 目录

快速导航

使用指南

重要提示

其他信息


🚀 快速导航

📖 入门文档

| 文档 | 描述 | 推荐度 | |------|------|--------| | 项目 README | 项目概览、快速开始、系统架构 | ⭐⭐⭐⭐⭐ | | 开发者指南 | 完整的程序开发指南,从入门到精通 | ⭐⭐⭐⭐⭐ | | 内核开发指南 | 内核模块开发指南,从入门到精通 | ⭐⭐⭐⭐⭐ | | 内核文档 | 深入理解 ZerOS 内核架构和设计原理 | ⭐⭐⭐⭐ | | 系统流程文档 | 系统启动、程序启动/结束、内核交互、权限控制等核心流程详解 | ⭐⭐⭐⭐⭐ |

🔌 扩展与插件

| 文档 | 描述 | |------|------| | 扩展与插件索引 (PLUGINS) | 语言包等扩展的编写与使用说明 | | 语言包格式 | D/plugins 语言包存放位置与 JSON 格式 | | 服务文档 (SERVER) | D/server 服务模块编写与各内置服务说明 | | Office 规范 (OFFICE) | ZerOS 自研 Office 体系规范(格式/编辑/导出/动态库) |

🔧 API 参考文档

所有内核 API 的详细文档位于 docs/API/ 目录,按功能分类如下:

⚡ 核心系统 API(必读)

| API | 描述 | 状态 | |-----|------|------| | ProcessManager | 进程生命周期管理 | ✅ | | EventManager | 统一的事件处理系统 | ⚠️ 必读 | | GUIManager | GUI 窗口管理 | ⚠️ 必读 | | PermissionManager | 权限管理、审计、统计 | ⚠️ 必读 | | KernelLogger | 统一的日志记录 | ⚠️ 必读 | | ExceptionHandler | 异常处理管理器(结构化异常处理 SEH) | ✅ |

💾 存储与内存 API

| API | 描述 | 状态 | |-----|------|------| | LStorage | 系统注册表和程序数据存储 | ✅ | | KernelMemory | 内核数据持久化 | ✅ | | MemoryManager | 进程内存分配和监控 | ✅ | | CacheDrive | 统一缓存管理、生命周期管控 | ✅ |

🗂️ 文件系统 API

| API | 描述 | 状态 | |-----|------|------| | FileFramework | 文件操作基础 API | ✅ | | FSDirve | 后端服务文件操作(支持 PHP 和 SpringBoot) | ✅ | | SystemInformation | 系统信息和后端服务管理 | ✅ | | Disk | 虚拟磁盘管理 | ✅ | | NodeTree | 内存文件系统结构 | ✅ | | DISKMANAGER | 磁盘分区管理服务(创建、检查、删除、合并等) | ✅ |

🎨 用户界面 API

| API | 描述 | 状态 | |-----|------|------| | DesktopManager | 桌面图标、组件、背景管理 | ✅ | | TaskbarManager | 任务栏管理、程序固定、多任务切换、自定义图标 | ✅ | | ContextMenuManager | 右键菜单管理 | ✅ | | TerminalAPI | 终端 API(CLI 程序使用) | ✅ | | NotificationManager | 系统通知管理 | ✅ | | ThemeManager | 主题和风格系统 | ✅ | | LockScreen | 锁屏界面(Windows 11 风格登录界面) | ✅ |

🔐 安全与加密 API

| API | 描述 | 状态 | |-----|------|------| | PermissionManager | 权限管理、审计、统计 | ⚠️ 必读 | | CryptDrive | RSA 加密、MD5 哈希、随机数 | ✅ |

🌐 网络与通信 API

| API | 描述 | 状态 | |-----|------|------| | NetworkManager | HTTP 请求、WebSocket | ✅ | | NetworkPort | TCP 端口监听和管理 | ✅ |

🛠️ 工具与辅助 API

| API | 描述 | 状态 | |-----|------|------| | ApplicationAssetManager | 应用资源管理 | ✅ | | AnimateManager | 窗口和 UI 动画 | ✅ | | Pool | 程序间数据共享 | ✅ | | DependencyConfig | 模块依赖管理 | ✅ | | Starter | 系统启动和初始化 | ✅ | | UserControl | 用户控制系统(多用户管理、权限控制) | ✅ | | ZOMInstall | ZOM 程序包格式、zompkg 打包、zominstall 安装 | ✅ |

🚀 高级驱动 API

| API | 描述 | 状态 | |-----|------|------| | CompressionDrive | ZIP/RAR 压缩解压缩(支持 PHP 和 SpringBoot 后端) | ✅ | | SystemInformation | 系统信息和后端服务管理 | ✅ | | DragDrive | 文件拖拽处理 | ✅ | | GeographyDrive | 地理位置相关功能 | ✅ | | SpeechDrive | 语音识别驱动(基于 Web Speech API) | ✅ | | MultithreadingDrive | 并发处理 | ✅ | | ScheduleTaskManager | 计划任务管理器 | ✅ | | BrowserProxy | 浏览器网页代理服务(绕过 iframe 限制) | ✅ |

🔌 系统扩展 API

| API | 描述 | 状态 | |-----|------|------| | LanguagesExpansion | 语言包管理器(加载/设置语言、按常量名获取文本) | ✅ | | ServerExpansion | 服务扩展(D/server 服务模块管理、start/stop 生命周期) | ✅ |


🎯 使用指南

📚 新手入门路径

  1. 第一步:阅读 项目 README,了解 ZerOS 的基本概念和快速开始
  2. 第二步:阅读 开发者指南 的"快速开始"部分,创建你的第一个程序
  3. 第三步:参考 开发者指南 的"重要注意事项",了解开发规范
  4. 第四步:根据你的需求,查阅相应的 API 文档

💻 开发程序时

| 开发场景 | 推荐阅读 | |---------|---------| | GUI 程序开发 | GUIManager + EventManager | | 文件操作 | FileFramework + FSDirve + SystemInformation | | 程序打包与安装 | ZOMInstall(zompkg 打包、zominstall 安装;本地开发可用 dev/toolkit/zompkg.ps1) | | 数据存储 | LStorage + CacheDrive | | 权限管理 | PermissionManager | | 扩展/插件 | 扩展与插件索引(语言包、服务模块编写) |

❓ 遇到问题时

  1. 查看 开发者指南 的"常见问题"部分
  2. 查阅相关 API 文档的"注意事项"和"示例代码"
  3. 使用浏览器开发者工具(F12)查看控制台日志
  4. 检查程序是否正确实现了必需的方法(__init____exit____info__

⚠️ 重要提示

🔒 开发规范(必须遵守)

| 规范 | 说明 | 详细文档 | |------|------|---------| | 事件处理 | 必须使用 EventManager,不要直接使用 addEventListener | EventManager | | 日志记录 | 必须使用 KernelLogger,不要直接使用 console.log | KernelLogger | | 窗口管理 | 必须使用 GUIManager 创建和管理窗口 | GUIManager | | 权限声明 | 必须在 __info__ 方法中声明所需权限 | PermissionManager | | 资源清理 | 必须在 __exit__ 方法中清理所有资源 | 开发者指南 |

❌ 常见错误

  • ❌ 直接使用 addEventListener(应使用 EventManager
  • ❌ 直接使用 console.log(应使用 KernelLogger
  • ❌ 忘记在 __exit__ 中清理事件监听器
  • ❌ 忘记在 __info__ 中声明权限
  • ❌ 使用 alertconfirmprompt(应使用 GUIManager.showAlert 等)

📝 文档更新

文档会随着系统更新而持续改进。如果你发现文档有误或需要补充,欢迎提交 Issue 或 Pull Request(更推荐发送邮件)。

一致性原则

  • 以实现为准:API 名称、参数、返回、权限要求、路径规则需与当前代码一致
  • 变更同步:代码或目录结构变更后,同步更新 docs/API 索引与相关交叉引用
  • 过时处理:实现已移除的能力需删除或标注 Deprecated,并提供替代方案

🔗 相关链接


祝你开发愉快! 🎉

Made with ❤️ by ZerOS Team

最后更新于: 2026-02-25 提出修改建议