這次帶給大家JSONP的實作原理,使用JSONP的注意事項有哪些,下面就是實戰案例,一起來看一下。
JSONP的實作原理
相信很多從事前後端分離的人對於JSONP也是經常接觸的,不過很多新手對於JSONP,不知道怎麼去實現以及它的實現原理,這裡文章就為大家詳細介紹下,有興趣的一起來看看。
基本原理
基本原理很容易說明白,html頁面中有些標籤是不受跨網域限制的,像是img,script,link等。如果把我們需要的數據,放在一個js檔案裡面,這時,我們就能突破瀏覽器同源的限制。
建立script標籤
《高效能JavaScript》中提到了動態腳本元素,作者寫道:
1、文件在該元素被加入到頁面時開始下載。這種技術的重點在於:無論何時啟動下載,檔案的下載和執行過程不會阻塞頁面其他進程。
2.使用動態腳本節點下載檔案時,傳回的程式碼通常會立刻執行(除了Firefox和Oprea,它們會等待先前所有動態腳本節點執行完畢。)當腳本自執行時,此機制運作正常。
引用1保證了JSONP請求的時候不會阻塞主線程,引用2保證了JSONP程式碼在載入完成後,立刻自執行時不會出錯。
callback
服務端在接收到GET請求之後,通常要判斷是否有callback參數,如果有,則需要在傳回的資料外面加上一個方法名稱和括號。例如,發起以下請求:
http://www.a.com/getSomething?callback=jsonp0
那麼服務端就會傳回如下內容:
jsonp0({code:200,data:{}})
很明顯,由於這是在動態載入的Script標籤中包含的內容,那麼這就是一段自執行程式碼,這段程式碼只有一個函數被呼叫———jsonp0。
當然,有執行,則必須先創建,否則就會報錯。創建這一步,就需要在呼叫前執行。
具體實作如下:
function jsonp (url, successCallback, errorCallback, completeCallback) { // 声明对象,需要将函数声明至全局作用域 window.jsonp0 = function (data) { successCallback(data); if (completeCallback) completeCallback(); } // 创建script标签,并将url后加上callback参数 var script = document.createElement('script') , url = url + (url.indexOf('?') == -1 ? '?' : '&') + 'callback=jsonp0' ; script.src = url; document.head.parentNode.insertBefore(script, document.head); // 等到script加载完毕以后,就会自己执行 }
上面基本上完成了一個jsonp方法的核心,此時,jsonp0是我們宣告好的一個函數,如果服務端正常回傳的時候,就會執行jsonp0函數,裡面的successCallback回呼也會執行。
完善一下
在實際情況下,通常會有許多個jsonp的請求同時調用,
# 那既然jsonp0就能滿足我們的需要,為什麼常常看到jsonp1,jsonp2等等依序累加的程式碼呢?
這是因為,請求可能是很多個非同步進行。在第一次執行jsonp方法時,window.jsonp0是函數A,此時去載入js文件,在js未載入完畢的情況下,又呼叫了一次jsonp方法,此時,window.jsonp0指向了函數B。那麼等到兩次的js載入完畢以後,就會執行第二次的回呼。
所以,我們需要對callback的名字做一個區別處理,累加就能滿足需求。
修改一下程式碼:
var jsonpCounter = 0; function jsonp (url, successCallback, errorCallback, completeCallback) { var jsId = 'jsonp' + jsonpCounter++; // 声明对象,需要将函数声明至全局作用域 window[jsId] = function (data) { successCallback(data); if (completeCallback) completeCallback(); clean(); } // 创建script标签,并将url后加上callback参数 var script = document.createElement('script') , url = url + (url.indexOf('?') == -1 ? '?' : '&') + 'callback=' + jsId ; script.src = url; document.head.parentNode.insertBefore(script, document.head); // 等到script加载完毕以后,就会自己执行 //在执行完我们这个方法以后,会有很多script标签出现在head之前,我们需要手动的删除掉他们。 function clean () { script.parentNode.removeChild(script); window[jsId] = function(){}; } }
加入了累積和清理之後,還有一個重要的地方要處理,就是錯誤回調。正常來說,我們通常會要求jsonp時,會設定一個超時時間,如果超過這個時間以後,就拋出超時異常。
實作如下:
var jsonpCounter = 0; function jsonp (url, successCallback, errorCallback, completeCallback, timeout) { // 略去上面写过的代码 var timeout = timeout || 10000 , timer ; if (timeout) { timer = setTimeout(function () { if (errorCallback) { errorCallback(new Error('timeout')); } clean(); }, timeout) } function clean () { script.parentNode.removeChild(script); window[jsId] = function(){}; if (timer) clearTimeout(timer); } }
這樣,基本上就完成了jsonp的全部功能,剩下的可能需要做一些相容的修改,才算是完整的jsonp方法。
REFER
我相信看了本文案例你已經掌握了方法,更多精彩請關注php中文網其它相關文章!
推薦閱讀:
以上是JSONP的實作原理的詳細內容。更多資訊請關注PHP中文網其他相關文章!