现在所有主流的网站,基本上都用到了ajax技术,通过异步请求数据已经是一个很普及的实现方式。市面上主流的web前端框架也都有自己封装的ajax,而且都是大同小异的。也就是说,Ajax这个轮子已经是多的不能再多了,那为什么我们还要自己封装一个Ajax呢?
想要了解一个技术或者某个功能的实现原理,只有动手实践才能真正的了解。就如我在csdn上第一篇博客的博文描述。探索技术的路上本应该自己造轮子,即使市面上有再多的选择,自己动手尝试也是必要的,第一次尝试必然会问题众多,但你不觉得解决他是一件很有成就感的事情吗,这样才能带给你更大的进步和更深刻的领悟。
废话不说,先来写一个最基础的ajax:
function ajax(a){
var ajax = new XMLHttpRequest();
ajax.onreadystatechange = function(){
if (ajax.readyState == 4 && ajax.status == 200) {
a.success(JSON.stringify(ajax.responseText))
}
}
ajax.open(a.method, a.url,true)
ajax.send(a.data)
}
ajax({
method:'get',
url:'http://127.0.0.1:8081/test',
success:function(res){
console.log(res)
}
})
一个ajax出炉了,通过调用、填写参数即可请求到服务器。先来分析一下这个ajax的结构,可以看得出来,其实很简单,只是new了一个XMLHttpRequest对象,然后通过onreadystatechange方法来处理返回值,现在我们只是做了一个判断,当请求成功时就调用success方法,如果请求失败,我们还没有写上去,后面我们慢慢完善这个ajax的逻辑。
然后调用ajax的open方法,open方法里有三个参数,第一个是请求方式(如:get或post),第二个是请求的url地址,第三个是一个bool值,是否要异步请求。
最后使用send方法带上参数发送请求即可。
这是,我的服务器已经收到一个请求,但他报了404错误,也就是找不到对应的页面或路由,这时success方法也不会被调用执行。
那我们再来完善一下这个新生的ajax。我们只需要在onreadystatechange方法里增加一个条件,当请求不成功时调用自身的error方法:
ajax.onreadystatechange = function(){
if (ajax.readyState == 4 && ajax.status == 200) {
a.success(JSON.stringify(ajax.responseText))
}else{
a.error(ajax)
}
}
这样我们就可以在ajax请求的时候加上error方法,当ajax请求失败的时候执行我们想要执行的操作。现在我们抛除跨域请求的问题,当你发送post请求时,你会发现后台接收不到传过来的参数,调用如下:
ajax({
method:'get',
url:'http://localhost:8081/test',
data:'a=1',
success:function(res){
console.log(res)
},
error:function(res){
console.log(res)
}
})
后端打印一下传过来的参数,为空。
出现这个问题的原因主要是请求头没有声明,这时候我们需要初始化声明一下请求头,那我们加入一行代码:
ajax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
设置Conten-type为application/x-www-form-urlencoded,现在后端应该是已经可以收到参数了。那我们现在的ajax调用时实在太繁琐,有些东西我们不想填的我们应该给他设置一个默认值,不然就会报错。
比如error方法、method、还有是否异步的bool值等等。那我们再加入一些默认值,现在的ajax是这样的:
function ajax(a){
a.method = a.method || 'get';
a.ajax = a.ajax || true;
a.error = a.error || function(){
console.warn('Ajax请求失败');
};
var ajax = new XMLHttpRequest();
ajax.onreadystatechange = function(){
if (ajax.readyState == 4 && ajax.status == 200) {
a.success(JSON.stringify(ajax.responseText))
}else{
a.error(ajax)
}
}
ajax.open(a.method, a.url,a.ajax)
ajax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
ajax.send(a.data)
}
现在的ajax还存在一个问题,在post请求的时候,如果我们要传参,是需要通过字符串传参的。那这种的书写规则并不是很友好的:
a=1&b=2
而一般框架的传参都是通过json的格式来输入的,我们也不能偏离大众习惯搞独立,当然我们也要保留字符串的传参方式,只是要扩展功能。
那我们需要加一个控制格式的参数,我们这里用dataType这个参数来控制传参格式,默认是字符串格式传参好了,可以选择json格式进行传参即可。如果是json格式传参,我们需要把json转化成字符串类型,代码如下:
a.dataType = a.dataType || 'string';
var data = a.data;
if (a.dataType == 'json') {
var nowData = "";
for (var i in data) {
nowData += (nowData != ''?'&':'')+i+'='+data[i];
}
data = nowData;
}
这样,我们的ajax也就可以通过json格式进行传参了。现在的ajax完整代码和调用方式如下:
function ajax(a){
a.method = a.method || 'get';
a.ajax = a.ajax || true;
a.dataType = a.dataType || 'string';
a.error = a.error || function(){
console.warn('Ajax请求失败');
};
var ajax = new XMLHttpRequest();
ajax.onreadystatechange = function(){
if (ajax.readyState == 4 && ajax.status == 200) {
a.success(JSON.stringify(ajax.responseText))
}else{
a.error(ajax)
}
}
var data = a.data;
if (a.dataType == 'json') {
var nowData = "";
for (var i in data) {
nowData += (nowData != ''?'&':'')+i+'='+data[i];
}
data = nowData;
}
ajax.open(a.method, a.url,a.ajax)
ajax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
ajax.send(data)
}
//调用Ajax示例
ajax({
method:'post',
url:'http://localhost:8081/test',
dataType:'json',
data:{
a:'1',
b:'2'
},
success:function(res){
console.log(res)
}
})
现在这个Ajax基本上已经可以满足业务上的所以需求,不过还有一点没有实现,我们的Ajax不能设置请求头?!为了一些特殊需求的情况下,我们还是要把这一功能加上的:
if (a.requestHeader) {
for (var i in a.requestHeader) {
ajax.setRequestHeader(i,a.requestHeader[i])
}
}
现在的完整代码入下:
function ajax(a){
a.method = a.method || 'get';
a.ajax = a.ajax || true;
a.dataType = a.dataType || 'string';
a.error = a.error || function(){
console.warn('Ajax请求失败');
};
var ajax = new XMLHttpRequest();
ajax.onreadystatechange = function(){
if (ajax.readyState == 4 && ajax.status == 200) {
a.success(JSON.parse(ajax.responseText))
}else if (ajax.readyState != 4 && ajax.status != 200){
a.error(ajax)
}
}
var data = a.data;
if (a.dataType == 'json') {
var nowData = "";
for (var i in data) {
nowData += (nowData != ''?'&':'')+i+'='+data[i];
}
data = nowData;
}
ajax.open(a.method, a.url,a.ajax)
if (a.requestHeader) {
for (var i in a.requestHeader) {
ajax.setRequestHeader(i,a.requestHeader[i])
}
}
ajax.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
ajax.send(data)
}
完整示例代码文件:JavaScript封装Ajax完整示例代码