DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> JavaScript入門知識 >> JSON基礎
JSONP 原理剖析:一句話說清「用 JSON 傳數據,靠 JSONP 跨域」
編輯:JSON基礎     

聯調時遇到跨域取數據,jQuery 裡把 dataType 設成 'jsonp' 就能解決。但當時後端並未支持 JSONP,同事反問了一句:JSONP 返回的格式究竟是什麼樣的?我發現自己一直只會用,卻說不清原理。於是把資料翻了一遍,記錄如下。

JSON 與 JSONP 不是一回事

兩者只差一個字母,本質完全不同:JSON 是數據交換格式,JSONP 是一種跨域數據交互的協議,而使用 JSONP 取回的內容仍然是 JSON 格式。

一句話總結:用 JSON 來傳數據,靠 JSONP 來跨域。

為什麼需要它

浏覽器的同源策略規定,一個頁面的 ajax 只能獲取與該頁面同域的數據。跨域請求會直接被浏覽器攔下。

核心思路是:利用 script 標籤不受同源策略限制的 src,去引入跨域資源。下面按五個遞進步驟把過程走一遍。

步驟一:script 標籤能跨域加載

假設 b.com/b.js 內容為:

 alert('hello');

在 a.com/a.html 中引用:

 <script type='text/javascript' src='https://b.com/b.js'></script>

打開 a.html,彈出 hello。這說明 script 標籤天然可以跨域加載腳本。

步驟二:讓遠端腳本調用本地函數

把 b.js 改成:

 myFunction('hello');

a.html 改成:

 <script type='text/javascript' src='https://b.com/b.js'></script>
<script>
function myFunction(str) {
  //定義處理數據的函數
  alert(str + ' world');
}
</script>

結果彈出 hello world。

步驟三:數據已經跨域回來了

仔細看步驟二,b.js 裡的 'hello' 是 b.com 域名下的數據,卻在 a.com 的頁面裡被執行並顯示——跨域請求數據已經實現了。

順帶一提,script 的 src 並不要求指向 js 文件,改成 b.json、b.html 這類後綴,只要服務端返回的是可執行 JS 文本,同樣能跑。

步驟四:讓數據變成動態的

寫死在文件裡的內容顯然不夠用,真實場景需要實時數據,於是引入回調函數:

 <script type='text/javascript' src='https://b.com/b.aspx?callback=myFunction'></script>
<script>
function myFunction(str){
  //定義處理數據的函數
  alert(str + ' world');
}
</script>

src 裡多出的 ?callback=myFunction 把「處理數據的函數名」也傳給了服務端。這裡有個關鍵前提:後端接口也必須支持 JSONP。以 .NET 為例:

 protected void page_load(object sender, EventArgs e){
  if (this.IsPostBack == false){
    string callback = '';
    if (Request["callback"] != null){
      callback = request["callback"];
      string data = "hello";
      Response.Write(callback + "(" + data + ")");
      //接口頁面返回的數據格式:"函數(參數)"
    }
  }
}

請求 b.aspx?callback=myFunction 時,響應就是 myFunction('hello');只要 data 取自數據庫或計算結果,'hello' 就成了動態數據。

步驟五:按需動態插入 script

靜態寫死的 script 標籤一生只執行一次。要多次取數,就得在需要時動態創建、用完刪除:

 function addScript(src){
  var script = document.createElement('script');
  script.setAttribute('type', 'text/javascript');
  script.src = src;
  document.body.appendChild(script);
}
 addScript('b.com/b.aspx?callback=myFunction');
function myFunction(data){
  //定義處理數據的函數
  alert(data);
}

把這五步串起來,就是 JSONP 的全貌。與其背定義,不如記住這條鏈路。

jQuery 的封裝

 $.ajax({
  url: 'b.com/b.json',   //不同的域
  type: 'GET',           // jsonp模式只有GET是合法的
  dataType: 'jsonp',     // 數據類型
  jsonp: 'callback',     // 指定回調函數名,與服務器端接收的一致
  success: function(data) {
    console.log(data);
  }
})

