差别
这里会显示出您选择的修订版和当前版本之间的差别。
| 后一修订版 | 前一修订版 | ||
| 使用ipc进行通讯 [2026/11/17 08:14] – 创建 张叶安 | 使用ipc进行通讯 [2026/11/17 08:16] (当前版本) – 添加 IPC 知识点速记导图 张叶安 | ||
|---|---|---|---|
| 行 1: | 行 1: | ||
| - | 1 | + | ====== Electron 使用 IPC 进行进程间通讯 ====== |
| + | |||
| + | Electron 的每个窗口都是一个独立的渲染进程,默认**没有** Node.js 能力;系统级操作(文件、对话框、菜单、原生 API)只能由主进程完成。因此 IPC 不是可选的优化手段,而是**安全模型推导出的必然结果**:渲染进程想做事,必须显式委托主进程。 | ||
| + | |||
| + | ===== 一、进程模型 ===== | ||
| + | |||
| + | ^ 环境 ^ 角色 ^ 能力 ^ | ||
| + | | 主进程 main | 全局唯一,Node.js 环境 | 创建 '' | ||
| + | | 渲染进程 renderer | 每个窗口一个,Chromium | 只跑页面 DOM,**默认没有 Node 能力** | | ||
| + | | 预加载 preload | 挂在渲染进程里、运行在隔离世界 | 可用部分 Node 与 '' | ||
| + | |||
| + | ===== 二、四条 IPC 通道,怎么选 ===== | ||
| + | |||
| + | ==== 1. 单向:渲染进程 → 主进程 '' | ||
| + | |||
| + | <code js> | ||
| + | // preload / renderer | ||
| + | ipcRenderer.send(' | ||
| + | |||
| + | // main | ||
| + | ipcMain.on(' | ||
| + | </ | ||
| + | |||
| + | 拿不到返回值,只适合" | ||
| + | |||
| + | ==== 2. 请求-响应:'' | ||
| + | |||
| + | <code js> | ||
| + | // main | ||
| + | ipcMain.handle(' | ||
| + | const { canceled, filePaths } = await dialog.showOpenDialog(options) | ||
| + | return canceled ? null : filePaths[0] | ||
| + | }) | ||
| + | |||
| + | // preload | ||
| + | const file = await ipcRenderer.invoke(' | ||
| + | </ | ||
| + | |||
| + | 返回 Promise,天然支持 '' | ||
| + | |||
| + | ==== 3. 主进程 → 渲染进程:'' | ||
| + | |||
| + | <code js> | ||
| + | // main | ||
| + | win.webContents.send(' | ||
| + | |||
| + | // preload | ||
| + | ipcRenderer.on(' | ||
| + | </ | ||
| + | |||
| + | 方向是反的,必须先注册监听。注意**消息可能被错过**:如果推送发生在页面注册 '' | ||
| + | |||
| + | ==== 4. 同步 '' | ||
| + | |||
| + | 通过 '' | ||
| + | |||
| + | ==== 5. 渲染进程 ↔ 渲染进程 ==== | ||
| + | |||
| + | 没有直连通道。要么经主进程转发(用 '' | ||
| + | |||
| + | ===== 三、安全写法:'' | ||
| + | |||
| + | 现代 Electron 的默认值已经是安全配置('' | ||
| + | |||
| + | <code js> | ||
| + | // preload.js | ||
| + | const { contextBridge, | ||
| + | |||
| + | contextBridge.exposeInMainWorld(' | ||
| + | openFile: (opts) => ipcRenderer.invoke(' | ||
| + | onProgress: (cb) => { | ||
| + | const handler = (_e, data) => cb(data) | ||
| + | ipcRenderer.on(' | ||
| + | return () => ipcRenderer.off(' | ||
| + | } | ||
| + | }) | ||
| + | </ | ||
| + | |||
| + | 三个关键点: | ||
| + | |||
| + | * **不要把整个 '' | ||
| + | * **只暴露" | ||
| + | * **页面侧的事件监听必须能解除**,所以 '' | ||
| + | |||
| + | 另外 '' | ||
| + | |||
| + | <code js> | ||
| + | ipcMain.handle(' | ||
| + | const url = event.senderFrame? | ||
| + | if (!url.startsWith(' | ||
| + | throw new Error(' | ||
| + | } | ||
| + | // 还要自己校验 p(白名单 / 路径规范化),不要直接丢给 fs | ||
| + | }) | ||
| + | </ | ||
| + | |||
| + | ===== 四、能传什么、不能传什么 ===== | ||
| + | |||
| + | 参数走**结构化克隆(structured clone)**,不是 JSON: | ||
| + | |||
| + | ^ 可以传 ^ 不能传 ^ | ||
| + | | string / number / boolean / null | 函数 | | ||
| + | | Array、普通 Object | DOM 节点 | | ||
| + | | '' | ||
| + | | '' | ||
| + | | '' | ||
| + | |||
| + | **错误传播的坑**:主进程 '' | ||
| + | |||
| + | <code js> | ||
| + | return { ok: false, code: ' | ||
| + | </ | ||
| + | |||
| + | **性能**:每次 IPC 都有序列化成本,几百 KB 以上的数据(大 JSON、图片 base64)会明显卡界面。可选方案:分批推送、写本地文件后传路径、'' | ||
| + | |||
| + | ===== 五、常见坑清单 ===== | ||
| + | |||
| + | * '' | ||
| + | * 同一 channel 用 '' | ||
| + | * 窗口已销毁还 '' | ||
| + | * 弹'' | ||
| + | * '' | ||
| + | * preload 里别写业务逻辑,只做转发和形状约束;'' | ||
| + | * channel 统一命名 '' | ||
| + | * 主→渲染的推送要处理" | ||
| + | |||
| + | ===== 六、一句话总结 ===== | ||
| + | |||
| + | > 用 '' | ||
| + | |||
| + | ===== 七、速记导图 ===== | ||
| + | |||
| + | ```mdk height=520 color=# | ||
| + | # Electron IPC 进程间通讯 | ||
| + | |||
| + | ## 进程模型 | ||
| + | ### 主进程 main | ||
| + | - 全局唯一,Node.js 环境 | ||
| + | - 窗口 / 菜单 / 对话框 / 文件系统 | ||
| + | ### 渲染进程 renderer | ||
| + | - 每窗口一个,Chromium | ||
| + | - 默认没有 Node 能力 | ||
| + | ### 预加载 preload | ||
| + | - 隔离世界 | ||
| + | - 唯一桥梁 | ||
| + | |||
| + | ## 四条通道 | ||
| + | ### 渲染 → 主 send / on | ||
| + | - 单向通知 | ||
| + | - 拿不到返回值 | ||
| + | ### 渲染 → 主 invoke / handle(首选) | ||
| + | - 返回 Promise | ||
| + | - 支持 async/ | ||
| + | - 错误自动 reject | ||
| + | ### 主 → 渲染 webContents.send | ||
| + | - 先注册 ipcRenderer.on | ||
| + | - 小心消息被错过 | ||
| + | ### 同步 sendSync | ||
| + | - 阻塞渲染进程 | ||
| + | - 有死锁风险,避免 | ||
| + | ### 渲染 ↔ 渲染 | ||
| + | - 经主进程转发 | ||
| + | - MessageChannelMain / MessagePort | ||
| + | |||
| + | ## 安全 | ||
| + | ### contextIsolation 默认 true | ||
| + | ### nodeIntegration 默认 false | ||
| + | ### 不暴露整个 ipcRenderer | ||
| + | ### 只暴露动词级窄接口 | ||
| + | ### channel 名写死在 preload | ||
| + | ### 校验 event.senderFrame.url | ||
| + | ### 参数自己做白名单 | ||
| + | |||
| + | ## 传值规则 | ||
| + | ### 结构化克隆,不是 JSON | ||
| + | - Date / Map / Set / ArrayBuffer | ||
| + | ### 不能传函数、DOM、Symbol | ||
| + | ### 类实例会丢原型方法 | ||
| + | ### Error 只保留 message | ||
| + | - 建议返回 { ok, code } | ||
| + | ### 大数据要分批或走文件 | ||
| + | |||
| + | ## 常见坑 | ||
| + | ### No handler registered | ||
| + | ### handle 重复注册会抛错 | ||
| + | ### Object has been destroyed | ||
| + | ### 监听器泄漏 MaxListenersExceeded | ||
| + | ### dialog 父窗口 fromWebContents | ||
| + | ### sandbox 下 preload 受限 | ||
| + | ### channel 命名 模块: | ||
| + | |||
| + | ## 一句话 | ||
| + | ### invoke/ | ||
| + | ### webContents.send 做推送 | ||
| + | ### 最小暴露 | ||
| + | ### 永不信任渲染进程参数 | ||
| + | ``` | ||