欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

原生JavaScript实现Ajax异步请求

程序员文章站 2022-07-06 20:45:56
在前端页面开发的过程中,经常使用到ajax请求,异步提交表单数据,或者异步刷新页面。 一般来说,使用jquery中的$.ajax,$.post,$.getjson,非常方...

在前端页面开发的过程中,经常使用到ajax请求,异步提交表单数据,或者异步刷新页面。

一般来说,使用jquery中的$.ajax,$.post,$.getjson,非常方便,但是有的时候,我们只需要ajax功能,这样引入jquery比较不划算。

所以接下来便用原生javascrpit实现一个简单的ajax请求,并说明ajax请求中的跨域访问问题,以及多个ajax请求的数据同步问题。

javascript实现ajax异步请求

简单的ajax请求实现
ajax请求的原理是创建一个xmlhttprequest对象,使用这个对象来进行异步发送请求,具体实现参考下面代码:

function ajax(option) {
  // 创建一个 xmlhttprequest 对象
  var xhr = window.xmlhttprequest ? new xmlhttprequest() : new activexobject("microsoft.xmlhttp"),
    requestdata = option.data,
    requesturl = option.url,
    requestmethod = option.method;
  // 如果是get请求,需要将option中的参数拼接到url后面
  if ('post' != requestmethod && requestdata) {
    var query_string = '';
    // 遍历option.data对象,构建get查询参数
    for(var item in requestdata) {
      query_string += item + '=' + requestdata[item] + '&';
    }
    // 注意这儿拼接的时候,需要判断是否已经有 ?
    requesturl.indexof('?') > -1
      ? requesturl = requesturl + '&' + query_string
      : requesturl = requesturl + '?' + query_string;
    // get 请求参数放在url中,将requestdata置为空
    requestdata = null;
  }
  // ajax 请求成功之后的回调函数
  xhr.onreadystatechange = function () {
    // readystate=4表示接受响应完毕
    if (xhr.readystate == ("number" == typeof xmlhttprequest.done ? xmlhttprequest.done : 4)) {
      if (200 == xhr.status) { // 判断状态码
        var response = xhr.response || xhr.responsetext || {}; // 获取返回值
        // if define success callback, call it, if response is string, convert it to json objcet
        console.log(response);
        option.success && option.success(response); // 调用回调函数处理返回数据
        // 可以判断返回数据类型,对数据进行json解析或者xml解析
        // option.success && option.success('string' == typeof response ? json.parse(response) : response);
      } else {
        // if define error callback, call it
        option.error && option.error(xhr, xhr.statustext);
      }
    }
  };
  // 发送ajax请求
  xhr.open(requestmethod, requesturl, true);
  // 请求超时的回调
  xhr.ontimeout = function () {
    option.timeout && option.timeout(xhr, xhr.statustext);
  };
  // 定义超时时间
  xhr.timeout = option.timeout || 0;
  // 设置响应头部,这儿默认设置为json格式,可以定义为其他格式,修改头部即可
  xhr.setrequestheader && xhr.setrequestheader('content-type', 'application/json;charset=utf-8');
  xhr.withcredentials = (option.xhrfields || {}).withcredentials;
  // 这儿主要用于发送post请求的数据
  xhr.send(requestdata);
}

上面的代码中有详细的注释,ajax的原理很简单,总的来说就是使用xmlhttprequest对象来发送数据。这儿对这个对象进行补充说明。

xmlhttprequest对象的基本属性

readystate属性有五个状态值:

0:是uninitialized:未初始化。已经创建了xmlhttprequest对象但是未初始化。
1:是loading:已经开始准备好要发送了。
2:是loaded,:已经发送,但是还没有收到响应。
3:是interactive:正在接受响应,但是还没接收完。
4:是completed:接受响应完毕。
responsetext:服务器返回的响应文本。只有当readystate>=3的时候才有值。当readystate=3,返回的响应文本不完整,只有readystate=4,接收到完整的响应文本。

responsexml:响应信息是xml,可以解析为dom对象。

status:服务器的http状态码,若是200,则表示ok,404,表示为未找到。

statustext:服务器http状态码的文本。比如ok,not found。

xmlhttprequest对象的基本方法

open(method,url,asyn):打开xmlhttprequest对象。其中method方法有get,post,delete,put。url是请求资源的地址。第三个参数表示是否使用异步。默认情况是true,因为ajax的特点就是异步传送。若使用同步则false。

send(body):发送请求ajax。其中发送的内容可以是需要的参数,若是没有参数,直接send(null)

使用方法

直接调用上面定义的ajax函数,传送相应的选项和参数即可。

ajax({
  url: '/post.php',
  data: {
    name: 'uusama',
    desc: 'smart'
  },
  method: 'get',
  success: function(ret) {
    console.log(ret);
  }
});

跨域请求问题

使用ajax请求的时候,一定要注意一个问题:跨域请求。

在没有使用特殊手段的情况下,跨域请求:请求其他域名和端口下的url资源的时候,会报 access-control-allow-origin 相关的错误。其主要原因是浏览器的同源策略限制,浏览器规定不能跨域请求资源。

解决办法

下面简单的提一下一些解决方案。

