---
title: Channel Messaging API
slug: Web/API/Channel_Messaging_API
translation_of: Web/API/Channel_Messaging_API
---
<p>{{DefaultAPISidebar("Channel Messaging API")}}</p>

<p class="summary"><strong>Channel Messaging API </strong>允许两个不同的脚本运行在同一个文档的不同浏览器上下文（比如两个 iframe，或者文档主体和一个 iframe，使用 {{domxref("SharedWorker")}} 的两个文档，或者两个 worker）来直接通讯，在每端使用一个端口（port）通过双向频道（channel）向彼此传递消息。</p>

<p>{{AvailableInWorkers}}</p>

<h2 id="Channel_通信的概念和用法">Channel 通信的概念和用法</h2>

<p>使用 {{domxref("MessageChannel.MessageChannel", "MessageChannel()")}} 构造函数来创建通讯信道。一旦创建，信道的两个端口即可通过 {{domxref("MessageChannel.port1")}} 和 {{domxref("MessageChannel.port2")}} 属性进行访问（都会返回 {{domxref("MessagePort")}}  对象）。创建信道的应用程序使用 <code>port1</code>，在另一端的程序使用 <code>port2</code> —— 你向 <code>port2</code> 发送信息，然后携带 2 个参数（需要传递的消息，要传递所有权的对象，在这里是 port 自身）调用 {{domxref("window.postMessage")}} 方法将端口信息传递到另一个浏览器上下文。</p>

<p>当这些可传递的对象被传递后，他们就从之前所属的上下文中消失了。比如一个 port，一旦被发送，在原本的上下文中就再也不可用了。注意当前仅有 {{domxref("ArrayBuffer")}} 和 {{domxref("MessagePort")}} 对象可以被发送。</p>

<p>另一个浏览器上下文可以使用 {{domxref("MessagePort.onmessage")}} 监听信息，并使用事件的 <code>data</code> 属性获取消息内容。你可以通过 {{domxref("MessagePort.postMessage")}} 向原来的文档发送应答消息。</p>

<p>当你想要停止通过信道发送消息时，你可以调用来关闭 {{domxref("MessagePort.close")}} 端口。</p>

<p>更多使用这个 API 的资料参见：<a href="/en-US/docs/Web/API/Channel_Messaging_API/Using_channel_messaging">Using channel messaging</a> 。</p>

<h2 id="Channel_通信接口">Channel 通信接口</h2>

<dl>
 <dt>{{domxref("MessageChannel")}}</dt>
 <dd>创建一个新的发送消息的信道。</dd>
 <dt>{{domxref("MessagePort")}}</dt>
 <dd>控制消息信道的端口，允许从一个端口发送消息，并监听另一端消息的到来。</dd>
 <dt>{{domxref("PortCollection")}}</dt>
 <dd><code>MessagePort</code> 数组，一种同时向多个端口广播消息的实验性解决方案。</dd>
</dl>

<h2 id="例子">例子</h2>

<ul>
 <li>我们在 Github 上发布了 <a href="https://github.com/mdn/dom-examples/tree/master/channel-messaging-basic">channel messaging basic demo</a>，在<a href="http://mdn.github.io/dom-examples/channel-messaging-basic/">这里</a>直接尝试。这个例子展示了一次页面和嵌入 {{htmlelement("iframe")}} 间的真实而简易的消息传递。</li>
 <li>你也可以参考 <a href="https://github.com/mdn/dom-examples/tree/master/channel-messaging-multimessage">多个消息 demo</a> (<a href="http://mdn.github.io/dom-examples/channel-messaging-multimessage/">在线演示</a>)。这个例子展示了稍微复杂些的设置，可以在主页面和 IFrame 之间传递多条消息。</li>
</ul>

<h2 id="规格">规格</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">规格</th>
   <th scope="col">状态</th>
   <th scope="col">补充</th>
  </tr>
  <tr>
   <td>{{SpecName('HTML WHATWG', 'web-messaging.html#channel-messaging', 'Channel messaging')}}</td>
   <td>{{Spec2('HTML WHATWG')}}</td>
   <td> </td>
  </tr>
 </tbody>
</table>

<h2 id="浏览器兼容性">浏览器兼容性</h2>

<div>
<h3 id="MessageChannel"><code>MessageChannel</code></h3>

<div>


<p>{{Compat("api.MessageChannel", 0)}}</p>

<h3 id="MessagePort"><code>MessagePort</code></h3>

<div>
<div class="hidden">The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</div>

<p>{{Compat("api.MessagePort", 0)}}</p>
</div>
</div>
</div>

<h2 id="参考">参考</h2>

<ul>
 <li><a href="/en-US/docs/Web/API/Channel_Messaging_API/Using_channel_messaging">Using channel messaging</a></li>
 <li><a href="/en-US/docs/Web/API/Web_Workers_API">Web Workers API</a></li>
 <li><a href="/en-US/docs/Web/API/Broadcast_Channel_API">Broadcast Channel API</a></li>
</ul>

<p>
 <audio class="hidden"> </audio>
</p>