瀏覽器的同源政策會阻擋直接向其他網域發出的 Ajax 請求。JSONP 是早期最常見的繞道方式,它利用「<script> 標籤的 src 不受同源政策限制」這一點,讓伺服器回傳一段 JavaScript 函式呼叫。以下示範 jQuery 上的完整做法。
使用 JSONP 時,dataType 必須設為 "jsonp",而 type 只能是 GET(因為參數實際上是拼在 script 的網址上)。
$.ajax({
type: "GET",
url: "https://www.xxx.com/Rest/ValidAccountsExists.aspx?accounts=admin",
dataType: "jsonp",
jsonp: "jsoncallback",
success: function (result) {
alert(result.Success);
alert(result.Content);
},
error: function (result, status) {
// 處理錯誤
}
});
這裡的 jsonp: "jsoncallback" 告訴 jQuery:請用 jsoncallback 這個名稱作為回呼參數的鍵名。jQuery 會自動產生一個獨一無二的函式名稱,把它填進網址,等回應到達時執行該函式,再把解析後的資料交給你的 success 回呼。
string accounts = GameRequest.GetQueryString("accounts");
string jsoncallback = GameRequest.GetQueryString("jsoncallback");
Response.ContentEncoding = System.Text.Encoding.UTF8;
Response.ContentType = "application/json";
Response.Write(jsoncallback + "({""Success"":""True"",""Content"":""" + accounts + """})");
Response.End();
後台的關鍵只有一件事:把回呼函式名稱原封不動地取出來,再把你原本要回傳的 JSON 包成 函式名稱(資料) 的形式輸出。這樣瀏覽器載入這段「程式碼」時,就會自動執行那個函式並把資料傳進去。
後台務必驗證回呼名稱。直接把使用者送來的 jsoncallback 字串寫進回應,等於允許對方在你的頁面上執行任意 JavaScript。串接的是自家頁面時風險有限,但這仍是需要避免的習慣。若使用較新的框架,內建的 JSONP 支援通常已含名稱白名單檢查。
資料同樣要轉義。範例中的 accounts 直接內插進 JSON 字串,若內容含有雙引號或換行就會破壞格式,甚至造成注入。應改用正式的 JSON 序列化方法輸出。
Content-Type 應為 application/javascript。既然回傳的是可執行的程式碼,宣告為 json 並不準確。
只能發 GET 請求。這是 JSONP 的結構性限制,無法承載大量資料。
JSONP 已被視為歷史技術。現代做法是由後端設定 CORS 標頭,讓正常的 Ajax 或 fetch 請求可以直接跨網域:
// 後端回應標頭
Access-Control-Allow-Origin: https://your-page.example.com
Access-Control-Allow-Methods: GET, POST, OPTIONS
Access-Control-Allow-Headers: Content-Type
// 前台
fetch('https://api.example.com/Rest/ValidAccountsExists?accounts=admin', {
headers: { 'Content-Type': 'application/json' }
})
.then(function (r) { return r.json(); })
.then(function (result) {
console.log(result.Success, result.Content);
})
.catch(function (err) { console.error(err); });
CORS 的優勢在於支援完整的 HTTP 方法、能帶自訂標頭與 cookie、錯誤處理正常(JSONP 一旦失敗往往只會靜默逾時),而且不必在頁面中插入額外的 script 標籤。
不過理解 JSONP 的原理仍有價值:許多老系統只提供 JSONP 接口,而在閱讀這類程式碼時,知道「為什麼後端要把回呼名稱拼在資料前面」能省去不少困惑。