ipcRenderer

历史

版本(s)	更改
None	ipcRenderer 无法通过 contextBridge 发送

从渲染进程异步地与主进程通信。

进程: 渲染进程

信息

如果要在启用了上下文隔离的渲染进程中调用此 API，请将 API 调用放在你的 preload 脚本中，并使用 expose 它，通过 contextBridge API。

ipcRenderer 模块是一个 EventEmitter。它提供了一些方法，以便你可以从渲染进程（网页）向主进程发送同步和异步消息。你还可以从主进程接收回复。

请参阅 IPC 教程 以获取代码示例。

方法

ipcRenderer 模块具有以下方法来监听事件和发送消息

ipcRenderer.on(channel, listener)

• channel string
• listener Function
  • event IpcRendererEvent
  • ...args any[]

监听 channel，当新消息到达时，将调用 listener(event, args...)。

警告

出于安全原因，请勿将 event 参数暴露给渲染进程！将从渲染进程接收到的任何回调函数包装在另一个函数中，如下所示：ipcRenderer.on('my-channel', (event, ...args) => callback(...args))。不将回调函数包装在这样的函数中会将危险的 Electron API 暴露给渲染进程。有关更多信息，请参阅 安全指南。

ipcRenderer.off(channel, listener)

• channel string
• listener Function
  • event IpcRendererEvent
  • ...args any[]

从指定 channel 的监听器数组中移除指定的 listener。

ipcRenderer.once(channel, listener)

• channel string
• listener Function
  • event IpcRendererEvent
  • ...args any[]

为事件添加一次性 listener 函数。此 listener 仅在下次向 channel 发送消息时调用，之后将被移除。

ipcRenderer.addListener(channel, listener)

• channel string
• listener Function
  • event IpcRendererEvent
  • ...args any[]

ipcRenderer.on 的别名 ipcRenderer.on。

ipcRenderer.removeListener(channel, listener)

• channel string
• listener Function
  • event IpcRendererEvent
  • ...args any[]

ipcRenderer.off 的别名 ipcRenderer.off。

ipcRenderer.removeAllListeners([channel])

• channel string (可选)

移除指定 channel 的所有监听器。如果未指定 channel，则移除所有 channel 的所有监听器。

ipcRenderer.send(channel, ...args)

• channel string
• ...args any[]

通过 channel 异步地向主进程发送消息，并附带参数。参数将使用 结构化克隆算法 序列化，就像 window.postMessage 一样，因此原型链将不会被包含。发送函数、Promise、Symbols、WeakMaps 或 WeakSets 将抛出异常。

注意： 发送非标准的 JavaScript 类型，例如 DOM 对象或特殊的 Electron 对象，将抛出异常。

由于主进程不支持 DOM 对象（例如 ImageBitmap、File、DOMMatrix 等），因此此类对象无法通过 Electron 的 IPC 发送到主进程，因为主进程无法解码它们。尝试通过 IPC 发送此类对象会导致错误。

主进程通过使用 ipcMain 模块监听 channel 来处理它。

如果你需要将 MessagePort 传输到主进程，请使用 ipcRenderer.postMessage。

如果你想从主进程接收单个响应，例如方法调用的结果，请考虑使用 ipcRenderer.invoke。

ipcRenderer.invoke(channel, ...args)

• channel string
• ...args any[]

返回 Promise<any> - 解析为主进程的响应。

通过 channel 向主进程发送消息并异步地期望结果。参数将使用 结构化克隆算法 序列化，就像 window.postMessage 一样，因此原型链将不会被包含。发送函数、Promise、Symbols、WeakMaps 或 WeakSets 将抛出异常。

主进程应使用 ipcMain.handle() 监听 channel。

例如

// Renderer process
ipcRenderer.invoke('some-name', someArgument).then((result) => {
  // ...
})

// Main process
ipcMain.handle('some-name', async (event, someArgument) => {
  const result = await doSomeWork(someArgument)
  return result
})

如果你需要将 MessagePort 传输到主进程，请使用 ipcRenderer.postMessage。

如果你不需要消息的响应，请考虑使用 ipcRenderer.send。

注意

发送非标准的 JavaScript 类型，例如 DOM 对象或特殊的 Electron 对象，将抛出异常。

由于主进程不支持 DOM 对象（例如 ImageBitmap、File、DOMMatrix 等），因此此类对象无法通过 Electron 的 IPC 发送到主进程，因为主进程无法解码它们。尝试通过 IPC 发送此类对象会导致错误。

注意

如果主进程中的处理程序抛出错误，则 invoke 返回的 promise 将被拒绝。但是，渲染进程中的 Error 对象将与主进程中抛出的对象不同。

ipcRenderer.sendSync(channel, ...args)

• channel string
• ...args any[]

返回 any - 由 ipcMain 处理程序返回的值。

通过 channel 向主进程发送消息并同步地期望结果。参数将使用 结构化克隆算法 序列化，就像 window.postMessage 一样，因此原型链将不会被包含。发送函数、Promise、Symbols、WeakMaps 或 WeakSets 将抛出异常。

注意： 发送非标准的 JavaScript 类型，例如 DOM 对象或特殊的 Electron 对象，将抛出异常。

由于主进程不支持 DOM 对象（例如 ImageBitmap、File、DOMMatrix 等），因此此类对象无法通过 Electron 的 IPC 发送到主进程，因为主进程无法解码它们。尝试通过 IPC 发送此类对象会导致错误。

主进程通过使用 ipcMain 模块监听 channel 来处理它，并通过设置 event.returnValue 来回复。

警告

发送同步消息将阻塞整个渲染进程，直到收到回复，因此仅在万不得已时才使用此方法。最好使用异步版本，invoke()。

ipcRenderer.postMessage(channel, message, [transfer])

• channel string
• message any
• transfer MessagePort[] (可选)

向主进程发送消息，可以选择性地转移零个或多个 MessagePort 对象的所有权。

转移的 MessagePort 对象将作为通过发出的事件的 ports 属性在主进程中可用 MessagePortMain 对象。

例如

// Renderer process
const { port1, port2 } = new MessageChannel()
ipcRenderer.postMessage('port', { message: 'hello' }, [port1])

// Main process
ipcMain.on('port', (e, msg) => {
  const [port] = e.ports
  // ...
})

有关使用 MessagePort 和 MessageChannel 的更多信息，请参阅 MDN 文档。

ipcRenderer.sendToHost(channel, ...args)

• channel string
• ...args any[]

类似于 ipcRenderer.send，但事件将发送到宿主页中的 <webview> 元素，而不是主进程。