相信大多數(shù)前端開發(fā)者在需要與后端進行數(shù)據(jù)交互時,為了方便快捷颅夺,都會選擇JQuery中封裝的AJAX方法朋截,但是有些時候,我們只需要JQuery的AJAX請求方法吧黄,而其他的功能用到的很少部服,這顯然是沒必要的。
其實拗慨,原生JavaScript實現(xiàn)AJAX并不難廓八,這篇文章將會講解如何實現(xiàn)簡單的AJAX,還有跨域請求JSONP赵抢!
一剧蹂、AJAX
AJAX的核心是XMLHttpRequest
。
一個完整的AJAX請求一般包括以下步驟:
- 實例化XMLHttpRequest對象
- 連接服務器
- 發(fā)送請求
- 接收響應數(shù)據(jù)
我將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();
// 避免有特殊字符其爵,必須格式化傳輸數(shù)據(jù)
params.data = formatParams(params.data);
var xhr = null;
// 實例化XMLHttpRequest對象
if(window.XMLHttpRequest) {
xhr = new XMLHttpRequest();
} else {
// IE6及其以下版本
xhr = new ActiveXObjcet('Microsoft.XMLHTTP');
};
// 監(jiān)聽事件冒冬,只要 readyState 的值變化,就會調(diào)用 readystatechange 事件
xhr.onreadystatechange = function() {
// readyState屬性表示請求/響應過程的當前活動階段摩渺,4為完成简烤,已經(jīng)接收到全部響應數(shù)據(jù)
if(xhr.readyState == 4) {
var status = xhr.status;
// status:響應的HTTP狀態(tài)碼,以2開頭的都是成功
if(status >= 200 && status < 300) {
var response = '';
// 判斷接受數(shù)據(jù)的內(nèi)容類型
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; //字符串響應
};
// 成功回調(diào)函數(shù)
params.success && params.success(response);
} else {
params.error && params.error(status);
}
};
};
// 連接和傳輸數(shù)據(jù)
if(params.type == 'GET') {
// 三個參數(shù):請求方式摇幻、請求地址(get方式時横侦,傳輸數(shù)據(jù)是加在地址后的)、是否異步請求(同步請求的情況極少)囚企;
xhr.open(params.type, params.url + '?' + params.data, true);
xhr.send(null);
} else {
xhr.open(params.type, params.url, true);
//必須丈咐,設置提交時的內(nè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() :用于對 URI 中的某一部分進行編碼
arr.push(encodeURIComponent(name) + '=' + encodeURIComponent(data[name]));
};
// 添加一個隨機數(shù)參數(shù),防止緩存
arr.push('v=' + random());
return arr.join('&');
}
// 獲取隨機數(shù)
function random() {
return Math.floor(Math.random() * 10000 + 500);
}
}
在上面的代碼中龙宏,已經(jīng)添加具體的注釋棵逊,如需了解更多AJAX,可查看博主的書籍《JavaScript半知半解》中的AJAX章節(jié):AJAX
使用實例:
ajax({
url: 'test.php', // 請求地址
type: 'POST', // 請求類型银酗,默認"GET"辆影,還可以是"POST"
data: {'b': '異步請求'}, // 傳輸數(shù)據(jù)
success: function(res){ // 請求成功的回調(diào)函數(shù)
console.log(JSON.parse(res));
},
error: function(error) {} // 請求失敗的回調(diào)函數(shù)
});
二徒像、JSONP
同源策略
AJAX之所以需要“跨域”,罪魁禍首就是瀏覽器的同源策略蛙讥。即锯蛀,一個頁面的AJAX只能獲取這個頁面相同源或者相同域的數(shù)據(jù)。 如何叫“同源”或者“同域”呢次慢?——協(xié)議旁涤、域名、端口號都必須相同迫像。例如:
http://example.com 和 https://example.com 不同劈愚,因為協(xié)議不同;
http://localhost:8080 和 http://localhost:1000 不同闻妓,因為端口不同菌羽;
http://localhost:8080 和 https://example.com 不同,協(xié)議由缆、域名注祖、端口號都不同,根本不是一家的均唉。
當跨域請求時是晨,一般都會看到這個錯誤:
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)
是一種跨域請求方式。主要原理是利用了script 標簽可以跨域請求的特性限嫌,由其 src 屬性發(fā)送請求到服務器靴庆,服務器返回 JavaScript 代碼,瀏覽器接受響應怒医,然后就直接執(zhí)行了炉抒,這和通過 script 標簽引用外部文件的原理是一樣的。
JSONP由兩部分組成:回調(diào)函數(shù)和數(shù)據(jù)稚叹,回調(diào)函數(shù)一般是在瀏覽器控制焰薄,作為參數(shù)發(fā)往服務器端(當然,你也可以固定回調(diào)函數(shù)的名字扒袖,但客戶端和服務器端的名稱一定要一致)。當服務器響應時季率,服務器端就會把該函數(shù)和數(shù)據(jù)拼成字符串返回野瘦。
JSONP的請求過程:
- 請求階段:瀏覽器創(chuàng)建一個 script 標簽,并給其src 賦值(類似 http://example.com/api/?callback=jsonpCallback)。
- 發(fā)送請求:當給script的src賦值時鞭光,瀏覽器就會發(fā)起一個請求吏廉。
- 數(shù)據(jù)響應:服務端將要返回的數(shù)據(jù)作為參數(shù)和函數(shù)名稱拼接在一起(格式類似”jsonpCallback({name: 'abc'})”)返回。當瀏覽器接收到了響應數(shù)據(jù)惰许,由于發(fā)起請求的是 script席覆,所以相當于直接調(diào)用 jsonpCallback 方法,并且傳入了一個參數(shù)汹买。
對于JQuery的JSONP請求佩伤,這里就不多講了,之前也寫過一篇文章《JQuery的Ajax請求跨域問題》晦毙。
在這里講解一下用原生JavaScript如何實現(xiàn)畦戒。
依舊是ajax()方法里添加JSONP,后面會將兩者整合在一起结序,JSONP的配置參數(shù)主要多了一個jsonp參數(shù),它就是你的回調(diào)函數(shù)名纵潦。
function ajax(params) {
params = params || {};
params.data = params.data || {};
var json = params.jsonp ? jsonp(params) : json(params);
// jsonp請求
function jsonp(params) {
//創(chuàng)建script標簽并加入到頁面中
var callbackName = params.jsonp;
var head = document.getElementsByTagName('head')[0];
// 設置傳遞給后臺的回調(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ā)送請求
script.src = params.url + '?' + data;
//為了得知此次請求是否成功徐鹤,設置超時處理
if(params.time) {
script.timer = setTimeout(function() {
window[callbackName] = null;
head.removeChild(script);
params.error && params.error({
message: '超時'
});
}, time);
}
};
//格式化參數(shù)
function formatParams(data) {
var arr = [];
for(var name in data) {
arr.push(encodeURIComponent(name) + '=' + encodeURIComponent(data[name]));
};
// 添加一個隨機數(shù),防止緩存
arr.push('v=' + random());
return arr.join('&');
}
// 獲取隨機數(shù)
function random() {
return Math.floor(Math.random() * 10000 + 500);
}
}
注意:因為 script 標簽的 src 屬性只在第一次設置的時候起作用邀层,導致 script 標簽沒法重用返敬,所以每次完成操作之后要移除;
使用實例:
ajax({
url: 'test.php', // 請求地址
jsonp: 'jsonpCallback', // 采用jsonp請求寥院,且回調(diào)函數(shù)名為"jsonpCallbak"劲赠,可以設置為合法的字符串
data: {'b': '異步請求'}, // 傳輸數(shù)據(jù)
success:function(res){ // 請求成功的回調(diào)函數(shù)
console.log(res);
},
error: function(error) {} // 請求失敗的回調(diào)函數(shù)
});
在這里后臺使用PHP處理:
<?php
$data = array('type'=>'jsonp');
$callback = isset($_GET['callback']) ? trim($_GET['callback']) : '';
echo $callback.'('.json_encode($data).')';
注意:別漏了用函數(shù)名與數(shù)據(jù)拼接返回。
當然秸谢,前面也說過凛澎,你可以給定固定回調(diào)函數(shù)名:
function jsonpCallback() {}
<?php
echo 'jsonpCallback('.$data.')';
最后我已經(jīng)將AJAX和JSONP請求合并在一起了,下載鏈接:ajax.zip
原文鏈接:原生JavaScript實現(xiàn)AJAX估蹄、JSONP
如有問題塑煎,歡迎在下方留言!