原生JavaScript實(shí)現(xiàn)AJAX、JSONP

2019-11-19 17:41:44

字體：大中小

供稿：網(wǎng)友

相信大多數(shù)前端開(kāi)發(fā)者在需要與后端進(jìn)行數(shù)據(jù)交互時(shí)，為了方便快捷，都會(huì)選擇JQuery中封裝的AJAX方法，但是有些時(shí)候，我們只需要JQuery的AJAX請(qǐng)求方法，而其他的功能用到的很少，這顯然是沒(méi)必要的。

其實(shí)，原生JavaScript實(shí)現(xiàn)AJAX并不難，這篇文章將會(huì)講解如何實(shí)現(xiàn)簡(jiǎn)單的AJAX，還有跨域請(qǐng)求JSONP！

一、AJAX

AJAX的核心是XMLHttpRequest。

一個(gè)完整的AJAX請(qǐng)求一般包括以下步驟：

實(shí)例化XMLHttpRequest對(duì)象
連接服務(wù)器
發(fā)送請(qǐng)求
接收響應(yīng)數(shù)據(jù)

我將AJAX請(qǐng)求封裝成ajax()方法，它接受一個(gè)配置對(duì)象params。

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

在上面的代碼中readyState的值表示請(qǐng)求/響應(yīng)過(guò)程的當(dāng)前活動(dòng)階段，其值得含義如下：

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

1：?jiǎn)?dòng)。已經(jīng)調(diào)用open方法，但尚未調(diào)用send()方法。

2：發(fā)送。已經(jīng)調(diào)用send()方法，但尚未接受到響應(yīng)。

3：接收。已經(jīng)接收到部分響應(yīng)數(shù)據(jù)。

4：完成。已經(jīng)接收到全部響應(yīng)數(shù)據(jù)，并且可以在客戶端使用

使用實(shí)例：

ajax({   url: 'test.php',  // 請(qǐng)求地址 type: 'POST',  // 請(qǐng)求類(lèi)型，默認(rèn)"GET"，還可以是"POST" data: {'b': '異步請(qǐng)求'},  // 傳輸數(shù)據(jù) success: function(res){  // 請(qǐng)求成功的回調(diào)函數(shù)  console.log(JSON.parse(res));   }, error: function(error) {}  // 請(qǐng)求失敗的回調(diào)函數(shù)});

二、JSONP

同源策略

AJAX之所以需要“跨域”，罪魁禍?zhǔn)拙褪菫g覽器的同源策略。即，一個(gè)頁(yè)面的AJAX只能獲取這個(gè)頁(yè)面相同源或者相同域的數(shù)據(jù)。如何叫“同源”或者“同域”呢？――協(xié)議、域名、端口號(hào)都必須相同。例如

http://example.com 和 https://example.com 不同，因?yàn)閰f(xié)議不同；

http://localhost:8080 和 http://localhost:1000 不同，因?yàn)槎丝诓煌?/p>

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

當(dāng)跨域請(qǐng)求時(shí)，一般都會(huì)看到這個(gè)錯(cuò)誤：

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.

那如何跨域請(qǐng)求呢？這時(shí)，JSONP就登場(chǎng)了！

JSONP是JSON with Padding(填充式JSON或參數(shù)式JSON)的簡(jiǎn)寫(xiě)，是一種非常常用的跨域請(qǐng)求方式。主要原理是利用了script 標(biāo)簽可以跨域請(qǐng)求的特性，由其 src 屬性發(fā)送請(qǐng)求到服務(wù)器，服務(wù)器返回 JavaScript 代碼，瀏覽器接受響應(yīng)，然后就直接執(zhí)行了，這和通過(guò) script 標(biāo)簽引用外部文件的原理是一樣的。

JSONP由兩部分組成：回調(diào)函數(shù)和數(shù)據(jù)，回調(diào)函數(shù)是當(dāng)響應(yīng)到來(lái)時(shí)應(yīng)該在頁(yè)面中調(diào)用的函數(shù)，回調(diào)函數(shù)的名字一般在請(qǐng)求中指定。當(dāng)服務(wù)器響應(yīng)時(shí)，服務(wù)器端就會(huì)把該函數(shù)和數(shù)據(jù)拼成字符串返回。

JSONP的請(qǐng)求過(guò)程：

請(qǐng)求階段：瀏覽器創(chuàng)建一個(gè) script 標(biāo)簽，并給其src 賦值(類(lèi)似 http://example.com/api/?callback=jsonpCallback）。
發(fā)送請(qǐng)求：當(dāng)給script的src賦值時(shí)，瀏覽器就會(huì)發(fā)起一個(gè)請(qǐng)求。
數(shù)據(jù)響應(yīng)：服務(wù)端將要返回的數(shù)據(jù)作為參數(shù)和函數(shù)名稱(chēng)拼接在一起(格式類(lèi)似”jsonpCallback({name: 'abc'})”)返回。當(dāng)瀏覽器接收到了響應(yīng)數(shù)據(jù)，由于發(fā)起請(qǐng)求的是 script，所以相當(dāng)于直接調(diào)用 jsonpCallback 方法，并且傳入了一個(gè)參數(shù)。

在這里講解一下用原生JavaScript如何實(shí)現(xiàn)。

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

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

注意：因?yàn)?script 標(biāo)簽的 src 屬性只在第一次設(shè)置的時(shí)候起作用，導(dǎo)致 script 標(biāo)簽沒(méi)法重用，所以每次完成操作之后要移除；

使用實(shí)例：

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

雖然JSONP非常簡(jiǎn)單易用，不過(guò)，它也存在兩點(diǎn)不足