XMLHttpRequest Level 2 使用指南

2022-10-18,,

xmlhttprequest是一个浏览器接口,使得javascript可以进行http(s)通信。
最早,微软在ie 5引进了这个接口。因为它太有用,其他浏览器也模仿部署了,ajax操作因此得以诞生。
但是,这个接口一直没有标准化,每家浏览器的实现或多或少有点不同。html 5的概念形成后,w3c开始考虑标准化这个接口。2008年2月,就提出了xmlhttprequest level 2 草案。
这个xmlhttprequest的新版本,提出了很多有用的新功能,将大大推动互联网革新。本文就对这个新版本进行详细介绍。

一、老版本的xmlhttprequest对象

在介绍新版本之前,我们先回顾一下老版本的用法。
首先,新建一个xmlhttprequest的实例。

  var xhr = new xmlhttprequest();

然后,向远程主机发出一个http请求。

复制代码 代码如下:
  xhr.open('get', 'example.php');
  xhr.send();

接着,就等待远程主机做出回应。这时需要监控xmlhttprequest对象的状态变化,指定回调函数。

xhr.onreadystatechange = function(){
  if ( xhr.readystate == 4 && xhr.status == 200 ) {
    alert( xhr.responsetext );
  } else {
    alert( xhr.statustext );
  }
};

上面的代码包含了老版本xmlhttprequest对象的主要属性:

复制代码 代码如下:
* xhr.readystate:xmlhttprequest对象的状态,等于4表示数据已经接收完毕。
* xhr.status:服务器返回的状态码,等于200表示一切正常。
* xhr.responsetext:服务器返回的文本数据
* xhr.responsexml:服务器返回的xml格式的数据
* xhr.statustext:服务器返回的状态文本。

二、老版本的缺点

老版本的xmlhttprequest对象有以下几个缺点:
  * 只支持文本数据的传送,无法用来读取和上传二进制文件。
  * 传送和接收数据时,没有进度信息,只能提示有没有完成。
  * 受到"同域限制"(same origin policy),只能向同一域名的服务器请求数据。

三、新版本的功能

新版本的xmlhttprequest对象,针对老版本的缺点,做出了大幅改进。

复制代码 代码如下:
* 可以设置http请求的时限。
* 可以使用formdata对象管理表单数据。
* 可以上传文件。
* 可以请求不同域名下的数据(跨域请求)。
* 可以获取服务器端的二进制数据。
* 可以获得数据传输的进度信息。

下面,我就一一介绍这些新功能。

四、http请求的时限

有时,ajax操作很耗时,而且无法预知要花多少时间。如果网速很慢,用户可能要等很久。
新版本的xmlhttprequest对象,增加了timeout属性,可以设置http请求的时限。

  xhr.timeout = 3000;

上面的语句,将最长等待时间设为3000毫秒。过了这个时限,就自动停止http请求。与之配套的还有一个timeout事件,用来指定回调函数。

复制代码 代码如下:
  xhr.ontimeout = function(event){
    alert('请求超时!');
  }

目前,opera、firefox和ie 10支持该属性,ie 8和ie 9的这个属性属于xdomainrequest对象,而chrome和safari还不支持。

五、formdata对象

ajax操作往往用来传递表单数据。为了方便表单处理,html 5新增了一个formdata对象,可以模拟表单。

首先,新建一个formdata对象。

  var formdata = new formdata();

然后,为它添加表单项。

  formdata.append('username', '张三');
  formdata.append('id', 123456);

最后,直接传送这个formdata对象。这与提交网页表单的效果,完全一样。
  xhr.send(formdata);
formdata对象也可以用来获取网页表单的值。

复制代码 代码如下:
  var form = document.getelementbyid('myform');
  var formdata = new formdata(form);
  formdata.append('secret', '123456'); // 添加一个表单项
  xhr.open('post', form.action);
  xhr.send(formdata);

六、上传文件

新版xmlhttprequest对象,不仅可以发送文本信息,还可以上传文件。
假定files是一个"选择文件"的表单元素(input[type="file"]),我们将它装入formdata对象。

复制代码 代码如下:
  var formdata = new formdata();
  for (var i = 0; i < files.length;i++) {
    formdata.append('files[]', files[i]);
  }

然后,发送这个formdata对象。

  xhr.send(formdata);

七、跨域资源共享(cors)

