跳到主要内容

ipcMain

从主进程异步通信到渲染进程。

进程：主进程

ipcMain 模块是一个 事件发送器。在主进程中使用时，它处理从渲染进程（网页）发送的异步和同步消息。从渲染进程发送的消息将发送到此模块。

有关使用示例，请查看 IPC 教程。

发送消息​

也可以从主进程发送消息到渲染进程，请参阅 webContents.send 以获取更多信息。

  • 发送消息时，事件名称即是 channel。
  • 要回复同步消息，需要设置 event.returnValue。
  • 要向发送者发送异步消息，可以使用 event.reply(...)。此辅助方法将自动处理来自非主框架（例如 iframe）的消息，而 event.sender.send(...) 将始终发送到主框架。

方法​

ipcMain 模块具有以下监听事件的方法

ipcMain.on(channel, listener)​

  • channel 字符串
  • listener Function

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

ipcMain.off(channel, listener)​

  • channel 字符串
  • listener Function

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

ipcMain.once(channel, listener)​

  • channel 字符串
  • listener Function

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

ipcMain.addListener(channel, listener)​

  • channel 字符串
  • listener Function

ipcMain.on 的别名。

ipcMain.removeListener(channel, listener)​

  • channel 字符串
  • listener Function
    • ...args any[]

ipcMain.off 的别名。

ipcMain.removeAllListeners([channel])​

  • channel 字符串 (可选)

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

ipcMain.handle(channel, listener)​

  • channel 字符串
  • listener Function<Promise<any> | any>

添加一个可 invoke IPC 的处理程序。每当渲染进程调用 ipcRenderer.invoke(channel, ...args) 时，就会调用此处理程序。

如果 listener 返回一个 Promise，Promise 的最终结果将作为回复返回给远程调用者。否则，listener 的返回值将用作回复的值。

主进程
ipcMain.handle('my-invokable-ipc', async (event, ...args) => {
  const result = await somePromise(...args)
  return result
})
渲染进程
async () => {
  const result = await ipcRenderer.invoke('my-invokable-ipc', arg1, arg2)
  // ...
}

作为第一个参数传递给处理程序的 event 与传递给常规事件监听器的 event 相同。它包含关于哪个 WebContents 是 invoke 请求来源的信息。

主进程通过 handle 抛出的错误不是透明的，因为它们被序列化，并且只有原始错误的 message 属性提供给渲染进程。详细信息请参阅 #24427。

ipcMain.handleOnce(channel, listener)​

  • channel 字符串
  • listener Function<Promise<any> | any>

处理单个可 invoke 的 IPC 消息，然后移除监听器。参见 ipcMain.handle(channel, listener)。

ipcMain.removeHandler(channel)​

  • channel 字符串

移除 channel 的任何处理程序（如果存在）。