很多開發者習慣用 jQuery 在前后端之間取資料,久而久之容易以為「前端就能讀取任何網站的資料」。最近因為要與第三方公司共享資料,又不想多佔伺服器資源,於是決定直接在 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", // 跨域請求的 URL
dataType: "jsonp",
jsonp: "jsoncallback", // 傳給後端、用來指定回調函式名稱的參數名(預設為 callback)
jsonpCallback: "success_jsonpCallback", // 自訂回調函式名稱(預設由 jQuery 隨機產生)
success: function (json) {
alert(json);
}
});
});
後端(以 Java 為例):
public void jsonpTest() throws IOException {
HttpServletRequest request = ServletActionContext.getRequest();
HttpServletResponse response = ServletActionContext.getResponse();
// 取得前端指定的回調函式名稱,本例為 success_jsonpCallback
String callbackName = (String) request.getAttribute("jsoncallback");
// 組出要回傳的 JSON 字串(實務上可用 Gson 等工具序列化物件)
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);
}
要注意的是:這件事必須後端配合才行。很多人以為前端改成 jsonp 就能直接跨域,其實不然——後端得願意把資料包成回調形式。
jsoncallback),並把回調函式名稱(如 success_jsonpCallback)傳給伺服器。也就是說,跨域是透過動態增加 script 來載入資料,無法像 XHR 那樣直接取得回應物件,所以必須靠回調函式把資料「遞」回來。
getJSON 的原理與上述 jsonp 模式完全相同,只是寫法更短。它的函式原型是:
jQuery.getJSON(url, data, success(data, status, xhr))
url(必要):請求的位址。data(選填):一同送出的資料。success(選填):請求成功時執行的函式,可取得 response(結果資料)、status(請求狀態)、xhr(XMLHttpRequest 物件)。它其實是 ajax 的語法糖,等價於:
$.ajax({
url: url,
data: data,
success: callback,
dataType: "json"
});
使用方式:
$.getJSON("https://api.taobao.com/apitools/ajax_props.do?jsoncallback=?",
function (data) {
alert(data);
}
);
執行原理一樣:送出請求時帶一個 jsoncallback=? 參數,jQuery 會把問號自動替換成產生的回調函式名稱,實際請求可能長得像:
https://api.taobao.com/apitools/ajax_props.do?jsoncallback=jsonp1322444422697
與 $.ajax 方式相比,唯一的差別就是「回調函式名稱是自動產生」還是「手工指定」。
async: false 會凍結整個瀏覽器 UI 直到請求結束,實務上應避免,改用非同步並搭配 loading 提示。Access-Control-Allow-Origin)會是更現代、更安全的做法,也能支援 POST。