這個題目看似已經被寫爛了。當代 Web 應用幾乎離不開跨域請求,Google 與 Facebook 用 iframe 實作 Comet 時也把能用的手法都試過一遍,社群裡早該累積出一套最佳實踐。不過看到愈來愈多前端部落格重新討論這件事,我覺得還是有必要把思路整理一次。
先談跨域的本質。iframe 裡的 JS 一樣逃不掉同源策略,它只能解決同主網域下子網域的問題,例如 www.site.com 與 so.site.com。若要請求一個毫不相干的網域(比如做 mashup),最老實也最可靠的方式仍是用 script 標籤請求 JSONP。
JSONP 這裡有個值得學習的封裝範例,jQuery 的寫法:
$.getJSON(url, params + "&jsoncallback=?", function(json){
/* do something */
});
它以 jsoncallback 作為伺服器端支援的標準參數名,每次呼叫會用時間戳產生一個唯一的全域函式名稱去替換那個「?」,這個細節被藏進黑盒,使用者不必知道,介面看起來就和普通 AJAX 請求一樣——最後一個參數放匿名回呼函式。這種語法糖不只是讓開發者偷懶,它對可讀性、相容性與後續維護都有實質好處。這也是我常得向後端同事解釋的事:否則對方往往只丟回一個寫死函式名的回應就宣稱完成。
還有一些當時看來比較「野」的路子:在頁面裡嵌一個不到 1KB 的 SWF,透過 Flash Player 向設定了 crossdomain.xml 的伺服器取資料,再用 ActionScript 的 ExternalInterface 把結果交回 JavaScript——寫起來頗有幾分呼叫 DLL 的感覺。
標準面的進展也值得期待:IE8 的 XDomainRequest、Firefox 3.1 的 Access Control,以及傳說中的 HTML5 socket。
iframe 也能取代 AJAX。在把 document.domain 設為共同主網域之後(例如都設為 site.com),還能解決部分跨域問題。最直接的做法是動態插入一個隱藏的 iframe,用 src 直接指向含資料的網址,再讓該頁的 JS 把資料回傳給父頁:
<iframe id="crossdomain" width="0" height="0"
style="visibility:hidden;"
src="https://yoursite.com/request_url/"></iframe>
但這種寫法耦合太緊,我不建議採用。請求的 URI 代表一項資源,它應該是單純的資料;至於要用 XML、JSON、JS 還是 HTML 來承載,不該改變資源本身的性質,也不該因為跨不跨域、用 iframe 還是 AJAX 就長成完全不同的樣子。
有人會說:為了讓 JS 能處理,回應內容難免有差異。差異確實存在,但小差異可以用合理封裝吸收掉,jQuery 的 getJSON 就是例子。
也有人主張:既然請求的是動態頁面,在 URI 上支援類似 jsoncallback 的參數,回傳一段包裹資料的 script 就好:
<script type="text/javascript">
document.domain = "site.com";
top.cb1304344({ /* 資料 */ });
</script>
問題有兩個。其一,高流量環境下你拿到的往往是 Squid 這類快取伺服器回傳的內容,未必是即時生成的動態頁。其二,若請求的是 HTML 文字,要當 JS 執行就得在伺服器端做轉義與清理,而 HTML 常夾帶使用者生成的內容,安全性沒有保證;若本來就是 JSON,那又何必繞道 iframe,直接嵌 script 就好。
我偏好在上一段的基礎上改良:伺服器端直接回傳資料本身,並用 textarea 包裹:
<textarea><div><p>yyyyy</p></div></textarea>
textarea 的優點是內容格式不受限,而且不會在 iframe 子頁中被解析——不會建立 DOM 樹,也不會執行 JS。前端要做的,只是在父頁取得子頁的 DOM,把 textarea 的內容取出(注意要取 value,不是 innerHTML)。
接著是「如何知道 iframe 載入完成」。可以在標籤上掛 onload,但那需要顯式呼叫函式。另一種作法是輪詢,靠 try/catch 判斷能否讀到內容:
(function(){
try{
callback(document.getElementById('crossdomain')
.contentWindow.document.body
.getElementsByTagName("TEXTAREA")[0].value);
}catch(e){
setTimeout(arguments.callee, 0);
return;
}
})();
封裝成一個方法之後就相當像標準 API 了:
window.TUI = window.$ = {};
/**
* 透過 iframe 異步請求資料
* @param {string} url 請求位址
* @param {function} cb 處理回傳資料的回呼函式
*/
TUI.getIframeData = function(url, cb){
var f = document.getElementById('crossdomain');
if(f){
f.src = url;
}else{
var t = document.createElement("DIV");
t.innerHTML = '<iframe id="crossdomain" width="0" height="0"'
+ ' style="visibility:hidden;" src="' + url + '"></iframe>';
document.body.appendChild(t.firstChild);
}
(function(){
try{
cb(document.getElementById('crossdomain').contentWindow
.document.body.getElementsByTagName("TEXTAREA")[0].value);
}catch(e){
setTimeout(arguments.callee, 0);
return;
}
})();
};
// 使用方式
$.getIframeData("https://yoursite.com/request_url/", function(data){
/* do something */
});
再加一個可選的參數物件,這就是很標準的 AJAX 介面。也可以在 $.get 之上包一層跨域判斷:當同一支 URI 換成同網域時自動切回普通 AJAX,並用類似 /<(textarea)>(.+)<\/(textarea)>/ 的正則清掉多餘標籤再交給回呼函式,前端與後端都不用改程式碼。
IE 下用 iframe 取資料會出現兩個被 Alex Russell 戲稱為「靈異點擊」(phantom click)與「噩夢般的指示器」(throbber of doom)的現象:前者是在 iframe 載入時發出一次點擊音效,讓人以為電腦鬧鬼;後者是載入過程中 IE 介面會顯示讀取提示,例如左下角進度條、右上角圖示。以我個人的標準,這兩個問題都能接受。另一個更實際的限制是:這個方法只支援 GET。
還有一種用法能同時避開上述問題,而且不需要後端做任何調整:在 iframe 的 src 裡載入一個含 AJAX 方法的頁面,然後由父頁呼叫該方法,發出與子頁同網域的請求。
土豆網的播放頁就是用這個方式抓評論。播放頁:
https://www.tudou.com/programs/view/iPcprDz_LhI/
評論 HTML 的介面大致如下:
https://comments.site.com/itemcomment.srv?method=get&iid=21283123&page=1
這個介面部署在獨立的一組伺服器上,播放頁、豆單播放頁、豆單封面、相簿與個人首頁都會呼叫它。由於內容包含大量使用者提交資料與複雜的 HTML 結構,改用 JSON 反而前後端都難處理;而新增、回覆、刪除等操作顯然需要 POST。在這種需求下,iframe 搭配 AJAX 剛好合適。
首先在 comments.site.com 下部署一個供 iframe 呼叫的跨域頁:
https://comments.site.com/crossdomain/index.html
它的原始碼裡只有一個獨立版本的 AJAX 方法,覺得很眼熟沒錯——就是在 jQuery 原始碼基礎上裁剪而來,只保留最基本的功能。這個頁面可以設定很長的快取過期時間,因為它不會再變動。
父頁則透過統一介面提供操作,其中呼叫跨域方法的關鍵片段如下:
(function(){
try{
$('#crossdomain')[0].contentWindow.TUI.ajax(o);
}catch(e){
setTimeout(arguments.callee, 500);
return;
}
})();
iframe 適用的條件可以寫成一個簡單的判斷式:跨域,且(回傳大量資料 或 回傳 HTML 內容 或 需要送出 POST)。除此之外,Comet 中的串流技術也是 iframe 的經典場景,本文不談。
使用時務必守住兩點:保持資源的純粹性,以及把與其他異步請求差異過大或屬於 hack 的細節(嵌入 iframe、觸發回呼、處理資料)藏起來,對外只暴露一致、相容性與擴展性良好、且不礙眼的介面。
最後補充一個跨域相關的坑:修改 document.domain 可能引發意料之外的問題,例如在 Firefox 中,document.styleSheets 的 cssRules 屬性會被拒絕存取。