XMLHttpRequest Level 2 使用指南
openkk
12年前
<p> <a href="/misc/goto?guid=4959542838753889884">XMLHttpRequest</a> 是一个浏览器接口，使得 Javascript 可以进行 HTTP (S)通信。</p> <p> 最早，微软在 IE 5 引进了这个接口。因为它太有用，其他浏览器也模仿部署了，ajax 操作因此得以诞生。</p> <p> 但是，这个接口一直没有标准化，每家浏览器的实现或多或少有点不同。HTML 5 的概念形成后，W3C 开始考虑标准化这个接口。2008年 2 月，就提出了 <a href="/misc/goto?guid=4959542838841474110">XMLHttpRequest Level 2</a> 草案。</p> <p> 这个 XMLHttpRequest 的新版本，提出了很多有用的新功能，将大大推动互联网革新。本文就对这个新版本进行详细介绍。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/db05b7191de70d377b4f3a44ba887b28.png" alt="XMLHttpRequest Level 2 使用指南" width="450" height="482"></p> <p> <strong>一、老版本的 XMLHttpRequest 对象</strong></p> <p> 在介绍新版本之前，我们先回顾一下老版本的用法。</p> <p> 首先，新建一个 XMLHttpRequest 的实例。</p> <blockquote> <p>var xhr = new XMLHttpRequest ();</p> </blockquote> <p> 然后，向远程主机发出一个 HTTP 请求。</p> <blockquote> <p>xhr.open ('GET'， 'example.php');</p> <p>xhr.send ();</p> </blockquote> <p> 接着，就等待远程主机做出回应。这时需要监控 XMLHttpRequest 对象的状态变化，指定回调函数。</p> <blockquote> <p>xhr.onreadystatechange = function (){</p> <p>if ( xhr.readyState == 4 && xhr.status == 200 ) {</p> <p>alert ( xhr.responseText );</p> <p>} else {</p> <p>alert ( xhr.statusText );</p> <p>}</p> <p>};</p> </blockquote> <p> 上面的代码包含了老版本 XMLHttpRequest 对象的主要属性：</p> <blockquote> <p>* xhr.readyState：XMLHttpRequest 对象的状态，等于 4 表示数据已经接收完毕。</p> <p>* xhr.status：服务器返回的状态码，等于 200 表示一切正常。</p> <p>* xhr.responseText：服务器返回的文本数据</p> <p>* xhr.responseXML：服务器返回的 XML 格式的数据</p> <p>* xhr.statusText：服务器返回的状态文本。</p> </blockquote> <p> <strong>二、老版本的缺点</strong></p> <p> 老版本的 XMLHttpRequest 对象有以下几个缺点：</p> <blockquote> <p>* 只支持文本数据的传送，无法用来读取和上传二进制文件。</p> <p>* 传送和接收数据时，没有进度信息，只能提示有没有完成。</p> <p>* 受到<a href="/misc/goto?guid=4959542838918769080">"同域限制"</a>（Same Origin Policy），只能向同一域名的服务器请求数据。</p> </blockquote> <p> <strong>三、新版本的功能</strong></p> <p> 新版本的 XMLHttpRequest 对象，针对老版本的缺点，做出了大幅改进。</p> <blockquote> <p>* 可以设置 HTTP 请求的时限。</p> <p>* 可以使用 FormData 对象管理表单数据。</p> <p>* 可以上传文件。</p> <p>* 可以请求不同域名下的数据（跨域请求）。</p> <p>* 可以获取服务器端的二进制数据。</p> <p>* 可以获得数据传输的进度信息。</p> </blockquote> <p> 下面，我就一一介绍这些新功能。</p> <p> <strong>四、HTTP 请求的时限</strong></p> <p> 有时，ajax 操作很耗时，而且无法预知要花多少时间。如果网速很慢，用户可能要等很久。</p> <p> 新版本的 XMLHttpRequest 对象，增加了 timeout 属性，可以设置 HTTP 请求的时限。</p> <blockquote> <p>xhr.timeout = 3000;</p> </blockquote> <p> 上面的语句，将最长等待时间设为 3000 毫秒。过了这个时限，就自动停止 HTTP 请求。与之配套的还有一个 timeout 事件，用来指定回调函数。</p> <blockquote> <p>xhr.ontimeout = function (event){</p> <p>alert ('请求超时！');</p> <p>}</p> </blockquote> <p> 目前，Opera、Firefox 和 IE 10 支持该属性，IE 8 和 IE 9 的这个属性属于 XDomainRequest 对象，而 Chrome 和 Safari 还不支持。</p> <p> <strong>五、FormData 对象</strong></p> <p> ajax 操作往往用来传递表单数据。为了方便表单处理，HTML 5 新增了一个 FormData 对象，可以模拟表单。</p> <p> 首先，新建一个 FormData 对象。</p> <blockquote> <p>var formData = new FormData ();</p> </blockquote> <p> 然后，为它添加表单项。</p> <blockquote> <p>formData.append ('username'， '张三');</p> <p>formData.append ('id'， 123456);</p> </blockquote> <p> 最后，直接传送这个 FormData 对象。这与提交网页表单的效果，完全一样。</p> <blockquote> <p>xhr.send (formData);</p> </blockquote> <p> FormData 对象也可以用来获取网页表单的值。</p> <blockquote> <p>var form = document.getElementById ('myform');</p> <p>var formData = new FormData (form);</p> <p>formData.append ('secret'， '123456'); // 添加一个表单项</p> <p>xhr.open ('POST'， form.action);</p> <p>xhr.send (formData);</p> </blockquote> <p> <strong>六、上传文件</strong></p> <p> 新版 XMLHttpRequest 对象，不仅可以发送文本信息，还可以上传文件。</p> <p> 假定 files 是一个"选择文件"的表单元素（input[type="file"]），我们将它装入 FormData 对象。</p> <blockquote> <p>var formData = new FormData ();</p> <p>for (var i = 0; i < files.length;i++) {</p> <p>formData.append ('files[]'， files[i]);</p> <p>}</p> </blockquote> <p> 然后，发送这个 FormData 对象。</p> <blockquote> <p>xhr.send (formData);</p> </blockquote> <p> <strong>七、跨域资源共享（CORS）</strong></p> <p> 新版本的 XMLHttpRequest 对象，可以向不同域名的服务器发出 HTTP 请求。这叫做<a href="/misc/goto?guid=4959542839000477091">"跨域资源共享"</a>（Cross-origin resource sharing，简称 CORS）。</p> <p> 使用"跨域资源共享"的前提，是浏览器必须支持这个功能，而且服务器端必须同意这种"跨域"。如果能够满足上面的条件，则代码的写法与不跨域的请求完全一样。</p> <blockquote> <p>xhr.open ('GET'， 'http://other.server/and/path/to/script');</p> </blockquote> <p> 目前，除了 IE 8 和 IE 9，主流浏览器都支持 CORS，IE 10 也将支持这个功能。服务器端的设置，请参考<a href="/misc/goto?guid=4959542839380091193">《Server-Side Access Control》</a>。</p> <p> <strong>八、接收二进制数据（方法A：改写 MIMEType）</strong></p> <p> 老版本的 XMLHttpRequest 对象，只能从服务器取回文本数据（否则它的名字就不用 XML 起首了），新版则可以取回二进制数据。</p> <p> 这里又分成两种做法。较老的做法是改写数据的 MIMEType，将服务器返回的二进制数据伪装成文本数据，并且告诉浏览器这是用户自定义的字符集。</p> <blockquote> <p>xhr.overrideMimeType ("text/plain; charset=x-user-defined");</p> </blockquote> <p> 然后，用 responseText 属性接收服务器返回的二进制数据。</p> <blockquote> <p>var binStr = xhr.responseText;</p> </blockquote> <p> 由于这时，浏览器把它当做文本数据，所以还必须再一个个字节地还原成二进制数据。</p> <blockquote> <p>for (var i = 0, len = binStr.length; i < len; ++i) {</p> <p>var c = binStr.charCodeAt (i);</p> <p>var byte = c & 0xff;</p> <p>}</p> </blockquote> <p> 最后一行的位运算"c & 0xff"，表示在每个字符的两个字节之中，只保留后一个字节，将前一个字节扔掉。原因是浏览器解读字符的时候，会把字符自动<a href="/misc/goto?guid=4959542839454684285">解读</a>成 Unicode 的 0xF700-0xF7ff 区段。</p> <p> <strong>八、接收二进制数据（方法B：responseType 属性）</strong></p> <p> 从服务器取回二进制数据，较新的方法是使用新增的 responseType 属性。如果服务器返回文本数据，这个属性的值是"TEXT"，这是默认值。较新的浏览器还支持其他值，也就是说，可以接收其他格式的数据。</p> <p> 你可以把 responseType 设为 blob，表示服务器传回的是二进制对象。</p> <blockquote> <p>var xhr = new XMLHttpRequest ();</p> <p>xhr.open ('GET'， '/path/to/image.png');</p> <p>xhr.responseType = 'blob';</p> </blockquote> <p> 接收数据的时候，用浏览器自带的 Blob 对象即可。</p> <blockquote> <p>var blob = new Blob ([xhr.response], {type: 'image/png'});</p> </blockquote> <p> 注意，是读取 xhr.response，而不是 xhr.responseText。</p> <p> 你还可以将 responseType 设为 arraybuffer，把二进制数据装在一个数组里。</p> <blockquote> <p>var xhr = new XMLHttpRequest ();</p> <p>xhr.open ('GET'， '/path/to/image.png');</p> <p>xhr.responseType = "arraybuffer";</p> </blockquote> <p> 接收数据的时候，需要遍历这个数组。</p> <blockquote> <p>var arrayBuffer = xhr.response;</p> <p>if (arrayBuffer) {</p> <p>var byteArray = new Uint8Array (arrayBuffer);</p> <p>for (var i = 0; i < byteArray.byteLength; i++) {</p> <p>// do something</p> <p>}</p> <p>}</p> </blockquote> <p> 更详细的讨论，请看 <a href="/misc/goto?guid=4959542839541584258">Sending and Receiving Binary Data</a>。</p> <p> <strong>九、进度信息</strong></p> <p> 新版本的 XMLHttpRequest 对象，传送数据的时候，有一个 progress 事件，用来返回进度信息。</p> <p> 它分成上传和下载两种情况。下载的 progress 事件属于 XMLHttpRequest 对象，上传的 progress 事件属于 XMLHttpRequest.upload 对象。</p> <p> 我们先定义 progress 事件的回调函数。</p> <blockquote> <p>xhr.onprogress = updateProgress;</p> <p>xhr.upload.onprogress = updateProgress;</p> </blockquote> <p> 然后，在回调函数里面，使用这个事件的一些属性。</p> <blockquote> <p>function updateProgress (event) {</p> <p>if (event.lengthComputable) {</p> <p>var percentComplete = event.loaded / event.total;</p> <p>}</p> <p>}</p> </blockquote> <p> 上面的代码中，event.total 是需要传输的总字节，event.loaded 是已经传输的字节。如果 event.lengthComputable 不为真，则 event.total 等于0。</p> <p> 与 progress 事件相关的，还有其他五个事件，可以分别指定回调函数：</p> <blockquote> <p>* load 事件：传输成功完成。</p> <p>* abort 事件：传输被用户取消。</p> <p>* error 事件：传输中出现错误。</p> <p>* loadstart 事件：传输开始。</p> <p>* loadEnd 事件：传输结束，但是不知道成功还是失败。</p> </blockquote> <p> <strong>十、阅读材料</strong></p> <p> 1. <a href="/misc/goto?guid=4959542839621743600">Introduction to XMLHttpRequest Level 2</a>： 新功能的综合介绍。</p> <p> 2. <a href="/misc/goto?guid=4959542835536042057">New Tricks in XMLHttpRequest 2</a>：一些用法的介绍。</p> <p> 3. <a href="/misc/goto?guid=4959542839733160839">Using XMLHttpRequest</a>：一些高级用法，主要针对 Firefox 浏览器。</p> <p> 4. <a href="/misc/goto?guid=4959542839812871808">HTTP Access Control</a>：CORS 综述。</p> <p> 5. <a href="/misc/goto?guid=4959542839904563918">DOM access control using cross-origin resource sharing</a>：CORS 的 9 种 HTTP 头信息</p> <p> 6. <a href="/misc/goto?guid=4959542839380091193">Server-Side Access Control</a>：服务器端 CORS 设置。</p> <p> 7. <a href="/misc/goto?guid=4959542839985490327">Enable CORS</a>：服务端 CORS 设置。</p> <p>来自: <a href="/misc/goto?guid=4959542840069605925" id="link_source2">阮一峰的网络日志</a></p>