Channel Messaging API
Channel Messaging API 的 MessagePort 接口代表 MessageChannel 的两个端口之一,它可以让你从一个端口发送消息,并在消息到达的另一个端口监听它们。
MessagePort 是一个可转移对象。
实例方法
继承父类 EventTarget 的方法。
- MessagePort.postMessage
- : 从端口发送一条消息,并且可选是否将对象的所有权交给其他浏览器上下文。
- MessagePort.start
- : 开始发送该端口中的消息队列(仅在使用 EventTarget.addEventListener 时需要;使用 MessagePort.message_event 已隐含调用该方法)。
- MessagePort.close
- : 断开端口连接,它将不再是激活状态。
事件
继承父类 EventTarget 的事件。
- MessagePort.message_event
- : 当
MessagePort对象收到消息时触发。
- : 当
- MessagePort.messageerror_event
- : 当
MessagePort对象收到无法被反序列化的消息时触发。
- : 当
示例
在下面的示例中,你可以看到一个使用 MessageChannel.MessageChannel 构造函数创建出的新通道。
当 IFrame 加载完成后,我们给 MessageChannel.port1 注册了一个 MessagePort/message_event 回调,并且使用 window.postMessage 方法把 MessageChannel.port2 和一条消息一起传给 IFrame。
当从 IFrame 收到消息时,onMessage 函数会把消息输出到一个段落里。
const channel = new MessageChannel();
const output = document.querySelector(".output");
const iframe = document.querySelector("iframe");
// 等待 iframe 加载
iframe.addEventListener("load", onLoad);
function onLoad() {
// 监听 port1 的消息
channel.port1.onmessage = onMessage;
// 把 port2 传给 iframe
iframe.contentWindow.postMessage("Hello from the main page!", "*", [
channel.port2,
]);
}
// 处理 port1 收到的消息
function onMessage(e) {
output.innerHTML = e.data;
}
要查看可运行的完整示例,参考我们在 Github 上的 channel messaging 基础演示(也可以在线运行)。
规范
浏览器兼容性
参见
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