在ajax头部添加允许跨域请求的header,这种方式还需要服务端配合添加允许跨域请求的头部才可以。下面是php添加允许post请求跨域头部的php示例:

// 指定允许其他域名访问 
header('access-control-allow-origin:*'); 
// 响应类型 
header('access-control-allow-methods:post'); 
// 响应头设置 
header('access-control-allow-headers:x-requested-with,content-type'); 

使用动态scrpit标签,动态创建一个scrpit标签并指向请求的地址的方法,也就是jsonp方式,需要在url后面拼接一个回调函数,标签加载成功以后会调用回调函数。

var url = "http://uusama.com", callbaclname = 'jsonpcallback';
script = document.createelement('script');
script.type = 'text/javascript';
script.src = url + (url.indexof('?') > -1 ? '&' : '?') + 'callback=' + callbaclname;
document.body.appendchild(script);

回调函数需要设置为全局函数:

window['jsonpcallback'] = function jsonpcallback(ret) {}

多个ajax请求数据同步问题

单个ajax返回数据异步处理
多个ajax请求互不相关,它们在被调用以后发送各自请求,请求成功以后调用自己的回调方法,互不影响。

因为ajax请求异步的特性,所有一些依赖于请求完成之后的操作我们都需要放在回调函数内部,否则的话,你在回调函数外面读取到的值是空。看下面的例子:

var result = null;
ajax({
  url: '/get.php?id=1',
  method: 'get',
  success: function(ret) {
    result = ret;
  }
});
console.log(result); // 输出 null

虽然我们在回调函数里面设置了result的值,但是在最后一行 console.log(result); 输出为空。

因为ajax请求是异步的,程序执行到最后一行的时候,请求并没有完成,值并没有来得及修改。

这儿我们应该把 console.log(result) 相关的处理,放在 success 回调函数中才可以。

多个ajax返回数据问题

如果有多个ajax请求,情况会变得有些复杂。

如果多个ajax请求是按照顺序执行的,其中一个完成之后,才能进行下一个,则可以把后面一个请求放在前一后请求的回调中。

比如有两个ajax请求,其中一个请求的数据依赖于另外一个,则可以在第一个请求的回调里面再进行ajax请求:

// 首先请求第一个ajax
ajax({
  url: '/get1.php?id=1',
  success: function(ret1) {
    // 第一个请求成功回调以后,再请求第二个
    if (ret1) {
      ajax({
        url: '/get2.php?id=4',
        success:function(ret2) {
          console.log(ret1);
          console.log(ret2)
        }
      })
    }
  }
});

// 也可以写成下面的形式
// 将第二个ajax请求定义为一个函数,然后调用
var ajax2 = function(ret1) {
  ajax({
    url: '/get2.php?id=4',
    success:function(ret2) {
      console.log(ret1);
      console.log(ret2)
    }
  });
};
ajax({
  url: '/get1.php?id=1',
  success: function(ret1) {
    if(ret1){
      ajax2(ret1); // 调用第二个ajax请求
    }
  }
});

如果不关心不同的ajax请求的顺序,而只是关心所有请求都完成,才能进行下一步。

一种方法是可以在每个请求完成以后都调用同一个回调函数,只有次数减少到0才执行下一步。

var count = 3, all_ret = []; // 调用3次
ajax({
  url: '/get1.php?id=1',
  success:function(ret) {
    callback(ret); // 请求成功后调用统一回调,次数减1
  }
});
ajax({
  url: '/get2.php?id=1',
  success:function(ret) {
    callback(ret);
  }
});
ajax({
  url: '/get3.php?id=1',
  success:function(ret) {
    callback(ret);
  }
});
function callback(ret) {
  // 当调用3次以上以后,说明3个ajax军完成
  if (count > 0) {
    count--; // 每调用一次,次数减1
    // 可以在这儿保存 ret 到全局变量
    all_ret.push(ret);
    return;
  } else { // 调用三次以后
    // todo
    console.log(ret);
  }
}

另一种方法是设置一个定时任务去轮训是否所有ajax请求都完成,需要在每个ajax的成功回调中去设置一个标志。

这儿可以用是否获得值来判断,也可以设置标签来判断,用值来判断时,要注意设置的值和初始相同的情况。

var all_ret = {
  ret1: null, // 第一个ajax标识
  ret2: null, // 第二个ajax标识
  ret3: null, // 第三个ajax标识
};
ajax({
  url: '/get1.php?id=1',
  success:function(ret) {
    all_ret['ret1'] = ret; // 修改第一个ajax请求标识
  }
});
ajax({
  url: '/get2.php?id=1',
  success:function(ret) {
    all_ret['ret2'] = ret; // 修改第二个ajax请求标识
  }
});
ajax({
  url: '/get3.php?id=1',
  success:function(ret) {
    all_ret['ret3'] = ret; // 修改第三个ajax请求标识
  }
});
var repeat = setinterval(function(){
  // 遍历是否所有ajax请求标识都已被修改,以此判断是否所有ajax请求都已完成
  for(var item in all_ret) {
    if (all_ret[item] === null){
      return;
    }
  }
  // todo, 到这儿所有ajax请求均已完成
  clearinterval(repeat);
}, 50); // 调用次数可以适当调整,不应设的过小或者过大