ElectronEGG桌面应用开发框架Skill electron-egg

此技能提供 Electron EGG 框架的全面指导,用于开发跨平台桌面应用程序。它基于 Electron 和 Egg.js,涵盖项目结构、主/渲染器进程、IPC 通信、窗口管理等功能,帮助开发者快速构建和部署桌面应用。关键词:Electron EGG, Electron, Egg.js, 桌面应用, IPC, 进程通信, 窗口管理。

其他 0 次安装 0 次浏览 更新于 3/21/2026

名称: electron-egg 描述: 提供全面的 Electron EGG 框架指导,包括项目结构、主/渲染器进程、IPC、窗口管理和桌面应用开发。当用户询问 Electron EGG、需要使用 EGG 创建 Electron 应用程序或处理 Electron EGG 模式时使用。 许可证: 完整条款在 LICENSE.txt 中

何时使用此技能

每当用户想要时使用此技能:

  • 在项目中安装和设置 Electron EGG
  • 创建 Electron 桌面应用程序
  • 使用 Electron EGG 核心功能
  • 配置 Electron EGG
  • 处理主进程和渲染器进程通信
  • 使用 Electron EGG API 方法
  • 构建和打包 Electron 应用程序
  • 解决 Electron EGG 问题

如何使用此技能

此技能的组织方式与 Electron EGG 官方文档结构匹配 (https://www.kaka996.com/, https://www.kaka996.com/pages/987b1c/, https://www.kaka996.com/pages/a99b72/)。在使用 Electron EGG 时:

  1. 从用户请求中识别主题

    • 安装/安装 → examples/guide/installation.md
    • 快速开始/快速开始 → examples/guide/quick-start.md
    • 功能特性/功能特性 → examples/features/
    • API/API 文档 → api/
  2. examples/ 目录加载适当的示例文件

    指南 (使用文档)

    • 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 - 应用类、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/ 目录中(见上映射)。

使用示例:

  • 从用户请求中识别主题
  • 从上映射加载适当的示例文件
  • 遵循该文件中的说明、语法和最佳实践
  • 将代码示例适配到您的特定用例

使用模板:

  • 参考 templates/ 目录中的模板进行常见脚手架
  • 将模板适配到您的特定需求和编码风格

API 参考

详细的 API 文档可在 api/ 目录中找到,组织方式与官方 Electron EGG API 文档结构匹配 (https://www.kaka996.com/pages/a99b72/):

主进程 API (api/main-api.md)

  • 应用类和方法
  • BrowserWindow 创建和管理
  • ipcMain IPC 处理
  • 应用生命周期钩子

渲染器进程 API (api/renderer-api.md)

  • ipcRenderer IPC 通信
  • contextBridge 用于安全 API 暴露
  • 渲染器中可用的 DOM API
  • 事件处理

IPC API (api/ipc-api.md)

  • IPC 通信方法 (ipcMain, ipcRenderer)
  • 消息发送和接收
  • 异步和同步 IPC
  • 事件处理和通道

窗口 API (api/window-api.md)

  • BrowserWindow 创建和选项
  • 窗口管理方法
  • 窗口事件
  • 窗口生命周期

配置 API (api/config-api.md)

  • 配置文件结构
  • 应用信息配置
  • 窗口配置
  • 插件配置
  • 环境变量

使用 API 参考:

  1. 识别您需要帮助的 API
  2. api/ 目录加载相应的 API 文件
  3. 找到 API 签名、参数、返回类型和示例
  4. 参考链接的示例文件以获取详细使用模式
  5. 所有 API 文件包括到 examples/ 目录中相关示例文件的链接

最佳实践

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

资源

关键词

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