electron:快速开始

差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

两侧同时换到之前的修订记录 前一修订版
后一修订版
前一修订版
electron:快速开始 [2026/11/03 23:54] – 追加方式 B:preload 与渲染脚本 张叶安electron:快速开始 [2026/11/03 23:54] (当前版本) – 为快速开始页添加思维导图概览 张叶安
行 124: 行 124:
   `Electron ${versions.electron()} / Chromium ${versions.chrome()} / Node ${versions.node()}`   `Electron ${versions.electron()} / Chromium ${versions.chrome()} / Node ${versions.node()}`
 </code> </code>
 +
 +''3. index.html'' —— 就是一个普通网页:一个标题、一个用来显示版本号的段落。示例核心内容:
 +
 +<code html>
 +<h1>你好,Electron</h1>
 +<p id="ver"></p>
 +</code>
 +
 +再在页面末尾用 `script` 标签引入 `./renderer.js`,并在 `head` 中加一条 CSP meta(例如 `default-src 'self'`)。
 +
 +最后启动:
 +
 +<code bash>
 +npm start
 +</code>
 +
 +===== 四、主进程与渲染进程通信(IPC) =====
 +
 +页面里不能直接调 Node,要请主进程代劳,推荐 `invoke` / `handle` 这一对。
 +
 +主进程注册处理函数:
 +
 +<code js>
 +const { ipcMain, dialog } = require('electron')
 +
 +ipcMain.handle('pick-file', async () => {
 +  const r = await dialog.showOpenDialog({ properties: ['openFile'] })
 +  return r.canceled ? null : r.filePaths[0]
 +})
 +</code>
 +
 +preload 里包一层,暴露给页面:
 +
 +<code js>
 +const { contextBridge, ipcRenderer } = require('electron')
 +
 +contextBridge.exposeInMainWorld('api', {
 +  pickFile: () => ipcRenderer.invoke('pick-file')
 +})
 +</code>
 +
 +页面里调用:
 +
 +<code js>
 +const file = await window.api.pickFile()
 +console.log('选中文件:', file)
 +</code>
 +
 +===== 五、调试与打包 =====
 +
 +  * 调试渲染进程:`win.webContents.openDevTools()`,或快捷键 Ctrl+Shift+I。
 +  * 调试主进程:启动时加 `--inspect=5858`,再用 VS Code 附加到该端口。
 +  * 打包(Forge 项目):
 +
 +<code bash>
 +npm run make      # 生成安装包,产物在 out/
 +npm run package   # 只打包成可执行目录,不做安装程序
 +</code>
 +
 +  * 常用 maker:Windows 用 Squirrel 或 WiX,macOS 用 DMG,Linux 用 deb / rpm。
 +  * 若项目用的是 electron-builder:`npx electron-builder --win --x64`,配置写在 package.json 的 `build` 字段。
 +
 +===== 六、安全清单(别踩坑) =====
 +
 +  * `contextIsolation: true` 保持开启,`nodeIntegration` 保持关闭,`sandbox` 用默认开启。
 +  * 只通过 `contextBridge` 暴露**最小、具体**的函数,不要直接把 `ipcRenderer` 或 `require` 丢给页面。
 +  * 页面里加 CSP,不要加载来路不明的远程脚本。
 +  * IPC 处理函数要校验参数,尤其是文件路径和要执行的命令。
 +
 +===== 七、常见问题 =====
 +
 +^ 现象 ^ 原因 / 解决 ^
 +| `npm start` 报找不到 electron | 依赖没装好,重装一次:`npm install --save-dev electron` |
 +| 启动后白屏 | 检查 `loadFile` 路径和 package.json 的 `main` 是否指对入口,打开 DevTools 看报错 |
 +| require is not defined | 页面里本来就不该用 Node,改用 preload + IPC 的方式 |
 +| 下载 Electron 卡住或超时 | 配置 `electron_mirror` 镜像,或删掉 node_modules 后重装 |
 +| 改了页面不自动刷新 | 手动 Ctrl+R 刷新,或用 Vite 模板获得热更新 |
 +| 安装包几百 MB | 正常,Electron 内置整个 Chromium;可用 asar 打包、裁剪资源来瘦身 |
 +
 +===== 八、下一步 =====
 +
 +  * 需要菜单、托盘、系统通知,看 `Menu`、`Tray`、`Notification` 模块。
 +  * 需要读写本地文件或 SQLite,放在主进程做,再通过 IPC 暴露。
 +  * 需要自动更新,用 `autoUpdater`(Forge 有 update 插件)。
 +  * 想用 React / Vue,直接用 electron-vite 或 Forge 的 vite 模板起步最省事。
 +
 +===== 一图概览 =====
 +
 +```mdk height=480 color=#0ea5e9
 +# Electron 快速开始
 +
 +## 环境准备
 +
 +- Node.js LTS
 +- npm registry 与 electron 镜像
 +
 +## 方式 A:脚手架
 +
 +- npm init electron-app
 +- src/main.js 主进程
 +- src/preload.js 桥接
 +- src/index.html 界面
 +- npm start 运行
 +
 +## 方式 B:手写最小项目
 +
 +- package.json:main 与 start
 +- main.js:BrowserWindow 开窗口
 +- preload.js:contextBridge 暴露 API
 +- index.html:普通网页
 +- renderer.js:页面脚本
 +
 +## 主进程与渲染进程
 +
 +- 主进程:窗口、系统能力
 +- 渲染进程:Chromium 页面
 +- IPC:ipcMain.handle / ipcRenderer.invoke
 +
 +## 调试与打包
 +
 +- DevTools 调试页面
 +- --inspect 调试主进程
 +- npm run make 出安装包
 +- electron-builder 也可
 +
 +## 安全要点
 +
 +- contextIsolation 开启
 +- nodeIntegration 关闭
 +- 只暴露最小 API
 +- 加 CSP、校验 IPC 参数
 +```
  

该主题尚不存在

您访问的页面并不存在。如果允许,您可以使用创建该页面按钮来创建它。

  • electron/快速开始.1793721280.txt.gz
  • 最后更改: 2026/11/03 23:54
  • 由 张叶安