Electron 开发常用工具与 npm 生态指南
一、为什么 Electron 项目需要这么多工具?
Electron 本质上是一个结合 Chromium 和 Node.js 的桌面应用开发框架。
一个典型的 Electron 项目通常包含三个部分:
- Main Process(主进程):负责应用生命周期、窗口管理、系统 API 调用等。
- Preload(预加载脚本):负责在主进程和渲染进程之间建立安全的通信桥梁。
- Renderer Process(渲染进程):负责界面展示,通常使用 Vue、React 等前端框架。
随着项目复杂度增加,开发过程中会遇到很多问题:
- 修改代码后如何自动重启?
- 如何同时启动前端和 Electron?
- 如何管理开发环境和生产环境?
- 如何统一代码格式和规范?
- 如何进行单元测试?
- 如何将应用打包成 Windows 安装程序?
- 如何实现软件自动更新?
- 如何保护发布后的 JavaScript 代码?
这些问题分别由不同的 npm 工具解决。
理解这些工具,实际上就是理解现代 JavaScript 项目的工程化体系。
二、开发效率工具
这类工具主要解决日常开发中的效率问题。
| npm 包 | 核心作用 | 典型应用场景 |
|---|---|---|
| nodemon | 监控文件变化并重启 Node 进程 | 修改主进程代码后自动重启 |
| concurrently | 并行执行多个命令 | 同时启动 Vite 和 Electron |
| wait-on | 等待指定资源就绪 | 等待 Vite 服务启动 |
| cross-env | 跨平台设置环境变量 | 区分开发环境和生产环境 |
| npm-run-all | 管理多个 npm 脚本 | 串行或并行执行任务 |
| rimraf | 跨平台删除文件和目录 | 清理 dist、build |
| dotenv | 加载环境变量文件 | 管理 API 地址和环境配置 |
2.1 nodemon:自动重启 Node.js 进程
nodemon 是一个非常常用的开发辅助工具。
它可以监控指定文件,当文件发生变化时自动重启 Node.js 进程。
安装:
|
|
配置:
|
|
适用场景:
- Node.js 后端开发。
- Electron 主进程开发。
- 本地脚本开发。
注意:nodemon 主要监控并重启 Node.js 进程,并不负责前端页面的 HMR(热模块替换)。
2.2 concurrently:同时运行多个命令
Electron 项目开发时,通常需要同时运行:
- Vite:启动前端开发服务器。
- Electron:启动桌面应用。
concurrently 可以同时执行多个命令。
安装:
|
|
配置:
|
|
执行:
|
|
即可同时启动两个进程。
2.3 wait-on:等待资源就绪
在 Electron 开发中存在一个常见问题:
Electron 启动时,Vite 服务可能还没有启动完成,导致 Electron 无法加载前端页面。
wait-on 可以等待指定资源就绪后再继续执行命令。
安装:
|
|
示例:
|
|
执行逻辑:
- 启动 Vite。
- wait-on 持续检查指定地址。
- 当 Vite 服务可以访问时,启动 Electron。
2.4 cross-env:跨平台环境变量
Windows、macOS 和 Linux 在命令行中设置环境变量的语法存在差异。
例如:
|
|
这种写法在部分 Windows 命令环境中无法直接使用。
cross-env 可以解决跨平台兼容问题。
安装:
|
|
使用:
|
|
无论 Windows 还是 macOS,都可以使用相同的 npm 脚本。
三、构建与打包工具
这类工具负责将开发代码转换成可以运行和分发的软件。
| npm 包 | 核心作用 | 典型应用场景 |
|---|---|---|
| vite | 前端开发服务器和构建工具 | 前端热更新、生产构建 |
| electron-vite | Electron 专用开发构建工具 | Main、Preload、Renderer 构建 |
| electron-builder | Electron 应用打包 | 生成 Windows、macOS 安装包 |
| electron-forge | Electron 官方工具链 | 项目初始化、打包和发布 |
| esbuild | 高性能 JS/TS 编译打包 | 编译主进程和预加载脚本 |
| @electron/rebuild | 原生模块重新编译 | 处理 Electron ABI 兼容问题 |
3.1 Vite:现代前端构建工具
Vite 主要负责前端开发和生产构建。
核心能力:
- 快速启动开发服务器。
- HMR 热模块替换。
- TypeScript、CSS 等资源处理。
- 生产环境代码打包优化。
3.2 electron-vite:Electron 专用构建工具
electron-vite 是专门为 Electron 设计的开发和构建工具。
它主要解决 Electron 三个部分的构建问题:
| 模块 | 作用 |
|---|---|
| Main | Electron 主进程 |
| Preload | 预加载脚本 |
| Renderer | 前端渲染界面 |
主要优势:
- 提供 Renderer 热更新。
- 支持 Main 进程代码变化后的重启。
- 支持 Preload 脚本构建。
- 统一管理 Electron 三部分的开发和构建配置。
对于现代 Electron 项目,electron-vite 是值得优先考虑的方案。
3.3 electron-builder:应用打包工具
electron-builder 负责将 Electron 项目及其依赖打包成可以分发的软件。
例如:
| 平台 | 常见输出格式 |
|---|---|
| Windows | exe、msi、nsis 安装包 |
| macOS | dmg、zip |
| Linux | AppImage、deb、rpm |
安装:
|
|
配置示例:
|
|
electron-builder 还支持:
- 应用图标配置。
- 安装程序定制。
- 代码签名。
- 自动更新发布配置。
- 资源文件管理。
官网:https://www.electron.build/
3.4 electron-forge 与 electron-builder 的区别
两者都能用于 Electron 项目的打包和发布。
但定位有所不同:
- electron-forge:提供从项目脚手架到打包、发布的完整工具链。
- electron-builder:更专注于应用打包、安装程序制作和发布。
一般不需要为了相同的打包任务同时使用两者。
3.5 esbuild:高性能编译工具
esbuild 是一个使用 Go 编写的高性能 JavaScript、TypeScript 打包工具。
主要特点:
- 编译速度快。
- 支持 TypeScript。
- 支持代码压缩。
- 支持 Tree Shaking。
- 可以用于构建 Electron 主进程和预加载脚本。
四、代码质量与规范工具
当项目逐渐变大,多人协作或者代码模块增加时,代码规范就非常重要。
| npm 包 | 核心作用 |
|---|---|
| typescript | 静态类型检查 |
| eslint | 代码质量检查 |
| prettier | 代码格式化 |
| husky | Git Hooks 管理 |
| lint-staged | 只检查 Git 暂存文件 |
| commitlint | Git 提交信息规范 |
4.1 TypeScript
TypeScript 是 JavaScript 的超集,增加了静态类型系统。
例如:
|
|
通过类型定义,可以提前发现很多开发阶段的错误。
4.2 ESLint
ESLint 用于检查代码质量和潜在问题。
例如:
- 未使用的变量。
- 不规范的代码写法。
- 潜在的逻辑错误。
- 不符合项目规则的代码。
4.3 Prettier
Prettier 主要负责代码格式统一。
例如:
|
|
格式化后:
|
|
ESLint 和 Prettier 的区别:
- ESLint:关注代码质量。
- Prettier:关注代码格式。
建议同时使用。
4.4 Husky + lint-staged
这两个工具可以组合起来实现 Git 提交前自动检查。
工作流程:
|
|
这样可以减少不规范代码进入主分支的情况。
五、测试与调试工具
| npm 包 | 核心作用 | 适用场景 |
|---|---|---|
| vitest | 单元测试 | 测试函数和业务逻辑 |
| playwright | 自动化测试 | 模拟用户操作和界面测试 |
| electron-devtools-installer | 安装 DevTools 扩展 | React、Vue 调试 |
5.1 Vitest
Vitest 是一个现代 JavaScript 测试框架,和 Vite 生态集成良好。
安装:
|
|
示例:
|
|
适合测试:
- 数据转换。
- 计算公式。
- 配置解析。
- 业务逻辑。
- 通信协议解析。
5.2 Playwright
Playwright 是浏览器和应用自动化测试工具。
在 Electron 项目中,可以用它:
- 自动启动 Electron 应用。
- 模拟鼠标点击。
- 输入文本。
- 检查界面内容。
- 验证用户操作流程。
例如,可以自动测试设备管理页面:
- 打开应用。
- 进入设备管理页面。
- 点击新增设备。
- 输入设备名称。
- 点击保存。
- 检查设备是否成功显示。
对于长期维护的桌面软件,Playwright 很有价值。
六、Electron 常用功能库
这类工具不一定属于 Electron 专属,但在实际项目中使用非常频繁。
| npm 包 | 主要作用 | 典型应用场景 |
|---|---|---|
| axios | HTTP 请求 | 调用 REST API |
| electron-store | 本地配置存储 | 保存用户配置 |
| electron-log | Electron 日志管理 | 记录程序运行日志 |
| winston | 通用日志管理 | 后端日志、业务日志 |
| zod | 数据结构校验 | 校验接口数据和配置 |
| dayjs | 日期时间处理 | 时间格式转换 |
| uuid | 生成唯一 ID | 设备编号、任务编号 |
| lodash-es | 通用工具函数 | 数组和对象处理 |
| serialport | 串口通信 | RS232、RS485 |
| better-sqlite3 | SQLite 数据库 | 本地历史数据存储 |
| sharp | 图片处理 | 图片压缩、裁剪 |
6.1 electron-store
用于保存应用配置。
例如:
|
|
适合存储:
- 用户设置。
- 设备配置。
- API 地址。
- 窗口状态相关配置。
6.2 electron-log
用于记录 Electron 应用的运行日志。
例如:
|
|
对于工业上位机尤其重要。
发生通信故障时,可以通过日志追踪问题。
6.3 Zod
Zod 是一个 TypeScript 优先的数据校验库。
例如:
|
|
可以用于:
- 校验配置文件。
- 校验 API 返回值。
- 校验 IPC 消息。
- 校验用户输入。
6.4 SerialPort
SerialPort 是 Node.js 生态中常用的串口通信库。
安装:
|
|
主要用于:
- RS232 通信。
- RS485 通信。
- Modbus RTU 通信。
- 工业仪表数据采集。
在 Electron 中使用原生模块时,需要注意 Electron 与 Node.js 的 ABI 兼容性,必要时使用 @electron/rebuild。
6.5 better-sqlite3
这是一个 SQLite 数据库操作库。
适合本地桌面应用:
- 保存设备信息。
- 保存历史测量数据。
- 保存报警记录。
- 保存通信记录。
- 保存用户操作记录。
对于不需要独立数据库服务器的 Electron 应用,这是一个很实用的选择。
七、代码保护与应用安全
| npm 包 | 核心作用 |
|---|---|
| javascript-obfuscator | JavaScript 代码混淆 |
| electron-updater | 应用自动更新 |
| @electron/fuses | Electron 功能开关和安全加固 |
7.1 javascript-obfuscator
JavaScript 代码混淆工具。
主要作用:
- 变量名混淆。
- 字符串加密或转换。
- 控制流扁平化。
- 增加代码阅读难度。
安装:
|
|
需要注意:代码混淆只能提高逆向分析成本,不能真正防止代码被提取或破解。
7.2 electron-updater
用于实现 Electron 应用自动更新。
典型流程:
|
|
适合需要长期维护和持续发布的桌面软件。
7.3 @electron/fuses
用于控制 Electron 内部部分功能开关。
例如:
- 禁用 RunAsNode。
- 禁用不必要的调试能力。
- 禁用部分不需要的运行时功能。
它属于应用安全加固工具,不是代码混淆工具。
八、推荐的 Electron 项目技术栈
如果从零开始开发一个需要长期维护的 Electron 桌面应用,可以考虑下面这套组合。
| 类别 | 推荐工具 |
|---|---|
| 桌面框架 | Electron |
| 前端框架 | Vue 3 / React |
| 开发构建 | electron-vite |
| 编程语言 | TypeScript |
| 包管理器 | pnpm / npm |
| 代码规范 | ESLint + Prettier |
| 单元测试 | Vitest |
| 自动化测试 | Playwright |
| 应用打包 | electron-builder |
| 代码保护 | javascript-obfuscator |
| 自动更新 | electron-updater |
| 数据库 | better-sqlite3 |
| 配置管理 | electron-store |
| 日志管理 | electron-log |
推荐安装顺序
第一阶段:开发基础
|
|
第二阶段:开发效率
|
|
注意:如果使用 electron-vite,很多开发服务器管理工作已经由它承担,不一定需要再单独安装这些工具。
第三阶段:测试
|
|
第四阶段:应用功能
|
|
第五阶段:打包和发布
|
|
具体依赖应根据项目需要选择,不建议一次性安装全部工具。
九、总结:如何理解 Electron 工具生态?
可以把 Electron 开发工具理解成一条完整的软件生产流水线:
| 开发阶段 | 解决的问题 | 代表工具 |
|---|---|---|
| 开发阶段 | 如何提高开发效率 | nodemon、concurrently、wait-on |
| 构建阶段 | 如何编译和打包代码 | Vite、electron-vite、esbuild |
| 规范阶段 | 如何保证代码质量 | TypeScript、ESLint、Prettier |
| 测试阶段 | 如何验证程序正确性 | Vitest、Playwright |
| 功能阶段 | 如何实现应用功能 | axios、zod、SQLite、SerialPort |
| 发布阶段 | 如何生成安装包 | electron-builder |
| 维护阶段 | 如何更新和记录运行情况 | electron-updater、electron-log |
| 安全阶段 | 如何提高应用安全性 | javascript-obfuscator、@electron/fuses |
最重要的认识:
npm 生态中的工具并不是越多越好。每一个工具都应该对应一个明确的问题。
例如:
- 需要自动重启进程,考虑 nodemon。
- 需要同时启动多个命令,考虑 concurrently。
- 需要等待服务就绪,考虑 wait-on。
- 需要统一代码规范,考虑 ESLint + Prettier。
- 需要测试业务逻辑,考虑 Vitest。
- 需要打包安装程序,考虑 electron-builder。
- 需要实现自动更新,考虑 electron-updater。
真正成熟的工程化能力,不是记住多少 npm 包,而是能够根据项目需求,准确选择合适的工具,并理解它们之间的协作关系。
十、官方资料
- Electron:https://www.electronjs.org/docs/latest/
- Electron Vite:https://electron-vite.org/
- Electron Builder:https://www.electron.build/
- Electron Forge:https://www.electronforge.io/
- Vite:https://vite.dev/
- TypeScript:https://www.typescriptlang.org/
- Vitest:https://vitest.dev/
- Playwright:https://playwright.dev/
- Awesome Electron:https://github.com/sindresorhus/awesome-electron