DIV CSS 佈局教程網

動手模擬實現一個 jsonp:從 script 標籤到 Deferred
編輯:JavaScript綜合知識     

jsonp 是早期跨域取數據的主流手段。很多人會用卻沒寫過,一旦要封裝請求層就容易卡住。本文借鑑 jQuery 的實現思路,從零模擬一個 jsonp 請求器,把「動態創建 script 標籤」這件事拆成可讀的幾個步驟。

jsonp 的基本原理

瀏覽器的同源策略限制了 XHR 跨域讀取,但 <script> 標籤的 src 不受此限制。於是思路是:

  1. 先在全局定義一個回調函數。
  2. 動態插入一個 script 標籤,src 指向接口地址,並把回調函數名作為參數拼上去。
  3. 服務端返回的不是純 JSON,而是 回調函數名({...}) 這樣一段可執行 JS。
  4. 腳本執行,回調函數被調用,數據到手。

第一步:請求預處理

function prescript(s) {
  if (s.cache === undefined) {
    s.cache = false;
  }
  if (s.crossDomain) {
    s.type = "GET";
  }
}

function prejsonp(s, originalSettings, jqXHR) {
  // 給回調函數命名
  var callbackName = s.jsonpCallback;

  // 把回調函數名拼到 URL 上
  s.url += (/\?/.test(s.url) ? "&" : "?") + s.jsonp + "=" + callbackName;

  // 腳本執行後,用數據轉換器把結果取出來
  s.getData = function () {
    if (!responseContainer) {
      jQuery.error(callbackName + " was not called");
    }
    return responseContainer[0];
  };

  // 修改數據類型,讓後續按 json 處理
  s.dataTypes[0] = "json";

  // 備份同名全局函數,避免覆蓋衝突
  overwritten = window[callbackName];

  // 用來收集服務端傳回的數據
  window[callbackName] = function () {
    responseContainer = arguments;
  };

  return "script";
}

這一段做了三件事:拼接 URL 參數、把全局回調函數掛上去、把響應數據暫存起來。注意 responseContainer = arguments 這一行——服務端調用回調函數時傳入的實參,就在這裡被接住。

第二步:註冊預處理器

function inspectPrefiltersOrTransportsA(options, originalOptions, jqXHR) {
  var dataTypeOrTransport = prejsonp(options, originalOptions, jqXHR);
  options.dataTypes.unshift(dataTypeOrTransport);
  prescript(options);
}

第三步:分發器負責真正發請求

function inspectPrefiltersOrTransportsB(s, originalOptions, jqXHR) {
  return {
    send: function (_, complete) {
      var script = jQuery("<script>").prop({
        async: true,
        charset: s.scriptCharset,
        src: s.url
      }).on("load error", callback = function (evt) {
        script.remove();      // 用完立刻清理節點
        callback = null;
        if (evt) complete();
      });

      document.head.appendChild(script[0]);
    }
  };
}

這裡有兩個實用細節:一是無論加載成功還是失敗都要移除 script 節點,避免 DOM 越積越多;二是同時監聽 load 與 error,讓失敗場景也能走結束流程。

第四步:組裝對外的 ajax 方法

function createAjax(options) {
  if (typeof url === "object") {
    options = url;
    url = undefined;
  }
  options = options || {};

  var s = jQuery.ajaxSetup({}, options);

  // 異步機制
  var deferred = jQuery.Deferred();
  var completeDeferred = jQuery.Callbacks("once memory");

  var jqXHR = {};

  // 把 jqXHR 轉成 promise,並掛上別名方法
  deferred.promise(jqXHR).complete = completeDeferred.add;
  jqXHR.success = jqXHR.done;
  jqXHR.error = jqXHR.fail;

  s.dataTypes = jQuery.trim(s.dataType || "*").toLowerCase().match(/\S+/g) || [""];

  // 預處理
  inspectPrefiltersOrTransportsA(s, options, jqXHR);

  for (i in { success: 1, error: 1, complete: 1 }) {
    jqXHR[i](s[i]);
  }

  // 分發器
  transport = inspectPrefiltersOrTransportsB(s, options, jqXHR);

  function done(status, nativeStatusText, responses, headers) {
    console.log(s, s.getData());
  }

  transport.send(s, done);
  return jqXHR;
}

使用 Deferred 的價值在於:調用方拿到的 jqXHR 同時具備 done / fail / always 等鏈式方法,接口形態與原生 $.ajax 保持一致,業務代碼幾乎無需改動。

調用示例

function show(data) {
  $('body').append('<li>' + data + '</li>');
}

// 數據回調接收
function flightHandler() { }

$("#test").click(function () {
  createAjax({
    url: 'https://192.168.1.113:8080/github/jQuery/jsonp.php',
    data: { 'action': 'aaron' },
    dataType: 'jsonp',          // 數據類型
    jsonp: 'callback',          // 指定回調參數名,需與服務端約定一致
    jsonpCallback: flightHandler,
    success: function () { show('局部事件 success'); }
  });
});

幾點補充

  • 參數名必須雙向約定:前端用 jsonp 指定查詢參數名,用 jsonpCallback 指定函數名,服務端必須按同樣規則返回 callback(data)。
  • jsonp 只能是 GET:因為本質是加載腳本資源,無法攜帶請求體。
  • 安全性:jsonp 等於把服務端返回的內容當作自己的代碼執行,只應對可信域名使用。涉及敏感數據時應改用 CORS。
  • 現代替代方案:如今跨域首選 CORS,或同源反向代理;jsonp 主要存在於老系統維護場景。

把這套流程走一遍,你會發現 jsonp 並不神秘——它就是「動態腳本 + 全局回調 + 約定協議」三件事的組合。理解它之後,再看任何框架的請求封裝都會輕鬆許多。

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