某次專案需要從遠端載入資料並渲染頁面,直到開發階段才意識到 Ajax 跨來源請求的問題。隱約記得 jQuery 提供過相關解法,於是翻出 API 研究了一番,這裡整理出來分享給大家。
jQuery 對 Ajax 跨來源請求提供了兩類方案,不過都只支援 GET 方式,分別是 jQuery.ajax 的 jsonp 格式與 jquery.getScript 方式。
那什麼是 jsonp 格式呢?API 原文大意是:若取得的資料檔案存放在遠端伺服器(不同網域,也就是跨來源取得資料),就需要使用 jsonp 型別。使用這種型別時,會建立一個查詢字串參數 callback=?,加在請求網址後面;伺服器端應在 JSON 資料前加上回呼函式名稱,以完成有效的 JSONP 請求。也就是說,遠端伺服器需要依據客戶端傳來的 callback 參數,回傳 callback(json) 形式的資料,而客戶端則以 script 的方式處理回傳的資料。此外,jQuery.getJSON 同樣支援 jsonp 的呼叫方式。
客戶端 jQuery.ajax 的呼叫範例:
$.ajax({
type : "get",
async : false,
url : "https://www.xxx.com/ajax.do",
dataType : "jsonp",
jsonp : "callbackparam", // 服務端用於接收 callback 函式名的參數
jsonpCallback : "success_jsonpCallback", // callback 的函式名稱
success : function(json){
alert(json);
alert(json[0].name);
},
error : function(){
alert('fail');
}
});
服務端回傳資料的範例程式碼:
public void ProcessRequest (HttpContext context) {
context.Response.ContentType = "text/plain";
String callbackFunName = context.Request["callbackparam"];
context.Response.Write(callbackFunName + "([ { name:\"John\"}])");
}
關鍵在於:伺服器必須把客戶端傳來的 callback 函式名拼在回傳的 JSON 字串最前面,讓瀏覽器能以 script 標籤的方式正確執行並取用資料,這正是 JSONP 繞過同源政策的核心原理。