HTML5 的 window.postMessage 至今仍不算普及,但它解決的是一個很實際的問題:讓不同來源的 window 與 iframe 之間安全地傳遞資料。
實質上,它扮演了一個「不需要遠端伺服器參與的跨域 Ajax」角色。以下說明運作方式,以及在 Firefox、IE8+、Opera、Safari 與 Chrome 中的用法。
第一步是取得「訊息來源」,也就是目標 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);
// 第二個參數必須是符合目標頁面的 origin
myPopup.postMessage(message, domain);
}, 6 * 1000);
// 跨瀏覽器綁定事件
function bindEvent(target, eventName, handler){
if (window.addEventListener) {
target.addEventListener(eventName, handler);
} else if (window.attachEvent) {
target.attachEvent("on" + eventName, handler); // 舊版 IE
} else {
target["on" + eventName] = handler;
}
}
// 監聽回覆
bindEvent(window, 'message', function(event) {
// 只接受特定來源的訊息
if (event.origin !== 'https://scriptandstyle.com') return;
trace('收到的回覆: ', event.data);
}, false);
原文直接用 window.addEventListener,在舊版 IE 上會出錯(要用 attachEvent),所以才包了一層 bindEvent。當然,用 MooTools、jQuery 或 dojo 這類函式庫的事件 API 也可以。
如果目標是 iframe,寫法幾乎一樣,重點是要取 contentWindow,而不是 iframe 元素本身:
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);
第二步是讓目標 window 準備好聆聽。它需要監聽 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 —— 傳送訊息的 window / iframe 物件,可用來回覆origin —— 對應傳送方視窗的 origin(protocol、domain、port)data —— 實際傳送的資料這三者構成了一套基本的訊息系統與驗證機制,缺一不可。
和所有 Web 技術一樣,用不當就有風險,而這裡的風險幾乎全來自沒有驗證訊息來源。
請記住三條原則:
event.origin,只處理白名單內的來源。任何頁面都能對你的 window 送訊息,少了這一步等於門戶洞開。postMessage(data, "*") 是最常見的疏漏,那樣等於把資料交給任何恰好載入在該視窗裡的頁面。現代瀏覽器已可直接傳遞物件而不必自己序列化,但即便如此,跨來源傳來的內容仍應視為不可信輸入,需要照一般規則做驗證與轉義。
這是個很酷的技術,用得好能讓嵌入頁面、第三方小工具、跨域 iframe 整合都乾淨不少。你覺得呢?