DIV CSS 佈局教程網

純原生 JavaScript 封裝的 AJAX 函式分享
編輯:關於JavaScript     

最近的工作大量涉及 AJAX 操作,原本該由後端處理的事情也落到我頭上。目前使用的 AJAX 函式是後端同事封裝的,但它以 jQuery 的 ajax 為基礎,一旦離開 jQuery 就完全失效。老實說,jQuery 的 ajax 方法已經相當完善,如果專案本來就有 jQuery,那不用它反而浪費。我真正缺的,是一個能在沒有 jQuery 環境下也能使用的 AJAX 方法。

於是我花了一天時間自己寫了一個,參數與呼叫方式都盡量貼近 jQuery 的 ajax,取名為 xhr,因為 xhr 就是 XMLHttpRequest 的意思。

/*
 * Name: xhr,AJAX封裝函數
 * Description: 一個ajax調用封裝類,仿jquery的ajax調用方式
 */
var xhr = function () {
  var
  ajax = function () {
    return ('XMLHttpRequest' in window) ? function () {
      return new XMLHttpRequest();
    } : function () {
      return new ActiveXObject("Microsoft.XMLHTTP");
    }
  }(),
  formatData= function (fd) {
    var res = '';
    for(var f in fd) {
      res += f+'='+fd[f]+'&';
    }
    return res.slice(0,-1);
  },
  AJAX = function(ops) {
    var
    root = this,
    req = ajax();
    root.url = ops.url;
    root.type = ops.type || 'responseText';
    root.method = ops.method || 'GET';
    root.async = ops.async || true;
    root.data = ops.data || {};
    root.complete = ops.complete || function () {};
    root.success = ops.success || function(){};
    root.error = ops.error || function (s) { alert(root.url+'->status:'+s+'error!')};
    root.abort = req.abort;
    root.setData = function (data) {
      for(var d in data) {
        root.data[d] = data[d];
      }
    }
    root.send = function () {
      var datastring = formatData(root.data),
      sendstring,get = false,
      async = root.async,
      complete = root.complete,
      method = root.method,
      type=root.type;
      if(method === 'GET') {
        root.url+='?'+datastring;
        get = true;
      }
      req.open(method,root.url,async);
      if(!get) {
        req.setRequestHeader("Content-type","application/x-www-form-urlencoded");
        sendstring = datastring;
      }
      //在send之前重置onreadystatechange方法
      req.onreadystatechange = async ? function () {
        if (req.readyState ==4){
          complete();
          if(req.status == 200) {
            root.success(req[type]);
          } else {
            root.error(req.status);
          }
        }
      } : null;
      req.send(sendstring);
      if(!async) {
        complete();
        root.success(req[type]);
      }
    }
    root.url && root.send();
  };
  return function(ops) {return new AJAX(ops);}
}();

參數說明

1. url:請求位址。不填則不會發起請求。

2. method:'GET' 或 'POST',全大寫,預設 GET。

3. data:要一併發送的資料,格式為一個 object。

4. async:是否非同步,預設 true。

5. type:回傳資料型別,只有 responseText 或 responseXML,預設 responseText。

6. complete:請求完成時執行的函式。

7. success:請求成功時執行的函式。

8. error:請求失敗時執行的函式。

補充:type 參數並不像 jQuery 的 dataType 那樣豐富,只有原生 AJAX 提供的 responseText 或 responseXML。若回傳的是 JSON 資料,需要自己在 success 函式中把文字轉成 JSON。

函式說明

實例化後的 xhr 物件有兩個方法可用。一是 send,呼叫方式為 xhr.send(),無參數,用來發起請求;若初始化時沒有給 url,就不會執行 send,讓你可以稍後再補上 url 並手動發送。二是 setData,呼叫方式為 xhr.setData(data_obj),參數是一個 object,作用是局部更新 data 屬性中的值。例如 data 裡已有 page:1,可用 xhr.setData({page:2}) 更新它,而不影響其他既有屬性。

呼叫範例

var a1 = xhr({
  url:'2.php',
  data:{
    'username':'lix',
    'password':'123456',
    'gender':'male',
    'interset':'play'
  },
  async:false,
  method:'GET',
  success: function (data) {
    var obj = JSON.parse(data);
    //....
  }
});
// 注意:不用寫 new

特色介紹

透過這段時間的專案經驗,我發現一個好的 AJAX 類別應該具備「便於重複發起請求」的能力。以分頁 AJAX 為例,每次翻頁都要發送請求,但除了頁碼與每頁筆數外,其他參數其實都不變。如果每次都重新定義那些不變的參數,無疑是一種資源浪費。

這個 xhr 函式已經把這點考慮進去。以上面的分頁為例,可以在頁面載入完成時先初始化一個 xhr 物件並存為變數 a1,翻頁時其他參數不變、只有 pageNumber 改變,這時只需呼叫 setData 更新即可:

a1.setData({pageNumber:2});

當然,你也可以整個替換 data:a1.data = {…};。不只是 data,你同樣可以修改 a1 的其他設定,例如換掉 url、換掉 success 函式、把 GET 改成 POST、同步改成非同步……改完之後再呼叫 a1.send(),它就會依新設定再次發送請求。若是完全不相關的另一個請求,則可再實例化一個 a2。

壓縮加密版方面,未壓縮版去掉註解約 2kb,壓縮版約 1.00kb。xhr 難免還有不足之處,往後使用中若發現問題我會隨時修正,也歡迎提出改進意見。

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