JavaScript 有一項重要的安全性限制,稱為「同源策略」(Same-Origin Policy),它限制 JavaScript 只能存取與包含它的文件在同一域下的內容。這在多 iframe、多視窗以及 Ajax 編程時尤其重要。然而,深入前端開發時難免需要跨域操作,JSONP 便是常用的解決方案。本文將剖析其原理。
根據同源策略,在 example.com 下的頁面所包含的 JavaScript 程式碼,不能存取另一個域名下的頁面內容;甚至不同子域名之間也無法互相存取。對於 Ajax 而言,透過 XMLHttpRequest 實現的請求不能向不同的域提交。
利用在頁面中建立 <script> 節點向不同域提交 HTTP 請求的方法稱為 JSONP,可解決跨域提交 Ajax 請求的問題。原理是:假設在 example1.com 的頁面中向 example2.com 提交 GET 請求,可以動態建立一個 script 標籤:
var eleScript = document.createElement("script");
eleScript.type = "text/javascript";
eleScript.src = "https://example2.com/getinfo.php";
document.getElementsByTagName("HEAD")[0].appendChild(eleScript);
當請求從 example2.com 返回時,會回傳一段 JavaScript 程式碼並自動執行,用以呼叫 example1.com 頁面中的 callback 函數。
優點:不像 XMLHttpRequest 受同源策略限制;相容性更好,可在更古老的瀏覽器運行,不需 XMLHttpRequest 或 ActiveX 支援;請求完畢後可透過 callback 回傳結果。
缺點:只支援 GET 請求而不支援 POST 等其他類型;只能解決跨域 HTTP 請求,無法解決不同域兩個頁面間的 JavaScript 呼叫問題。
使用 $.ajax 並指定 dataType 為 'jsonp':
var qsData = {'searchWord': $("#searchWord").attr("value"),
'currentUserId': $("#currentUserId").attr("value"),
'conditionBean.pageSize': $("#pageSize").attr("value")};
$.ajax({
async: false,
url: https://跨域的dns/document!searchJSONResult.action,
type: "GET",
dataType: 'jsonp',
jsonp: 'jsoncallback',
data: qsData,
timeout: 5000,
success: function (json) { // 成功取得跨域 json 資料後動態執行 callback
if(json.actionErrors.length != 0){
alert(json.actionErrors);
}
genDynamicContent(qsData, type, json);
},
complete: function(XMLHttpRequest, textStatus){
$.unblockUI({ fadeOut: 10 });
}
});
也可看到這種更簡潔的寫法,其實是 $.ajax 的高級封裝:
$.getJSON("https://跨域的dns/document!searchJSONResult.action?name1=" + value1 + "&jsoncallback=?",
function(json){
if(json.屬性名 == 值){
// 執行程式碼
}
});
JSONP 最基本的原理是:動態添加一個 <script> 標籤,而 script 標籤的 src 屬性沒有跨域限制,因此這種方式與 Ajax 的 XMLHttpRequest 協議其實無關。JSONP 即 JSON with Padding,它允許伺服器端整合 Script tags 回傳至客戶端,透過 JavaScript callback 的形式實現跨域存取。
執行步驟如下:
jsonp1236827957501(...) 把要輸出的 json 內容包起來,並以 JavaScript 語法生成一個 function,函數名就是傳來的參數值。可以說 JSONP 的原理與 <script src="https://跨域/...xx.js"></script> 一致。JSONP 是一種腳本注入(Script Injection)行為,因此存在一定的安全隱患,使用時需謹慎評估來源可信度。
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml" >
<head>
<title>Test Jsonp</title>
<script type="text/javascript">
function jsonpCallback(result) {
alert(result.msg);
}
</script>
<script type="text/javascript" src="https://crossdomain.com/jsonServerResponse?jsonp=jsonpCallback"></script>
</head>
<body>
</body>
</html>
其中 jsonCallback 是客戶端註冊的、取得跨域資料後回調的函數;跨域伺服器介面參數為回調函數名,回傳格式為 jsonpCallback({msg:'this is json data'})。瀏覽器解析 script 標籤並執行返回的程式碼,資料便作為參數傳入了預先定義好的 callback 函數,从而实现跨域資料交換。