首頁 > 文章 > web前端 > 基於JSONP原理詳解

基於JSONP原理詳解

小云云原創: 2018-01-05 10:18:401421瀏覽

本文主要為大家推薦一篇基於JSONP原理解析，具有很好的參考價值，希望對大家有幫助。一起跟著小編過來看看吧，希望能幫助大家。

前言

我工作以來接觸的第一個專案就是前後端分離的，前端靜態檔案有自己獨立域名，透過介面來取得資料進行渲染等操作。

跨域的方法不需要多言，隨便一搜，就有很多，但最常用不外乎jsonp和CORS。 jsonp著重於前端，也算是前端Hack技巧，CORS重於後端，服務端需要設定的地方會較多。

這篇解析一下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

《高性能JavaScript》

npm上的一個jsonp實現，JSONP

基於JSONP原理詳解

相關文章