一、引言
Electron 是一款由 GitHub 开发的开源框架,允许开发者使用 HTML、CSS 和 JavaScript 构建跨平台的桌面应用程序。无论你是 Web 开发者,还是想将现有网页项目转化为桌面应用,Electron 都能轻松实现。本教程将带领你从零开始,完成从环境搭建到打包发布的完整流程。
二、环境准备
1. 安装 Node.js 和 npm
- 访问 Node.js 官网 下载并安装 LTS 版本(推荐 v16.x 或更高)。
- 安装完成后,打开终端输入以下命令验证是否成功:
node -v # 查看 Node.js 版本
npm -v # 查看 npm 版本
- 提示:若版本号未显示,请重启终端或检查环境变量配置。
2. 安装 Electron
在终端中执行以下命令,将 Electron 安装为开发依赖:
npm install --save-dev electron
注:后续教程中所有命令均需在项目根目录下执行。
三、创建项目结构
1. 初始化项目
mkdir my-electron-app
cd my-electron-app
npm init -y # 生成默认的 package.json 文件
2. 创建核心文件
- main.js(主进程文件,控制应用窗口):
const { app, BrowserWindow } = require('electron');
const path = require('path');
function createWindow() {
const win = new BrowserWindow({
width: 1200,
height: 800,
webPreferences: {
nodeIntegration: true, // 允许 Node.js 集成(可选)
contextIsolation: false // 关闭上下文隔离(可选)
}
});
// 加载本地 HTML 文件(或远程网页)
win.loadFile('index.html');
// 若需加载远程网页(如 GitHub Pages),改用:
// win.loadURL('https://your-page-url.com');
}
app.whenReady().then(createWindow);
app.on('window-all-closed', () => {
if (process.platform !== 'darwin') {
app.quit();
}
});
- 代码说明:
- BrowserWindow 定义窗口尺寸和加载内容。
- app.whenReady() 确保 Electron 完全初始化后再创建窗口。
- index.html(前端页面文件):
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<title>我的桌面应用</title>
<style>
body { margin: 0; padding: 20px; font-family: Arial; }
</style>
</head>
<body>
<h1>欢迎使用 Electron 打包应用!</h1>
<p>这是一个由前端页面转化的桌面程序。</p>
</body>
</html>
四、运行与调试
1. 启动应用
在终端执行:
npm start
效果: 应用窗口将显示 index.html 的内容。
2. 调试技巧
- 打开开发者工具:在 main.js 中添加 win.webContents.openDevTools()。
- 热重载:安装 electron-reloader 后,在 main.js 引入:
require('electron-reloader')(module);
五、打包为可执行文件
1. 安装打包工具
推荐使用 electron-packager(简单易用)或 electron-builder(功能更强大)。
npm install --save-dev electron-packager # 或 electron-builder
2. 配置 package.json
在 scripts 中添加打包命令:
"scripts": {
"package-win": "electron-packager . MyAppName --platform=win32 --arch=x64 --icon=assets/icons/win/icon.ico --overwrite",
"package-mac": "electron-packager . MyAppName --platform=darwin --arch=x64 --icon=assets/icons/mac/icon.icns --overwrite",
"package-linux": "electron-packager . MyAppName --platform=linux --arch=x64 --icon=assets/icons/png/icon.png --overwrite"
}
参数说明:
- --platform:目标平台(win32/macOS/linux)。
- --arch:CPU 架构(x64/arm64 等)。
- --icon:应用图标路径(需准备 .ico/.icns/.png 格式)。
3. 执行打包命令
npm run package-win # 打包 Windows 版本
输出路径:
release-builds/MyAppName-win32-x64/
4. 使用 electron-builder(进阶)
在 package.json 中配置:
"build": {
"appId": "com.example.myapp",
"win": {
"target": "nsis", // 生成安装包
"icon": "assets/icons/win/icon.ico"
},
"nsis": {
"oneClick": false, // 允许自定义安装路径
"allowToChangeInstallationDirectory": true
}
}
执行命令:
npm run dist # 生成 .exe/.dmg/.deb 等安装包
六、常见问题解决
1. 打包时报错:Node.js 版本过高
在 package.json 的 scripts 中添加环境变量:
"scripts": {
"package-win": "SET NODE_OPTIONS=--openssl-legacy-provider && electron-packager . MyAppName ...",
"package-mac": "NODE_OPTIONS=--openssl-legacy-provider electron-packager . MyAppName ...",
"package-linux": "NODE_OPTIONS=--openssl-legacy-provider electron-packager . MyAppName ..."
}
2. 应用图标不显示
- 使用工具 icofx.ro 将图片转换为 .ico/.icns 格式。
- 确保图标路径与 --icon 参数一致。
3. 路由模式冲突(Vue 项目)
若前端使用 Vue Router 的 history 模式,打包后可能白屏。修改为 hash 模式:
const router = new VueRouter({
mode: 'hash', // 关键修改
routes: [...]
});
七、结束了
经由本教程,您已然熟稔了将前端网页借助 Electron 打包成桌面应用的核心技艺。
无论是仅仅用于简单地展示页面,比如基础的信息呈现、产品介绍等,还是致力于开发极为复杂的应用,例如涉及多个交互模块、大量数据处理以及复杂逻辑运算的应用程序,Electron 都能够给予强有力的支持。
若想要对应用进行进一步的优化,就可以去探索 asar 打包这一方式,它能够有效地隐藏源码,增强应用的安全性和保密性。此外,自动更新功能也是一个值得深入研究的方向。比如,当应用有新的版本发布时,自动更新功能能够及时提醒用户并在后台自动完成更新,为用户提供最新、最完善的使用体验,避免了用户手动查找和更新的繁琐过程。
感谢点赞关注收藏:)