XMLHttpRequest Level 2 使用指南 - 转自阮一峰博客

在我刚入门JS的时候,犀牛书上讲解了XMLHttpRequest这个浏览器的网络接口,这个接口使得JS可以网络(http,https)通信。

最早是在IE5引进了这个接口,因为它太有用了,其他浏览器也模仿部署了,因此诞生了ajax操作。

但是这个接口一直没有标准化,各个浏览器厂商对XMLHttpRequest的实现或多或少有些不同。Html5的概念形成后,W3C开始考虑标准化这个接口。2008年2月,就提出了XMLHttpRequest Level 2的草案。

这个XMLHttpRequest的新版本,提出了很多有用的功能,大大推动互联网的革新。

现在就老版本以及新版本进行对比讲解

一、老版本的XMLHttpRequest对象

在介绍新版本之前,我们先回顾一下老版本的用法

首先,新建一个XMLHttpRequest实例

var xhr = new XMLHttpRequest()

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

xhr.open('GET', 'www.test.com')
xhr.open()

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

xhr.onreadystatechange = function() {
    if (xhr.readyState === 4 && xhr.status === 200) {
        console.log(xhr.responseText)
    } else {
       console.log(xhr.statusText) 
    }
}

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

* xhr.readyState: XMLHttpRequest对象的状态,等于4表示数据已经接受完毕
* xhr.status: 服务器返回的状态码,404表示not found,200表示一切正常
* xhr.responseText: 服务器返回的文本数据
* xhr.responseXML: 服务器返回的XML格式的数据
* xhr.statusText: 服务器返回的状态文本

二、老版本的缺点

老版本的XMLHttpRequest对象有以下几个缺点:

* 只支持文本数据的传送,无法用来读取和上传二进制文件
* 传送和接受数据的时候,没有进度信息,只能提示有没有完成
* 受到"同源限制",只能向同一域名的服务器发送请求

三、 新版本的功能

新版本的XMLHttpRequest对象,针对老版本的确定,做了改进

1. 可以设置HTTP请求的时限
2. 可以使用FormData对象管理表单数据
3. 可以上传文件
4. 可以请求不同域名下的数据(跨域请求)
5. 可以获取服务器端的二进制数据
6. 可以获取数据传输的进度信息

下面一一介绍这些新功能。

四、HTTP请求的时限

有时候,ajax操作非常耗时,而且无法预知需要花费多少时间。如果网速很慢,用户可以要等很久。

新版的XMLHttpRequest对象新增了timeouot属性,可以设置HTTP请求的时限

xhr.timeout = 3000

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

xhr.ontimeout = function() {
    console.log('请求超时')
}

五、FormData对象

ajax操作往往用来传递表单数据,为了方便表单处理,HTML5新增了一个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 (let i = 0; i < files.length; i++) {
    formData.append(`files[${i}]`, files[i])
}

然后发送这个FormData对象

xhr.send(formData)

七、跨域资源共享(CORS)

新版的XMLHttpRequest对象,可以向不同域名的服务器发出Http请求,也叫做跨域资源共享

使用跨域资源共享的前提是,浏览器必须支持这个功能,而且服务端必须同意这种跨域请求。如果能满足以上条件,则代码的写法与不跨域的请求完全一样

xhr.open('GET','www.test.com')

八、接受二进制数据

老版本的XMLHttpRequest对象,只能从服务器取回文本数据(否则它的名字就不用XML起头了),新版则可以取回二进制数据

这里分为两种做做法。较老的做法是该写数据的MIMEType,将服务器返回的二进制数据伪装成文本数据,并且告诉浏览器这是用户自定义的字符集

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

然后,用responseText属性接受服务器返回的二进制数据

var binStr = xhr.responseTetxt

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

for (let i = 0,len = binStr.length; i < len; ++i) {
    let c = binStr.charCodeAt(i)
    let byte = c & 0xff
}

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

还有一种方法接受二进制数据

从服务器取回二进制数据,如果服务器返回文本数据,这个属性的值是‘TEXT',这是默认值,较新的浏览器还支持其他值,也就是说,可以接受其他格式的数据

你可以把responseType设为blob,表示服务器传回的是二进制对象

var xhr = new XMLHttpRequest()
xhr.open('GET','/path/to/img.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/img.png')
xhr.responseType = 'arraybuffer'

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

var arrayBuffer = xhr.response
if (arrayBuffer) {
    var byteArray = new Uint8Array(arrayBuffer)
    for (let i = 0;i < byteArray.byteLength; i++) {
        //do something
    }
}

九、进度信息

新版本的XMLHttpRequest对象,传送数据的时候,有一个progress事件,用来返回进度信息。

它分成上传和下载两种情况,下载的progress事件属于XMLHttpRequest对象。上传的progress事件属于XMLHttpRequest.upload对象

我们先定义progress事件的回调函数

xhr.onprogress = updateProgress
xhr.upload.onprogress = updateProgress

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

function updateProgress(e) {
    if(e.lengthComputable) {
        let percentComplete = e.loaded / e.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:一些高级用法
  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设置

十一、 原文链接

原文链接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,258评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,335评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,225评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,126评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,140评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,098评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,018评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,857评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,298评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,518评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,400评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,993评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,638评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,661评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352