那麼 jQuery 內部做了什麼?看源碼:

 if (s.dataType == "jsonp") {
  // 構建jsonp請求字符集串
  if (type == "GET") {
    //使get的url包含 callback=?後面將會加函數名
    if (!s.url.match(jsre))
      s.url += (s.url.match(/\?/) ? "&" : "?") + (s.jsonp || "callback") + "=?";
  }
  else if (!s.data || !s.data.match(jsre))
    s.data = (s.data ? s.data + "&" : "") + (s.jsonp || "callback") + "=?";
  s.dataType = "json";
}
if (s.dataType == "json" && (s.data && s.data.match(jsre) || s.url.match(jsre))) {
  jsonp = "jsonp" + jsc++;  //為請求字符集串的callback=加上生成回調函數名
  if (s.data) s.data = (s.data + "").replace(jsre, "=" + jsonp + "$1");
  s.url = s.url.replace(jsre, "=" + jsonp + "$1");
  s.dataType = "script";   //jsonp的類型必須為script,這樣才能執行服務器返回的代碼
  //window下注册一个jsonp回調函數,讓ajax請求返回的代碼調用執行它
  window[jsonp] = function(tmp) {
    data = tmp;
    success();
    complete();
    // 垃圾回收,刪除jsonp的對象,除去head中加的script元素
    window[jsonp] = undefined;
    try { delete window[jsonp]; } catch (e) {}
    if (head) head.removeChild(script);
  };
}
if (s.data && type == "GET") {
  s.url += (s.url.match(/\?/) ? "&" : "?") + s.data;
  s.data = null;
}
if (s.dataType == "script" && type == "GET" && parts && (parts[1] && parts[1] != location.protocol || parts[2] != location.host)) {
  var head = document.getElementsByTagName("head")[0];
  var script = document.createElement("script");
  script.src = s.url;
  if (s.scriptCharset) script.charset = s.scriptCharset;
  if (!jsonp) {
    var done = false;
    script.onload = script.onreadystatechange = function() {
      if (!done && (!this.readyState || this.readyState == "loaded" || this.readyState == "complete")) {
        done = true;
        success();
        complete();
        head.removeChild(script);
      }
    };
  }
  head.appendChild(script);
  return undefined;
}

代碼看著長,去掉細節後就是三件事:把 URL 中的 callback=? 替換成一個獨一無二的函數名(如 jQuery18309...);在 window 上掛一個同名函數;插入 script 標籤。腳本加載完成後自動調用該函數,數據作為參數傳入,用完立即清理函數與標籤。

所以,dataType: 'jsonp' 之所以能跨域,本質就是 把 XHR 換成了 script 標籤注射。

自己封裝一個

 function jsonp(config) {
  var options = config || {}; // 需要配置 url, success, time, fail 四個屬性
  var callbackName = ('jsonp_' + Math.random()).replace(".", "");
  var oHead = document.getElementsByTagName('head')[0];
  var oScript = document.createElement('script');
  oHead.appendChild(oScript);
  window[callbackName] = function(json) {
    //創建jsonp回調函數
    oHead.removeChild(oScript);
    clearTimeout(oScript.timer);
    window[callbackName] = null;
    options.success && options.success(json); //先刪除script標簽,實際上執行的是success函數
  };
  oScript.src = options.url + '?' + callbackName; //發送請求
  if (options.time) {
    //設置超時處理
    oScript.timer = setTimeout(function () {
      window[callbackName] = null;
      oHead.removeChild(oScript);
      options.fail && options.fail({ message: "超時" });
    }, options.time);
  }
};

調用方式:

 jsonp({
  url: '/b.com/b.json',
  success: function(d){
    //數據處理
  },
  time: 5000,
  fail: function(){
    //錯誤處理
  }
})

幾點注意事項

使用 JSONP 時,在控制台的 Network - JS 分類下才能看到請求,它不再屬於 XHR 類型。因為頁面上的 script 只會執行一次,而動態數據需要多次調用,所以每次用完都要刪除標籤並清理回調函數,否則全局變量會越積越多。原生實現時強烈建議加超時處理,不然接口掛掉時回調永遠不觸發,調試會很痛苦。

最後要強調的是:JSONP 本質上是把執行權交給了對方,因此只能加載完全可信的資源。現代項目中,如果服務端可控,更推薦用 CORS(跨域資源共享)配置響應頭來解決跨域,安全性和錯誤處理都更規範。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved