Electron是一个使用 JavaScript、HTML 和 CSS 构建桌面应用程序的框架。 嵌入 Chromium 和 Node.js 到 二进制的 Electron 允许您保持一个 JavaScript 代码代码库并创建 在Windows上运行的跨平台应用 macOS和Linux——不需要本地开发 经验。
初始化项目:
初始化一个空项目,可以使用mkdir my-electron-app && cd my-electron-app
并执行npm init
,初始化的后要保证package中的字段main、author、description不能为空且main的字段内容需为main.js。
配置环境变量:
在安装electron时大概率你会安装失败,这些问题也大多是由于网络造成的,推荐使用镜像的进行安装,通过以下命令在项目目录进行配置:
echo 'registry = https://registry.npmmirror.com/' 'electron_mirror = https://registry.npmmirror.com/electron/' > .npmrc 复制代码
安装Electron:
npm install --save-dev electron
配置scripts:
- 启动electron命令:"start": "electron ."
添加electron的启动首页:
在项目根目录创建index.html文件
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <!-- https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP --> <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'"> <meta http-equiv="X-Content-Security-Policy" content="default-src 'self'; script-src 'self'"> <title>Hello World!</title> </head> <body> <h1>Hello World!</h1> We are using Node.js <span id="node-version"></span>, Chromium <span id="chrome-version"></span>, and Electron <span id="electron-version"></span>. </body> </html> 复制代码
打开首页:
- 导入模块
const { app, BrowserWindow } = require('electron') 复制代码
- 创建窗口
function createWindow () { const win = new BrowserWindow({ width: 800, height: 600 }) win.loadFile('index.html') } 复制代码
- 打开窗口
app.whenReady().then(() => { createWindow() }) 复制代码
管理窗口的生命周期:
关闭所有窗口退出应用(Win,Linux):
- 对应事件:window-all-closed
- 平台信息:process.platform
app.on('window-all-closed', function () { if (process.platform !== 'darwin') app.quit() }) 复制代码
没有窗口打开则打开一个窗口(macOS):
- 说明:macOS在没有窗口打开也会继续运行,且在没有窗口可用时激活应用会打开新窗口
- 对应事件:activate
app.whenReady().then(() => { createWindow() app.on('activate', function () { if (BrowserWindow.getAllWindows().length === 0) createWindow() }) }) 复制代码
脚本预加载
- 说明:脚本会在渲染器进行加载前执行,通过process对象获取chrome,node,electron的版本
- 脚本内容
// preload.js window.addEventListener('DOMContentLoaded', () => { const replaceText = (selector, text) => { const element = document.getElementById(selector) if (element) element.innerText = text } for (const dependency of ['chrome', 'node', 'electron']) { replaceText(`${dependency}-version`, process.versions[dependency]) } }) 复制代码
- 重新配置BrowserWindow实例
const win = new BrowserWindow({ width: 800, height: 600, webPreferences: { preload: path.join(__dirname, 'preload.js') } }) 复制代码
打包分发(Electron Forge)
- 安装并添加命令:
npm install --save-dev @electron-forge/cli npx electron-forge import
- 执行make命令创建应用程序:
npm run make
- 打包结束后会在项目根目录下生成out文件及打包内容
总结:
内容主要整理自官方指南,我也是头一回学习客户端开发,打算把官方文档的内容进行精简并实践一次,整体过完后在总结一次客户端开发的一些内容,并且我也会完善此次客户端学习的思维导图😘,后期复习就不再翻文档了。