瀏覽器的同源政策會擋下跨網域的 Ajax 請求。JSONP 繞過這項限制的方式,是借用 <script> 標籤不受同源限制的歷史特性:伺服器回傳的不是純 JSON,而是一段「呼叫你的回呼函式並把資料當參數傳入」的 JavaScript。
type:請求方式,GET / POST(JSONP 實際上只會走 GET)。
url:請求位址。
async:布林值,預設 true 表示非同步;設為 false 則同步,會凍結整個頁面,不建議使用。
dataType:回傳的資料型別,這裡填 "jsonp"。
jsonp:用來傳遞回呼函式名稱的「參數名」,一般預設是 callback。
jsonpCallback:自訂回呼函式名稱。不指定時 jQuery 會產生一個隨機函式名;也可以寫 "?" 讓 jQuery 全權處理。
success / error:成功與失敗的回呼。
服務端用 ASP.NET MVC 的 Action 回傳資料:
public class HomeController : Controller
{
public ActionResult Index()
{
return View();
}
public ActionResult ReturnJson()
{
string callback = Request.QueryString["callback"];
string json = "{'name':'張三','age':'20'}";
string result = string.Format("{0}({1})", callback, json);
return Content(result);
}
}
關鍵就是最後那行字串拼接:把客戶端傳來的 callback 名稱,跟 JSON 資料組合成 函式名(資料) 的形式。瀏覽器執行這段腳本時,就等於呼叫了 jQuery 準備好的回呼函式。
<script src="Scripts/jquery-1.7.1.min.js" type="text/javascript"></script>
<script type="text/javascript">
function SendData()
{
$.ajax({
type: "get",
async: false,
url: "/home/ReturnJson",
dataType: "jsonp",
success: function(data){
alert(data.name);
},
error: function(){
alert('fail');
}
});
}
</script>
<input type="button" value="提交" onclick="SendData();"/>
點下按鈕後,用開發者工具觀察網路請求,會看到網址上被自動附加了一個 callback=jQueryxxxx_12345 的隨機參數,服務端就是從這裡取得函式名稱。
想自己命名,加上 jsonpCallback 即可:
<script type="text/javascript">
function SendData() {
$.ajax({
type: "get",
async: false,
url: "/home/ReturnJson",
dataType: "jsonp",
jsonp: "callback", // 傳遞回呼名稱的參數名,預設即為 callback
jsonpCallback: "receive",// 自訂的回呼函式名稱
success: function(data) {
alert(data.name);
},
error: function() {
alert('fail');
}
});
}
function receive(data) {
alert(data.age);
}
</script>
jsonp 決定「用哪個參數名傳」,jsonpCallback 決定「傳什麼值」。兩者搭配,服務端就能穩定地用 Request.QueryString["callback"] 取到你指定的名稱。
只能是 GET。JSONP 的本質是載入一個 script 資源,無法帶 body,所以 type: "post" 會被忽略。要傳大量資料時,只能想辦法塞進網址列。
回傳內容必須是合法 JavaScript。JSON 字串裡的單引號在嚴格模式下會出問題,正式環境請用 JSON.stringify() 或序列化器產生標準雙引號 JSON。
安全性:回呼名稱絕對不可直接拼接使用者輸入。這等於把一段可執行的程式碼交給瀏覽器。必須先驗證 callback 只含合法的字元(例如用正則 ^[\w$.]+$ 檢查),否則就是現成的 XSS 漏洞。
最後,JSONP 是同源政策放寬之前的產物。今天的專案若需要跨域,改用 CORS(伺服器端設定 Access-Control-Allow-Origin)才是正解:它能支援所有 HTTP 方法、錯誤處理也更完整,不必把資料包成函式呼叫。