ipcRenderer

历史

版本(s)	更改
>=29.0.0	ipcRenderer 不再可以通过 contextBridge 发送

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

进程： 渲染器

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.removeListener(channel, listener)

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

是 ipcRenderer.off 的别名。

ipcRenderer.removeAllListeners([channel])

• channel string (可选)

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

ipcRenderer.send(channel, ...args)

• channel string
• ...args any[]

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

注意： 发送非标准的 JavaScript 类型（如 DOM 对象或特殊的 Electron 对象）将引发异常。

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

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

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

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

ipcRenderer.invoke(channel, ...args)

• channel string
• ...args any[]

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

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

主进程应使用 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 对象）将引发异常。

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

注意

如果在主进程中的处理程序引发错误，invoke 返回的 Promise 将会拒绝。但是，渲染进程中的 Error 对象将与主进程中引发的 Error 对象不同。

ipcRenderer.sendSync(channel, ...args)

• channel string
• ...args any[]

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

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

注意： 发送非标准的 JavaScript 类型（如 DOM 对象或特殊的 Electron 对象）将引发异常。

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

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

警告

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

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

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

向主进程发送消息，并可选择性地传输零个或多个 MessagePort 对象的拥有权。

传输的 MessagePort 对象将在主进程中作为 MessagePortMain 对象，通过访问发出事件的 ports 属性来获取。

例如

// 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> 元素，而不是主进程。