許多開發者習慣用 jQuery 在前后端之間做資料交換,也因此容易誤以為前端能讀取任何站點的資料。本文說明瀏覽器同源政策的限制,並完整示範 $.ajax(JSONP)與 getJSON 兩種跨域取資料的實作與原理。
跨域安全限制是針對「瀏覽器端」而言,伺服器端並沒有這個問題。當你要直接從 HTML 讀取第三方站點的資料時,就會撞上瀏覽器的同源政策。
這其實是利用 JSONP(JSON with Padding)來實現。它允許伺服器動態產生 script 標籤回傳給客戶端,透過 JavaScript callback 的形式完成資料讀取:
jQuery(document).ready(function () {
$.ajax({
type: "get", // jQuery 不支援 POST 跨域
async: false,
url: "https://api.taobao.com/apitools/ajax_props.do",
dataType: "jsonp",
jsonp: "jsoncallback", // 傳給伺服器的 callback 參數名
jsonpCallback: "success_jsonpCallback", // 自訂回呼函式名稱
success: function (json) {
alert(json);
}
});
});
很多人以為只要前端用 JSONP 就能跨域,其實伺服器端也必須配合。以 Java 為例:
public void jsonpTest() throws IOException {
HttpServletRequest request = ServletActionContext.getRequest();
HttpServletResponse response = ServletActionContext.getResponse();
// 取得前端指定的回呼函式名稱,這裡是 success_jsonpCallback
String callbackName = (String) request.getAttribute("jsoncallback");
// 組出 JSON 字串
String jsonStr = "{\"name\":\"張三\",\"age\":28}";
// 最終輸出:success_jsonpCallback({"name":"張三","age":28})
String renderStr = callbackName + "(" + jsonStr + ")";
response.setContentType("text/plain;charset=UTF-8");
response.getWriter().write(renderStr);
}
首先在客戶端註冊一個 callback,把它的名字傳給伺服器;伺服器先產生要回傳的 JSON,再以 JavaScript 語法把這段 JSON 當參數、包進一個以 callback 名稱命名的函式中;最後把這段「函式呼叫」回傳給客戶端。瀏覽器解析 script 標籤時,就會執行該函式,把資料交給預先定義好的 callback。跨域之所以能成立,正是因為動態加入的 script 不受同源政策限制。
getJSON 的原理與 ajax+JSONP 完全相同,只是寫法更簡潔。它的函式原型是:
jQuery.getJSON(url, data, success(data, status, xhr))
它其實是 ajax 的簡寫,等價於:
$.ajax({
url: url,
data: data,
success: callback,
dataType: "json"
});
跨域使用時,只要在 URL 後面加上 jsoncallback=?:
$.getJSON("https://api.taobao.com/apitools/ajax_props.do&jsoncallback=?",
function (data) {
alert(data);
});
jQuery 會自動把問號替換成生成的回呼函式名稱,最終實際請求就變成 ...&jsoncallback=jsonp1322444422697。
歸根究柢,getJSON 與 ajax+JSONP 的底層原理一致,唯一差別是 callback 函式名稱:一個由 jQuery 自動生成,一個由你手工指定。理解了 JSONP 的運作方式,這兩種跨域寫法你就能融會貫通。