Electron-egg 桌面应用开发框架：基于 Electron 和 Egg.js 的完整指南

指南 (使用文档) :

 * `examples/guide/intro.md` \- Electron EGG 介绍
 * `examples/guide/installation.md` \- 安装指南
 * `examples/guide/quick-start.md` \- 快速开始指南
 * `examples/guide/project-structure.md` \- 项目结构
 * `examples/guide/configuration.md` \- 配置
 * `examples/guide/build.md` \- 构建与打包

功能特性 (功能特性) :

 * `examples/features/main-process.md` \- 主进程
 * `examples/features/renderer-process.md` \- 渲染进程
 * `examples/features/ipc-communication.md` \- IPC 通信
 * `examples/features/window-management.md` \- 窗口管理
 * `examples/features/menu.md` \- 菜单
 * `examples/features/tray.md` \- 系统托盘
 * `examples/features/auto-updater.md` \- 自动更新器
 * `examples/features/plugin-system.md` \- 插件系统

3. 遵循该示例文件中的具体说明，包括语法、结构和最佳实践

重要提示 :

 * Electron EGG 基于 Electron 和 Egg.js
 * 主进程和渲染进程分离
 * 进程间的 IPC 通信
 * 每个示例文件都包含关键概念、代码示例和要点

4. 需要时参考 api/ 目录中的 API 文档：

 * `api/main-api.md` \- 主进程 API
 * `api/renderer-api.md` \- 渲染进程 API
 * `api/ipc-api.md` \- IPC API
 * `api/window-api.md` \- 窗口 API
 * `api/config-api.md` \- 配置 API

API 文件：

 * `api/main-api.md` \- Application 类、BrowserWindow、ipcMain、app 方法
 * `api/renderer-api.md` \- ipcRenderer、contextBridge、DOM API
 * `api/ipc-api.md` \- IPC 通信方法和事件
 * `api/window-api.md` \- 窗口创建和管理
 * `api/config-api.md` \- 配置选项和环境变量

5. 使用 templates/ 目录中的模板：

 * `templates/installation.md` \- 安装模板
 * `templates/project-setup.md` \- 项目设置模板
 * `templates/configuration.md` \- 配置模板

1. 理解 Electron EGG

Electron EGG 是一个基于 Electron 和 Egg.js 的桌面应用程序开发框架，提供完整的开发工具链和最佳实践。

关键概念 :

• Electron : 跨平台桌面应用程序框架
• Egg.js : Node.js 企业级应用框架
• 主进程 : 主应用程序进程
• 渲染进程 : UI 渲染进程
• IPC : 进程间通信
• 插件系统 : 可扩展的插件架构

2. 安装

使用 npm :

npm install electron-egg

使用 yarn :

yarn add electron-egg

使用 pnpm :

pnpm add electron-egg

3. 基本设置

// main.js
const { Application } = require('electron-egg')

const app = new Application({
  // 配置
})

app.start()

文档映射 (与官方文档一一对应)

• examples/ → https://www.kaka996.com/pages/987b1c/
• api/ → https://www.kaka996.com/pages/a99b72/

API 参考 (api/)

• api/main-api.md - Application 类、BrowserWindow、ipcMain、生命周期钩子
• api/renderer-api.md - ipcRenderer、contextBridge、DOM API
• api/ipc-api.md - IPC 通信方法和通道
• api/window-api.md - 窗口创建、管理、事件
• api/config-api.md - 配置选项和环境变量

最佳实践

1. 进程分离 : 保持主进程和渲染进程代码分离
2. 使用 IPC : 使用 IPC 进行进程间通信
3. 错误处理 : 妥善处理两个进程中的错误
4. 安全性 : 遵循 Electron 安全最佳实践
5. 性能 : 优化应用程序性能
6. 构建配置 : 正确配置构建和打包
7. 插件系统 : 使用插件系统实现可扩展性

资源

• 官方文档 : https://www.kaka996.com/
• 使用指南 : https://www.kaka996.com/pages/987b1c/
• API 文档 : https://www.kaka996.com/pages/a99b72/
• Gitee 仓库 : https://gitee.com/dromara/electron-egg

关键词

Electron EGG, electron-egg, Electron, Egg.js, desktop application, 桌面应用, 主进程, 渲染进程, IPC, 进程间通信, 窗口管理, 菜单, 系统托盘, 自动更新, 插件系统, main process, renderer process, inter-process communication, window management, menu, system tray, auto updater, plugin system

每周安装量

44

仓库

teachingai/full…k-skills

GitHub 星标数

226

首次出现

Jan 24, 2026

安全审计

Gen Agent Trust HubPassSocketPassSnykPass

安装于

gemini-cli37

opencode37

codex36

cursor35

github-copilot34

amp32