README_zh.md

electron-message-center

一个易于使用的 npm 包，用于简化 Electron 应用程序中的进程间通信。支持跨窗口通信和其他高级消息功能。

安装

首先，从 NPM 安装它：

npm install --save electron-message-center

其次，必须在主进程中初始化 electron-message-center：

require('electron-message-center/main');

广播

通过route向主进程或渲染进程中的所有监听器发送消息。

监听器应使用messageCenter.on()监听通道。

// 在第一个渲染进程中监听
import { messageCenter } from 'electron-message-center';
messageCenter.on('writeSettingsFile', (event, newSettings) => {
  console.log(newSettings);
});

// 在第二个渲染进程中监听
import { messageCenter } from 'electron-message-center';
messageCenter.on('writeSettingsFile', (event, newSettings) => {
  console.log(newSettings);
});

// 在主进程中监听
import { messageCenter } from 'electron-message-center/main';
messageCenter.on('writeSettingsFile', (event, newSettings) => {
  console.log(newSettings);
});

// 在渲染进程中广播
import { messageCenter } from 'electron-message-center';
messageCenter.broadcast('writeSettingsFile', '{ "name": "Jeff" }');

// 在主进程中广播
import { messageCenter } from 'electron-message-center/main';
messageCenter.broadcast('writeSettingsFile', '{ "name": "Jeff" }');

invoke

通过route向主进程或渲染进程发送消息，并异步地期望结果。

监听器应使用messageCenter.on()监听通道。

// 在渲染进程中监听
import { messageCenter } from 'electron-message-center';
messageCenter.on('writeSettingsFile', (event, newSettings) => {
  console.log(newSettings);
  return Promise.resolve(true);
});

// 在渲染进程中调用
import { messageCenter } from 'electron-message-center';
const ret = await messageCenter.invoke('writeSettingsFile', '{ "name": "Jeff" }');
console.log(ret); // true

// 在主进程中调用
import { messageCenter } from 'electron-message-center/main';
const ret = await messageCenter.invoke('writeSettingsFile', '{ "name": "Jeff" }');
console.log(ret); // true

预加载

从 Electron 5.0 开始，默认情况下禁用nodeIntegration。这意味着您无法直接导入electron-message-center。相反，您需要在打开BrowserWindow时使用preload脚本。即使禁用了nodeIntegration，预加载脚本也可以访问内置函数，例如require。

// main.js
const mainWindow = new BrowserWindow({
  webPreferences: {
    preload: path.join(__dirname, 'preload.js'),
    sandbox: false,
    contextIsolation: false,
  },
  maximize: true,
});

// preload.js
const { messageCenter } = require('electron-message-center');

window.messageCenter = messageCenter;

// 在网页中

messageCenter.on('a', (event, ...args) => {
  console.log('a', ...args);
});
function send() {
  messageCenter.broadcast('a', 1, null, { a: 1 });
}

高级用法

调用指定 WebContents

默认情况下，invoke 方法会将消息发送到它找到的第一个监听器。如果您想指定一个特定的进程来接收消息，可以设置webContents ID：

// 在渲染进程中调用
import { MessageCenter } from 'electron-message-center';

const messageCenter = new MessageCenter({ webContentsId: 1 });
const ret = await messageCenter.invoke('writeSettingsFile', '{ "name": "Jeff" }');

// 或者广播
messageCenter.broadcast('writeSettingsFile', '{ "name": "Jeff" }');

console.log(ret); // true

// 在渲染进程中监听
import { messageCenter } from 'electron-message-center';
messageCenter.on('writeSettingsFile', (event, newSettings) => {
  console.log(newSettings);
  return Promise.resolve(true);
});

超时

默认情况下，invoke 方法将无限期等待其他进程返回数据。如果您想设置超时（超时后，Promise 将自动拒绝），可以创建另一个 MessageCenter 实例：

// 在渲染进程中调用
import { MessageCenter } from 'electron-message-center';

const messageCenter = new MessageCenter({ timeout: 2000 });
try {
  await messageCenter.invoke('writeSettingsFile', '{ "name": "Jeff" }');
} catch (e) {
  console.error(e);
}

// 在渲染进程中监听
import { messageCenter } from 'electron-message-center';
messageCenter.on('writeSettingsFile', (event, newSettings) => {
  return someOperationThatNeverCompletesUhOh();
});

删除监听器

您可以使用 off() 方法删除监听器。

// 在渲染进程中
import { messageCenter } from 'electron-message-center';

messageCenter.off('someRoute'); // 不再监听

// 在主进程中
import { messageCenter } from 'electron-message-center/main';

messageCenter.off('someRoute'); // 不再监听

示例

• example

注意

参数将使用结构化克隆算法进行序列化，就像window.postMessage一样，因此原型链不会包含在内。发送函数、Promise、Symbol、WeakMap 或 WeakSet 将引发异常。

许可证

MIT