Skip to content

本文由 简悦 SimpRead 转码, 原文地址 mp.weixin.qq.com

前言

为什么会扯到这个话题,最初是源于听 https://y.qq.com/ QQ 音乐,

  • 播放器处于单独的一个页面

  • 当你在另外的一个页面搜索到你满意的歌曲的时候,点击播放或添加到播放队列

  • 你会发现,播放器页面做出了响应的响应

这里我又联想到了商城的购物车的场景,体验确实有提升。
刚开始,我怀疑的是 Web Socket 作妖,结果通过分析网络请求和看源码,并没有。最后发现是 localStore 的 storage 事件作妖,哈哈。

回归正题,其实在一般正常的知识储备的情况下,我们会想到哪些方案呢?

先抛开如下方式:

  1. 各自对服务器进行轮询或者长轮询

  2. 同源策略下,一方是另一方的 opener

演示和源码


多页面通讯的 demo, 为了正常运行,请用最新的 chrome 浏览器打开。
demo 的源码地址 [1]

  • 首页 [2]

  • setInterval + sessionStorage[3]

  • localStorage[4]

  • BroadcastChannel[5]

  • SharedWorker[6]

两个浏览器窗口间通信

WebSocket

这个没有太多解释,WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。当然是有代价的,需要服务器来支持。
js 语言,现在比较成熟稳定当然是 socket.io[7] 和 ws[8]. 也还有轻量级的 ClusterWS[9]。

你可以在 The WebSocket API (WebSockets) 看到更多的关于 Web Socket 的信息。

定时器 + 客户端存储

定时器:setTimeout/setInterval/requestAnimationFrame
客户端存储:cookie/localStorage/sessionStorage/indexDB/chrome 的 FileSystem

定时器没啥好说的,关于客户端存储。

  • cookie: 每次会带到服务端,并且能存的并不大,4kb?,记得不太清楚

  • localStorage/sessionStorage 应该是 5MB, sessionStorage 关闭浏览器就和你说拜拜。

  • indexDB 这玩意就强大了,不过读取都是异步的,还能存 Blob 文件,真的是很 high。

  • chrome 的 FileSystem ,Filesystem & FileWriter API[10], 主要是 chrome 和 opera 支持。这玩意就是文件系统。

postMessage

Cross-document messaging[11] 这玩意的支持率 98.9%。好像还能发送文件,哈哈,强大。
不过仔细一看 window.postMessage(),就注定了你首先得拿到 window 这个对象。也注定他使用的限制, 两个窗体必须建立起联系。常见建立联系的方式:

  • window.open

  • window.opener

  • iframe

提到上面的 window.open,  open 后你能获得被打开窗体的句柄,当然也可以直接操作窗体了。

到这里,我觉得一般的前端人员能想到的比较正经的方案应该是上面三种啦。
当然,我们接下来说说可能不是那么常见的另外三种方式。

StorageEvent

Page 1

localStorage.setItem('message',JSON.stringify({    message: '消息',    from: 'Page 1',    date: Date.now()}))

Page 2

window.addEventListener("storage", function(e) {    console.log(e.key, e.newValue, e.oldValue)});

如上, Page 1 设置消息, Page 2 注册 storage 事件,就能监听到数据的变化啦。

上面的 e 就是 StorageEvent[12], 有下面特有的属性(都是只读):

  • key :代表属性名发生变化. 当被 clear() 方法清除之后所有属性名变为 null

  • newValue:新添加进的值. 当被 clear() 方法执行过或者键名已被删除时值为 null

  • oldValue:原始值. 而被 clear() 方法执行过,或在设置新值之前并没有设置初始值时则返回 null

  • storageArea:被操作的 storage 对象

  • url:key 发生改变的对象所在文档的 URL 地址

Broadcast Channel

这玩意主要就是给多窗口用的,Service Woker 也可以使用。firefox,chrome, Opera 均支持,有时候真的是很讨厌 Safari,浏览器支持 77% 左右。

使用起来也很简单, 创建 BroadcastChannel, 然后监听事件。只需要注意一点,渠道名称一致就可以。
Page 1

var channel = new BroadcastChannel("channel-BroadcastChannel");    channel.postMessage('Hello, BroadcastChannel!')

Page 2

var channel = new BroadcastChannel("channel-BroadcastChannel");    channel.addEventListener("message", function(ev) {        console.log(ev.data)    });

SharedWorker

这是 Web Worker 之后出来的共享的 Worker,不同页面可以共享这个 Worker。
MDN 这里给了一个比较完整的例子 simple-shared-worker[13]。

这里来个插曲,Safari 有几个版本支持这个特性,后来又不支持啦,还是你 Safari,真是 6。

