原生JavaScript實現AJAX、JSONP

2019-11-19 17:41:44

字體：大中小

來源：轉載

供稿：網友

相信大多數前端開發者在需要與后端進行數據交互時，為了方便快捷，都會選擇JQuery中封裝的AJAX方法，但是有些時候，我們只需要JQuery的AJAX請求方法，而其他的功能用到的很少，這顯然是沒必要的。

其實，原生JavaScript實現AJAX并不難，這篇文章將會講解如何實現簡單的AJAX，還有跨域請求JSONP！

一、AJAX

AJAX的核心是XMLHttpRequest。

一個完整的AJAX請求一般包括以下步驟：

實例化XMLHttpRequest對象
連接服務器
發送請求
接收響應數據

我將AJAX請求封裝成ajax()方法，它接受一個配置對象params。

function ajax(params) {   params = params || {};   params.data = params.data || {};   // 判斷是ajax請求還是jsonp請求 var json = params.jsonp ? jsonp(params) : json(params);   // ajax請求   function json(params) {    // 請求方式，默認是GET  params.type = (params.type || 'GET').toUpperCase();   // 避免有特殊字符，必須格式化傳輸數據   params.data = formatParams(params.data);    var xhr = null;    // 實例化XMLHttpRequest對象    if(window.XMLHttpRequest) {     xhr = new XMLHttpRequest();    } else {     // IE6及其以下版本     xhr = new ActiveXObjcet('Microsoft.XMLHTTP');    };   　　 // 監聽事件，只要 readyState 的值變化，就會調用 readystatechange 事件  xhr.onreadystatechange = function() {    // readyState屬性表示請求/響應過程的當前活動階段，4為完成，已經接收到全部響應數據   if(xhr.readyState == 4) {      var status = xhr.status;     // status：響應的HTTP狀態碼，以2開頭的都是成功    if(status >= 200 && status < 300) {       var response = '';      // 判斷接受數據的內容類型      var type = xhr.getResponseHeader('Content-type');       if(type.indexOf('xml') !== -1 && xhr.responseXML) {        response = xhr.responseXML; //Document對象響應       } else if(type === 'application/json') {        response = JSON.parse(xhr.responseText); //JSON響應       } else {        response = xhr.responseText; //字符串響應       };      // 成功回調函數      params.success && params.success(response);      } else {       params.error && params.error(status);      }     };    };   // 連接和傳輸數據    if(params.type == 'GET') {   // 三個參數：請求方式、請求地址(get方式時，傳輸數據是加在地址后的)、是否異步請求(同步請求的情況極少)；   xhr.open(params.type, params.url + '?' + params.data, true);     xhr.send(null);    } else {     xhr.open(params.type, params.url, true);     //必須，設置提交時的內容類型     xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8');    // 傳輸數據    xhr.send(params.data);    }   }  //格式化參數   function formatParams(data) {    var arr = [];    for(var name in data) {    //  encodeURIComponent() ：用于對 URI 中的某一部分進行編碼   arr.push(encodeURIComponent(name) + '=' + encodeURIComponent(data[name]));    };    // 添加一個隨機數參數，防止緩存    arr.push('v=' + random());    return arr.join('&');   } // 獲取隨機數   function random() {    return Math.floor(Math.random() * 10000 + 500);   }}

在上面的代碼中readyState的值表示請求/響應過程的當前活動階段，其值得含義如下：

0：為初始化。尚未調用open()方法。

1：啟動。已經調用open方法，但尚未調用send()方法。

2：發送。已經調用send()方法，但尚未接受到響應。

3：接收。已經接收到部分響應數據。

4：完成。已經接收到全部響應數據，并且可以在客戶端使用

使用實例：

ajax({   url: 'test.php',  // 請求地址 type: 'POST',  // 請求類型，默認"GET"，還可以是"POST" data: {'b': '異步請求'},  // 傳輸數據 success: function(res){  // 請求成功的回調函數  console.log(JSON.parse(res));   }, error: function(error) {}  // 請求失敗的回調函數});

二、JSONP

同源策略

AJAX之所以需要“跨域”，罪魁禍首就是瀏覽器的同源策略。即，一個頁面的AJAX只能獲取這個頁面相同源或者相同域的數據。如何叫“同源”或者“同域”呢？――協議、域名、端口號都必須相同。例如

http://example.com 和 https://example.com 不同，因為協議不同；

http://localhost:8080 和 http://localhost:1000 不同，因為端口不同；

http://localhost:8080 和 https://example.com 不同，協議、域名、端口號都不同，根本不是一家的。

當跨域請求時，一般都會看到這個錯誤：

XMLHttpRequest cannot load http://ghmagical.com/article/?intro=jsonp%E8%AF%B7%E6%B1%82&v=5520. No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://localhost' is therefore not allowed access.

那如何跨域請求呢？這時，JSONP就登場了！

JSONP是JSON with Padding(填充式JSON或參數式JSON)的簡寫，是一種非常常用的跨域請求方式。主要原理是利用了script 標簽可以跨域請求的特性，由其 src 屬性發送請求到服務器，服務器返回 JavaScript 代碼，瀏覽器接受響應，然后就直接執行了，這和通過 script 標簽引用外部文件的原理是一樣的。

JSONP由兩部分組成：回調函數和數據，回調函數是當響應到來時應該在頁面中調用的函數，回調函數的名字一般在請求中指定。當服務器響應時，服務器端就會把該函數和數據拼成字符串返回。

JSONP的請求過程：

請求階段：瀏覽器創建一個 script 標簽，并給其src 賦值(類似 http://example.com/api/?callback=jsonpCallback）。
發送請求：當給script的src賦值時，瀏覽器就會發起一個請求。
數據響應：服務端將要返回的數據作為參數和函數名稱拼接在一起(格式類似”jsonpCallback({name: 'abc'})”)返回。當瀏覽器接收到了響應數據，由于發起請求的是 script，所以相當于直接調用 jsonpCallback 方法，并且傳入了一個參數。

在這里講解一下用原生JavaScript如何實現。

依舊是ajax()方法里添加JSONP，后面會將兩者整合在一起，JSONP的配置參數主要多了一個jsonp參數，它就是你的回調函數名。

function ajax(params) {   params = params || {};   params.data = params.data || {};   var json = params.jsonp ? jsonp(params) : json(params);    // jsonp請求   function jsonp(params) {    //創建script標簽并加入到頁面中    var callbackName = params.jsonp;    var head = document.getElementsByTagName('head')[0];    // 設置傳遞給后臺的回調參數名    params.data['callback'] = callbackName;    var data = formatParams(params.data);    var script = document.createElement('script');    head.appendChild(script);    //創建jsonp回調函數    window[callbackName] = function(json) {    head.removeChild(script);    clearTimeout(script.timer);    window[callbackName] = null;    params.success && params.success(json);    };  　　//發送請求    script.src = params.url + '?' + data;    //為了得知此次請求是否成功，設置超時處理    if(params.time) {     script.timer = setTimeout(function() {      window[callbackName] = null;      head.removeChild(script);      params.error && params.error({       message: '超時'      });     }, time);    }   };   //格式化參數   function formatParams(data) {    var arr = [];    for(var name in data) {     arr.push(encodeURIComponent(name) + '=' + encodeURIComponent(data[name]));    };    // 添加一個隨機數，防止緩存    arr.push('v=' + random());   return arr.join('&');   }   // 獲取隨機數   function random() {    return Math.floor(Math.random() * 10000 + 500);   }}

注意：因為 script 標簽的 src 屬性只在第一次設置的時候起作用，導致 script 標簽沒法重用，所以每次完成操作之后要移除；

使用實例：

ajax({    url: 'test',  // 請求地址 jsonp: 'jsonpCallback', // 采用jsonp請求，且回調函數名為"jsonpCallbak"，可以設置為合法的字符串 data: {'b': '異步請求'},  // 傳輸數據 success:function(res){  // 請求成功的回調函數  console.log(res);   }, error: function(error) {}  // 請求失敗的回調函數});

雖然JSONP非常簡單易用，不過，它也存在兩點不足