window.postMessage 允許在多個 window/frame 之間跨域傳遞資料和資訊。本文將為大家介紹它的工作原理,以及在 FireFox、IE8+、Opera、Safari 和 Chrome 中如何使用。
我寫了一個 MooTools 插件「PostMessager」來封裝 window.postMessage,有興趣的可以自行查找下載。
HTML5 的 window.postMessage 介面 API 還沒有多少人深入了解。它允許在多個 window/frame 之間跨域傳遞資料,實質上扮演了一個跨域 Ajax 請求的角色,只是不需要遠端伺服器來協作。接下來我們看看它的工作原理與具體用法。
整個流程的第一步,是設定一個「消息源」。透過這個消息源,我們可以往新開啟的 window(或 iframe)發送 window 級別的資料(消息)。下面的示例中,每 6 秒向新視窗發送一次消息,並註冊事件監聽來處理目標視窗返回的回應。
function trace(message){
var infos = Array.prototype.slice.call(arguments,0).join(" ");
if("console" in window){
console.log(infos);
} else {
alert(infos);
}
};
// 創建彈出窗口
var domain = 'https://scriptandstyle.com';
var myPopup = window.open(domain + '/windowPostMessageListener.html','myWindow');
// 定時發送消息
setInterval(function(){
var message = '現在時間: ' + (new Date().getTime());
trace('數據源.發送的消息: ' + message);
myPopup.postMessage(message,domain); //發送數據,並設置目標 URI
},6*1000);
function bindEvent(target,noOnEventName,handler){
if(window.addEventListener){
target.addEventListener(noOnEventName,handler);
} else if(window.attachEvent){
// IE 的監聽設置函數是 attachEvent
target.attachEvent("on"+noOnEventName,handler);
} else {
target["on"+noOnEventName]=handler;
}
};
// 監聽收到的信息
bindEvent(window,'message',function(event) {
// 只接收特定域的消息
if(event.origin !== 'https://scriptandstyle.com') return;
trace('收到的響應信息: ',event.data);
},false);
原文作者使用的是 window.addEventListener 來綁定事件,但在 IE 下會報錯(IE 用的是 window.attachEvent)。你可以自行封裝一個事件綁定函數,或者直接用 MooTools、jQuery、dojo 這類現成的類庫來處理。
在上面這個示例中,如果新視窗正常開啟,我們就能透過 window 對象的引用 myPopup 發送消息,並指定必須匹配的 URI(協議、主機名、端口號)。也就是說,如果用戶在子視窗中跳到其他頁面,消息就不會發送出去。
同樣,我們也綁定了 message 事件處理函數來接收消息。這裡要特別強調:校驗 message 事件的 origin(源)屬性非常重要,因為它可能收到任何 URI 發來的消息,只有做我校驗,在多個 frame 交互時才不至於混淆。校驗過 origin 之後,如何處理消息就取決於具體業務需求了。
如果使用 iframe,程式碼如下:
// 取得 iframe 的 contentWindow
var domain = 'https://scriptandstyle.com';
var iframe = document.getElementById('myIFrame').contentWindow;
// 循環發送消息
setInterval(function(){
var message = '現在時間: ' + (new Date().getTime());
trace('數據源.發送的消息: ' + message);
iframe.postMessage(message,domain);
},6*1000);
這裡要注意,必須能存取到 iframe 對象的 contentWindow 屬性,而不僅僅是 iframe 對象本身。
流程的第二步是讓目標 window 就緒。目的視窗要做的,就是監聽 message 事件,同時驗證事件的 origin 消息源。再次提醒:message 事件處理函數可以接受任何域名發來的消息,所以驗證 origin、只處理信任清單中的消息非常重要。
// 監聽收到的信息
bindEvent(window,'message',function(event) {
// 只接收特定域的消息
if(event.origin !== 'https://davidwalsh.name') return;
trace('監聽到信息: ',event.data);
// 回復消息
event.source.postMessage("你好,小伙伴們,我已經收到消息了",event.origin);
},false);
上面的示例把回應信息回覆給了請求方。message 事件有三個重要屬性:
source:發送 message 的 window/iframe 對象。
origin:對應發送消息 window 的 URI(協議、域名和端口,若有指定)。
data:具體的資料內容。
對於消息系統與校驗來說,這三個屬性是必不可少的。
和其他所有 Web 技術一樣,如果使用不當(比如沒有驗證事件源),安全風險顯而易見。安全性需要你自己來把關。window.postMessage 是一項相當實用又強大的技術,善用它能讓跨窗口、跨 iframe 的溝通變得非常便捷。