<script> 元素的 src 屬性可以指向任意 URL 並觸發一次 HTTP GET 請求,而瀏覽器對 <script> 的載入並不受同源策略約束。這正是 JSONP 能夠跨域的根基。
一般來說,這類以 <script> 為載體的 Ajax 傳輸協議,伺服器回應的都是 JSON 編碼的資料;腳本被執行的同時,JavaScript 解析器自然就把它解碼了。因為用的是 JSON 格式,這種協議便被稱為 JSONP。使用時只需設定 <script> 的 src,把它插入到文件裡,瀏覽器就會主動送出請求去下載該 URL。
用 <script> 取資料時,回應內容不能是一段裸的 JSON,而必須被包成「函數名 + 括號」的形式,也就是只能作為某個函數的引數存在:
response(
[1, 2, {"hello", "world"}]
)
為了讓伺服器知道這次是來自 <script> 元素的呼叫、應該回傳 JSONP 而不是普通 JSON,實務上會在 URL 上附加一個查詢參數,例如 ?json(或多個參數時用 &json)。
成熟的支持 JSONP 的服務通常不會強制規定回呼函數名稱,而是讓用戶端透過查詢參數自行指定函數名,再把這個名字填進回應裡。
下面的寫法要點有三個:為每次請求產生唯一名稱、把名稱以表單編碼形式附加到 URL、並在回呼結束後善後清理(刪函數、移除 script 節點),避免記憶體與 DOM 殘留。
//根據指定的url發送一個json請求
//然後把解析得到的響應數據傳遞給回調函數
//在url中添加一個名為jsonp的查詢參數, 用於指定該請求的回調函數的名稱
function getJSONP(url, callback){
//為本次請求創建一個唯一的回調函數名稱
var cbnum = "cb"+getJSONP.counter++;
var cbname = "getJSONP."+cbnum; //作為jsonp函數的屬性
//將回調函數名稱以表單編碼的形式添加到url查詢部分中
if(url.indexOf("?") === -1){
url += "?jsonp="+cbname;
}else{
url += "&jsonp="+cbname;
}
//創建<script>用於發送請求
var script = document.createElement("script");
//定義被腳本執行的回調函數
getJSONP[cbnum] = function(response){
try{
callback(response); //處理響應
}
finally{
//刪除該函數, 並移除相應script元素
delete getJSONP[cbnum];
script.parentNode.removeChild(script);
}
}
//立即觸發http請求
script.src = url;
document.body.appendChild(script);
}
getJSONP.counter = 0;
把回呼函數掛在全域物件上、再用 delete 回收,是為了不讓名稱污染持續累積;但 JSONP 天生有兩個限制值得記住:一是只能發 GET,二是無法像 XHR 那樣回報真正的 HTTP 狀態碼,錯誤處理只能靠自訂逾時。若需要更嚴謹的跨域方案,可考慮 CORS 或同源反向代理。