虽然,SharedWorker 本身的资源是共享的,但是要想达到多页面的互相通讯,那还是要做一些手脚的。先看看 MDN 给出的例子的 ShareWoker 本身的代码:

onconnect = function(e) {  var port = e.ports[0];  port.onmessage = function(e) {    var workerResult = 'Result: ' + (e.data[0] * e.data[1]);    port.postMessage(workerResult);  }}

上面的代码其实很简单,port 是关键,这个 port 就是和各个页面通讯的主宰者,既然 SharedWorker 资源是共享的,那好办,把 port 存起来就是啦。
看一下,如下改造的代码:
SharedWorker 就成为一个纯粹的订阅发布者啦,哈哈。

var portList = [];onconnect = function(e) {  var port = e.ports[0];  ensurePorts(port);  port.onmessage = function(e) {    var data = e.data;    disptach(port, data);  };  port.start();};function ensurePorts(port) {  if (portList.indexOf(port) < 0) {    portList.push(port);  }}function disptach(selfPort, data) {  portList    .filter(port => selfPort !== port)    .forEach(port => port.postMessage(data));}

MessageChannel[14]

Channel Messaging API 的 MessageChannel 接口允许我们创建一个新的消息通道,并通过它的两个 MessagePort[15] 属性发送数据。

其需要先通过 postMessage 先建立联系。

MessageChannel 的基本使用:

var channel = new MessageChannel();var para = document.querySelector('p');var ifr = document.querySelector('iframe');var otherWindow = ifr.contentWindow;ifr.addEventListener("load", iframeLoaded, false);function iframeLoaded() {  otherWindow.postMessage('Hello from the main page!', '*', [channel.port2]);}channel.port1.onmessage = handleMessage;function handleMessage(e) {  para.innerHTML = e.data;}

至于在线的例子,MDN 官方有一个版本 MessageChannel 通讯 [16]

引用

MDN Web Docs - Broadcast Channel[17]
BroadcastChannel | Can I Use[18]
broadcast-channel[19]
StorageEvent[20]
SharedWorker[21]
simple-shared-worker[22]
SharedWorker | Can I Use[23]
共享线程 SharedWorker[24]
feature-shared-web-workers[25] 两个浏览器窗口间通信总结 [26]

参考资料

[1]

demo 的源码地址: _https://github.com/xiangwenhu/page-communication/tree/master/docs_

[2]

首页: _https://xiangwenhu.github.io/page-communication/_

[3]

setInterval + sessionStorage: _https://xiangwenhu.github.io/page-communication/setInterval/index.html_

[4]

localStorage: _https://xiangwenhu.github.io/page-communication/localStorage/index.html_

[5]

BroadcastChannel: _https://xiangwenhu.github.io/page-communication/BroadcastChannel/index.html_

[6]

SharedWorker: _https://xiangwenhu.github.io/page-communication/SharedWorker/index.html_

[7]

socket.io: _https://github.com/socketio/socket.io_

[8]

ws: _https://github.com/websockets/ws_

[9]

ClusterWS: _https://github.com/ClusterWS/ClusterWS_

[10]

Filesystem & FileWriter API: _https://caniuse.com/#search=fileSystem_

[11]

Cross-document messaging: _https://caniuse.com/#search=postMessage_

[12]

StorageEvent: _https://developer.mozilla.org/en-US/docs/Web/API/StorageEvent_

[13]

simple-shared-worker: _https://github.com/mdn/simple-shared-worker_

[14]

MessageChannel: _https://developer.mozilla.org/zh-CN/docs/Web/API/MessageChannel_

[15]

MessagePort: _https://developer.mozilla.org/zh-CN/docs/Web/API/MessagePort_

[16]

MessageChannel 通讯: _https://mdn.github.io/dom-examples/channel-messaging-basic/_

[17]

MDN Web Docs - Broadcast Channel: _https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel_

[18]

BroadcastChannel | Can I Use: _https://caniuse.com/#search=BroadcastChannel_

[19]

broadcast-channel: _https://github.com/pubkey/broadcast-channel_

[20]

StorageEvent: _https://developer.mozilla.org/en-US/docs/Web/API/StorageEvent_

[21]

SharedWorker: _https://developer.mozilla.org/en-US/docs/Web/API/SharedWorker_

[22]

simple-shared-worker: _https://github.com/mdn/simple-shared-worker/blob/gh-pages/worker.js_

[23]

SharedWorker | Can I Use: _https://caniuse.com/#search=SharedWorker_

[24]

共享线程 SharedWorker: _https://blog.csdn.net/qq_38177681/article/details/82048895_

[25]

feature-shared-web-workers: _https://webkit.org/status/#feature-shared-web-workers_

[26]

两个浏览器窗口间通信总结: _https://segmentfault.com/a/1190000016927268_