新版本的xmlhttprequest对象,可以向不同域名的服务器发出http请求。这叫做"跨域资源共享"(cross-origin resource sharing,简称cors)。
使用"跨域资源共享"的前提,是浏览器必须支持这个功能,而且服务器端必须同意这种"跨域"。如果能够满足上面的条件,则代码的写法与不跨域的请求完全一样。

xhr.open('get', 'http://other.server/and/path/to/script');

目前,除了ie 8和ie 9,主流浏览器都支持cors,ie 10也将支持这个功能。服务器端的设置,请参考《server-side access control》。

八、接收二进制数据(方法a:改写mimetype)

老版本的xmlhttprequest对象,只能从服务器取回文本数据(否则它的名字就不用xml起首了),新版则可以取回二进制数据。
这里又分成两种做法。较老的做法是改写数据的mimetype,将服务器返回的二进制数据伪装成文本数据,并且告诉浏览器这是用户自定义的字符集。

  xhr.overridemimetype("text/plain; charset=x-user-defined");

然后,用responsetext属性接收服务器返回的二进制数据。

  var binstr = xhr.responsetext;

由于这时,浏览器把它当做文本数据,所以还必须再一个个字节地还原成二进制数据。

复制代码 代码如下:
  for (var i = 0, len = binstr.length; i < len; ++i) {
    var c = binstr.charcodeat(i);
    var byte = c & 0xff;
  }

最后一行的位运算"c & 0xff",表示在每个字符的两个字节之中,只保留后一个字节,将前一个字节扔掉。原因是浏览器解读字符的时候,会把字符自动解读成unicode的0xf700-0xf7ff区段。

八、接收二进制数据(方法b:responsetype属性)

从服务器取回二进制数据,较新的方法是使用新增的responsetype属性。如果服务器返回文本数据,这个属性的值是"text",这是默认值。较新的浏览器还支持其他值,也就是说,可以接收其他格式的数据。
你可以把responsetype设为blob,表示服务器传回的是二进制对象。
复制代码 代码如下:
  var xhr = new xmlhttprequest();
  xhr.open('get', '/path/to/image.png');
  xhr.responsetype = 'blob';

接收数据的时候,用浏览器自带的blob对象即可。

  var blob = new blob([xhr.response], {type: 'image/png'});

注意,是读取xhr.response,而不是xhr.responsetext。
你还可以将responsetype设为arraybuffer,把二进制数据装在一个数组里。

复制代码 代码如下:
  var xhr = new xmlhttprequest();
  xhr.open('get', '/path/to/image.png');
  xhr.responsetype = "arraybuffer";

接收数据的时候,需要遍历这个数组。

复制代码 代码如下:
  var arraybuffer = xhr.response;
  if (arraybuffer) {
    var bytearray = new uint8array(arraybuffer);
    for (var i = 0; i < bytearray.bytelength; i++) {
      // do something
    }
  }

更详细的讨论,请看sending and receiving binary data。

九、进度信息

新版本的xmlhttprequest对象,传送数据的时候,有一个progress事件,用来返回进度信息。
它分成上传和下载两种情况。下载的progress事件属于xmlhttprequest对象,上传的progress事件属于xmlhttprequest.upload对象。
我们先定义progress事件的回调函数。

复制代码 代码如下:
  xhr.onprogress = updateprogress;
  xhr.upload.onprogress = updateprogress;

然后,在回调函数里面,使用这个事件的一些属性。

复制代码 代码如下:
  function updateprogress(event) {
    if (event.lengthcomputable) {
      var percentcomplete = event.loaded / event.total;
    }
  }

上面的代码中,event.total是需要传输的总字节,event.loaded是已经传输的字节。如果event.lengthcomputable不为真,则event.total等于0。
与progress事件相关的,还有其他五个事件,可以分别指定回调函数:

  * load事件:传输成功完成。
  * abort事件:传输被用户取消。
  * error事件:传输中出现错误。
  * loadstart事件:传输开始。
  * loadend事件:传输结束,但是不知道成功还是失败。

十、阅读材料

1. introduction to xmlhttprequest level 2: 新功能的综合介绍。

2. new tricks in xmlhttprequest 2:一些用法的介绍。

3. using xmlhttprequest:一些高级用法,主要针对firefox浏览器。

4. http access control:cors综述。

5. dom access control using cross-origin resource sharing:cors的9种http头信息

6. server-side access control:服务器端cors设置。

7. enable cors:服务端cors设置。

《XMLHttpRequest Level 2 使用指南.doc》

下载本文的Word格式文档,以方便收藏与打印。