最近接手的幾個專案都繞不過同一道坎:Ajax 跨域請求。基於安全考量,Firefox、Chrome 等瀏覽器(IE 是個例外)預設並不允許頁面跨來源取用資源,我在這上面折騰了好一陣子,試了無數次都以失敗告終。直到無意間讀到一篇介紹跨域資源共享(Cross-Origin Resource Sharing,CORS)的文章,問題才迎刃而解。以下把過程整理出來,順便補上另一個常用解法。
所謂跨域,就是某個站點上的資源去存取另一個網域下的資源。這種場景其實無所不在:用 <link> 載入外部樣式表、用 <img> 載入外部圖片、用 <script> 載入外部腳本,都屬於跨來源行為。而腳本在讀取文件屬性等資料時,瀏覽器預設會套用同源策略(Same origin policy)。
判定是否同源很直觀:協議、網域、連接埠三者完全相同才算同源。若兩個頁面只是子網域不同、主網域相同,還可以透過設定 document.domain 把它們「約定」成同源。
Web 2.0 與社群網站興起之後,跨域取資料的需求越來越多——分散式應用、主站與子站之間的通訊等等,但腳本層級的跨域請求始終受安全機制約束。
很多人還不知道,目前主流瀏覽器(Internet Explorer 8+、Firefox 3.5+、Safari 4+、Chrome)早已支援名為跨域資源共享的協定,可以直接完成 Ajax 跨域呼叫。對於「簡單請求」(沒有自訂標頭,方法為 GET 或 POST,主體為 text/plain),瀏覽器會額外帶上一個名為 Origin 的標頭,內容是發起請求的頁面來源(協議、網域、連接埠),伺服器因此可以輕易判斷要不要回應。
IE8 的作法略有不同,需要使用 XDomainRequest 物件:
var xdr = new XDomainRequest();
xdr.open("get", "https://www.example.net/resource/");
xdr.onload = function () {
// 在這裡處理回傳結果
};
xdr.send();
規範文件可參考 W3C 的 Access Control 相關草案。實作上分成客戶端與伺服器端兩半。
<!DOCTYPE html>
<html xmlns="https://www.w3.org/1999/xhtml">
<head>
<title>Ajax 跨域請求測試</title>
</head>
<body>
<input type="button" value="開始測試" onclick="cross_domain_request()" />
<div id="content"></div>
<script type="text/javascript">
var xhr = new XMLHttpRequest();
var url = 'https://www.example.net/resource/';
function cross_domain_request() {
document.getElementById("content").innerHTML = "開始……";
if (xhr) {
xhr.open('GET', url, true);
xhr.onreadystatechange = handler;
xhr.send();
} else {
document.getElementById("content").innerHTML = "無法建立 XMLHttpRequest";
}
}
function handler() {
if (xhr.readyState === 4) {
if (xhr.status === 200) {
document.getElementById("content").innerHTML = "結果:" + xhr.responseText;
} else {
document.getElementById("content").innerHTML = "不允許跨域請求。";
}
} else {
document.getElementById("content").innerHTML +=
"<br/>執行狀態 readyState:" + xhr.readyState;
}
}
</script>
</body>
</html>
可以直接寫在頁面上,也可以放在後端程式碼檔裡,重點是加上那個回應標頭。
<%@ Page Language="C#" %>
<script runat="server">
protected void Page_Load(object sender, EventArgs e)
{
Response.AddHeader("Access-Control-Allow-Origin", "https://www.yoursite.com:8080");
Response.Write("恭喜,你的第一個跨域測試成功啦!");
}
</script>
請求中,瀏覽器會用 Origin 標頭標示來源;回應中,伺服器則用 Access-Control-Allow-Origin 標頭決定哪些來源的腳本可以存取該資源。設成 * 代表開放給所有來源;若要指定多個來源,以逗號分隔即可。
另一個關鍵點:Access-Control-Allow-Origin 裡的連接埠號不能省略。寫成 https://www.yoursite.com 和寫成 https://www.yoursite.com:8080 是兩個不同的來源。
如果兩個頁面主網域相同、只是子網域不同,可以用設定 document.domain 的方式解決。做法是在 https://www.example.net/a.html 與 https://blogs.example.net/b.html 兩個檔案中,都加上同一行:
document.domain = 'example.net';
接著在 a.html 中建立一個隱藏的 iframe 載入 b.html,透過 contentDocument 取得對方文件,兩份 JavaScript 就能互相操作了。
// a.html
document.domain = 'example.net';
var ifr = document.createElement('iframe');
ifr.src = 'https://script.example.net/b.html';
ifr.style.display = 'none';
document.body.appendChild(ifr);
ifr.onload = function () {
var doc = ifr.contentDocument;
alert(doc.getElementsByTagName("h1")[0].childNodes[0].nodeValue);
};
// b.html
document.domain = 'example.net';
要提醒的是,這個技巧只能解決「主網域相同、子網域不同」的情況,對完全無關的網域無效。
| 情境 | 是否允許通訊 |
|---|---|
| 同網域下的不同資料夾 | 允許 |
| 同網域下的不同頁面 | 允許 |
| 同網域、不同連接埠 | 不允許 |
| 同網域、不同協議(http 與 https) | 不允許 |
| 網域與其對應 IP 互換 | 不允許 |
| 主網域相同、子網域不同 | 不允許(可用 document.domain 繞過) |
| 完全不同的網域 | 不允許 |
把伺服器端那一行標頭加上去,跨域請求就通了。相比過去那些需要權宜變通的土法子,CORS 是標準做法,也更值得推薦。