乐趣区

关于前端:XMLHttpRequest对象解析

jiezi 
<!DOCTYPE html><html><body>    <script>        function reqListener () {            console.log(this);            console.log(this.getAllResponseHeaders());            console.log(this.responseText);        }        var params = "lorem=ipsum&name=binny";        var oReq = new XMLHttpRequest();        oReq.upload.onloadstart = function(){//            alert('onloadstart');        };        oReq.upload.onprogress = function(){            alert('onprogress');        };        oReq.onprogress = function(){            alert('download onprogress');        }        oReq.onload  = reqListener;        oReq.onreadystatechange = function(){            alert(this.readyState);        }        oReq.onerror = function(){            alert('error');        }        oReq.open("POST", "http://localhost:81/DeviceRegisters/ajax", true);        oReq.setRequestHeader("Content-type", "application/x-www-form-urlencoded");         oReq.send(params);    </script></body></html>

什么是 readyState

readyState 是 XMLHttpRequest 对象的一个属性，用来标识以后 XMLHttpRequest 对象处于什么状态。

readyState 总共有 5 个状态值，别离为 0~4，每个值代表了不同的含意，如下表所示：

|   0   |  未初始化状态：此时，曾经创立了一个 XMLHttpRequest 对象 |
|   1 |  筹备发送状态：此时，曾经调用了 XMLHttpRequest 对象的 open 办法，并且 XMLHttpRequest 对象曾经筹备好将一个申请发送到服务器端 |
|   2 |  曾经发送状态：此时，曾经通过 send 办法把一个申请发送到服务器端，然而还没有收到一个响应 |
|   3 |  正在接管状态：此时，曾经接管到 HTTP 响应头部信息，然而音讯体局部还没有齐全接管到 |
|   4 |  实现响应状态：此时，曾经实现了 HTTP 响应的接管 |

什么是 status

status 是 XMLHttpRequest 对象的一个属性，示意响应的 HTTP 状态码。

在 HTTP1.1 协定下，HTTP 状态码总共可分为 5 大类，如下表所示：

|   1XX   |  服务器收到申请，须要持续解决。例如 101 状态码，示意服务器将告诉客户端应用更高版本的 HTTP 协定。|
|   2XX   |  申请胜利。例如 200 状态码，示意申请所心愿的响应头或数据体将随此响应返回。|
|   3XX   |  重定向。例如 302 状态码，示意长期重定向，申请将蕴含一个新的 URL 地址，客户端将对新的地址进行 GET 申请。|
|   4XX   |  客户端谬误。例如 404 状态码，示意客户端申请的资源不存在。|
|   5XX   |  服务器谬误。例如 500 状态码，示意服务器遇到了一个未曾意料的状况，导致了它无奈实现响应，一般来说，这个问题会在程序代码出错时呈现。|

看到题目时，有些同学可能会想：“我曾经用 xhr 胜利地发过很多个 Ajax 申请了，对它的基本操作曾经算挺纯熟了。”我之前的想法和你们一样，直到最近我应用 xhr 时踩了不少坑儿，我才忽然发现其实本人并不够理解 xhr，我晓得的只是最最根本的应用。
于是我决定好好地钻研一番 xhr 的真面目，可拜读了不少博客后都不甚称心，于是我决定认真浏览一遍 W3C 的 XMLHttpRequest 规范。看完规范后我如同醍醐灌顶个别，感觉到了从未有过的明澈。这篇文章就是参考 W3C 的 XMLHttpRequest 规范和联合一些实际验证总结而来的。

Ajax和XMLHttpRequest

咱们通常将 Ajax 等同于XMLHttpRequest，但细究起来它们两个是属于不同维度的 2 个概念。

以下是我认为对 Ajax 较为精确的解释：（摘自 what is Ajax）
AJAX stands for Asynchronous JavaScript and XML. AJAX is a new technique for creating better, faster, and more interactive web applications with the help of XML, HTML, CSS, and Java Script.

AJAX is based on the following open standards:

  • Browser-based presentation using HTML and Cascading Style Sheets (CSS).
  • Data is stored in XML format and fetched from the server.
  • Behind-the-scenes data fetches using XMLHttpRequest objects in the browser.
  • JavaScript to make everything happen.

从下面的解释中能够晓得：ajax是一种技术计划，但并不是一种新技术。它依赖的是现有的 CSS/HTML/Javascript，而其中最外围的依赖是浏览器提供的XMLHttpRequest 对象，是这个对象使得浏览器能够收回 HTTP 申请与接管 HTTP 响应。

所以我用一句话来总结两者的关系：咱们应用 XMLHttpRequest 对象来发送一个 Ajax 申请。

XMLHttpRequest的倒退历程

XMLHttpRequest一开始只是微软浏览器提供的一个接口，起初各大浏览器纷纷效仿也提供了这个接口，再起初 W3C 对它进行了标准化，提出了 XMLHttpRequest 规范。XMLHttpRequest规范又分为 Level 1 和Level 2。
XMLHttpRequest Level 1次要存在以下毛病：

  • 受同源策略的限度，不能发送跨域申请；
  • 不能发送二进制文件（如图片、视频、音频等），只能发送纯文本数据；
  • 在发送和获取数据的过程中，无奈实时获取进度信息，只能判断是否实现；

那么 Level 2 对Level 1 进行了改良，XMLHttpRequest Level 2中新增了以下性能：

  • 能够发送跨域申请，在服务端容许的状况下；
  • 反对发送和接管二进制数据；
  • 新增 formData 对象，反对发送表单数据；
  • 发送和获取数据时，能够获取进度信息；
  • 能够设置申请的超时工夫；

XMLHttpRequest兼容性

对于 xhr 的浏览器兼容性，大家能够间接查看“Can I use”这个网站提供的后果 XMLHttpRequest 兼容性，上面提供一个截图。

[图片上传失败 …(image-129fa5-1615342548990)]

从图中能够看到：

  • IE8/IE9、Opera Mini 齐全不反对 xhr 对象
  • IE10/IE11 局部反对，不反对 xhr.responseType为json
  • 局部浏览器不反对设置申请超时，即无奈应用xhr.timeout
  • 局部浏览器不反对 xhr.responseType 为blob

细说 XMLHttpRequest 如何应用

先来看一段应用 XMLHttpRequest 发送 Ajax 申请的简略示例代码。

function sendAjax() {  // 结构表单数据 var formData = new FormData(); formData.append('username', 'johndoe'); formData.append('id', 123456); // 创立 xhr 对象 var xhr = new XMLHttpRequest(); // 设置 xhr 申请的超时工夫 xhr.timeout = 3000; // 设置响应返回的数据格式 xhr.responseType = "text"; // 创立一个 post 申请，采纳异步 xhr.open('POST', '/server', true); // 注册相干事件回调处理函数 xhr.onload = function(e) {if(this.status == 200||this.status == 304){alert(this.responseText); } }; xhr.ontimeout = function(e) {...}; xhr.onerror = function(e) {...}; xhr.upload.onprogress = function(e) {...}; // 发送数据 xhr.send(formData); }

下面是一个应用 xhr 发送表单数据的示例，整个流程能够参考正文。

接下来我将站在使用者的角度，以问题的模式介绍 xhr 的根本应用。
我对每一个问题波及到的知识点都会进行比拟粗疏地介绍，有些知识点可能是你平时疏忽关注的。

如何设置 request header

在发送 Ajax 申请（本质是一个 HTTP 申请）时，咱们可能须要设置一些申请头部信息，比方 content-type、connection、cookie、accept-xxx 等。xhr提供了 setRequestHeader 来容许咱们批改申请 header。

void setRequestHeader(DOMString header, DOMString value);

留神点：

  • 办法的第一个参数 header 大小写不敏感，即能够写成content-type，也能够写成Content-Type，甚至写成content-Type;
  • Content-Type的默认值与具体发送的数据类型无关，请参考本文【能够发送什么类型的数据】一节；
  • setRequestHeader必须在 open() 办法之后，send()办法之前调用，否则会抛错；
  • setRequestHeader能够调用屡次，最终的值不会采纳笼罩 override 的形式，而是采纳追加 append 的形式。上面是一个示例代码：
var client = new XMLHttpRequest();client.open('GET', 'demo.cgi');client.setRequestHeader('X-Test', 'one'); client.setRequestHeader('X-Test', 'two'); // 最终 request header 中 "X-Test" 为: one, two client.send();

如何获取 response header

xhr提供了 2 个用来获取响应头部的办法：getAllResponseHeaders和 getResponseHeader。前者是获取 response 中的所有 header 字段，后者只是获取某个指定 header 字段的值。另外，getResponseHeader(header) 的header参数不辨别大小写。

DOMString getAllResponseHeaders();
DOMString getResponseHeader(DOMString header);

这 2 个办法看起来简略，但却处处是坑儿。

你是否遇到过上面的坑儿?——反正我是遇到了。。。

  1. 应用 getAllResponseHeaders() 看到的所有 response header 与理论在控制台 Network 中看到的 response header 不一样
  2. 应用 getResponseHeader() 获取某个 header 的值时，浏览器抛错Refused to get unsafe header "XXX"

通过一番寻找最终在 Stack Overflow 找到了答案。

  • 起因 1：W3C 的 xhr 规范中做了限度，规定客户端无奈获取 response 中的 Set-Cookie、Set-Cookie2这 2 个字段，无论是同域还是跨域申请；
  • 起因 2：W3C 的 cors 规范对于跨域申请也做了限度，规定对于跨域申请，客户端容许获取的 response header 字段只限于“simple response header”和“Access-Control-Expose-Headers”（两个名词的解释见下方）。

“simple response header“ 包含的 header 字段有：Cache-Control,Content-Language,Content-Type,Expires,Last-Modified,Pragma;
“Access-Control-Expose-Headers“：首先得留神是 ”Access-Control-Expose-Headers“ 进行跨域申请时响应头部中的一个字段，对于同域申请，响应头部是没有这个字段的。这个字段中列举的 header 字段就是服务器容许裸露给客户端拜访的字段。

所以 getAllResponseHeaders() 只能拿到 限度以外 （即被视为safe）的 header 字段，而不是全副字段；而调用getResponseHeader(header) 办法时，header参数必须是 限度以外 的 header 字段，否则调用就会报 Refused to get unsafe header 的谬误。

如何指定 xhr.response 的数据类型

有些时候咱们心愿 xhr.response 返回的就是咱们想要的数据类型。比方：响应返回的数据是纯 JSON 字符串，但咱们冀望最终通过 xhr.response 拿到的间接就是一个 js 对象，咱们该怎么实现呢？
有 2 种办法能够实现，一个是 level 1 就提供的 overrideMimeType() 办法，另一个是 level 2 才提供的 xhr.responseType 属性。

xhr.overrideMimeType()

overrideMimeType是 xhr level 1 就有的办法，所以浏览器兼容性良好。这个办法的作用就是用来重写 response 的content-type，这样做有什么意义呢？比方：server 端给客户端返回了一份 document 或者是 xml文档，咱们心愿最终通过 xhr.response 拿到的就是一个 DOM 对象，那么就能够用 xhr.overrideMimeType('text/xml; charset = utf-8') 来实现。

再举一个应用场景，咱们都晓得 xhr level 1 不反对间接传输 blob 二进制数据，那如果真要传输 blob 该怎么办呢？过后就是利用 overrideMimeType 办法来解决这个问题的。

上面是一个获取图片文件的代码示例：

var xhr = new XMLHttpRequest();// 向 server 端获取一张图片 xhr.open('GET', '/path/to/image.png', true); // 这行是要害！// 将响应数据依照纯文本格式来解析，字符集替换为用户本人定义的字符集 xhr.overrideMimeType('text/plain; charset=x-user-defined'); xhr.onreadystatechange = function(e) {if (this.readyState == 4 && this.status == 200) {// 通过 responseText 来获取图片文件对应的二进制字符串 var binStr = this.responseText; // 而后本人再想办法将一一字节还原为二进制数据 for (var i = 0, len = binStr.length; i < len; ++i) {var c = binStr.charCodeAt(i); //String.fromCharCode(c & 0xff); var byte = c & 0xff; } } }; xhr.send();

代码示例中 xhr 申请的是一张图片，通过将 response 的 content-type 改为 ’text/plain; charset=x-user-defined’，使得 xhr 以纯文本格式来解析接管到的 blob 数据，最终用户通过 this.responseText 拿到的就是图片文件对应的二进制字符串，最初再将其转换为 blob 数据。

xhr.responseType

responseType是 xhr level 2 新增的属性，用来指定 xhr.response 的数据类型，目前还存在些兼容性问题，能够参考本文的【XMLHttpRequest的兼容性】这一大节。那么 responseType 能够设置为哪些格局呢，我简略做了一个表，如下：

值 xhr.response 数据类型 阐明
"" String字符串 默认值 (在不设置responseType 时)
"text" String字符串
"document" Document对象 心愿返回 XML 格局数据时应用
"json" javascript 对象 存在兼容性问题，IE10/IE11 不反对
"blob" Blob对象
"arrayBuffer" ArrayBuffer对象

上面是同样是获取一张图片的代码示例，相比 xhr.overrideMimeType, 用xhr.response 来实现简略得多。

var xhr = new XMLHttpRequest();xhr.open('GET', '/path/to/image.png', true); // 能够将 `xhr.responseType` 设置为 `"blob"` 也能够设置为 `"arrayBuffer"` //xhr.responseType = 'arrayBuffer'; xhr.responseType = 'blob'; xhr.onload = function(e) {if (this.status == 200) {var blob = this.response; ...} }; xhr.send();

小结

尽管在 xhr level 2 中，2 者是独特存在的。但其实不难发现，xhr.responseType就是用来取代 xhr.overrideMimeType() 的，xhr.responseType功能强大的多，xhr.overrideMimeType()能做到的 xhr.responseType 都能做到。所以咱们当初齐全能够摒弃应用 xhr.overrideMimeType() 了。

如何获取 response 数据

xhr提供了 3 个属性来获取申请返回的数据，别离是：xhr.response、xhr.responseText、xhr.responseXML

  • xhr.response

    • 默认值：空字符串""
    • 当申请实现时，此属性才有正确的值
    • 申请未实现时，此属性的值可能是 "" 或者 null，具体与 xhr.responseType无关：当 responseType 为""或 "text" 时，值为 ""；responseType 为其余值时，值为 null

  • xhr.responseText

    • 默认值为空字符串""
    • 只有当 responseType 为 "text"、"" 时，xhr对象上才有此属性，此时能力调用xhr.responseText，否则抛错
    • 只有当申请胜利时，能力拿到正确值。以下 2 种状况下值都为空字符串""：申请未实现、申请失败

  • xhr.responseXML

    • 默认值为 null
    • 只有当 responseType 为 "text"、""、"document" 时，xhr对象上才有此属性，此时能力调用xhr.responseXML，否则抛错
    • 只有当申请胜利且返回数据被正确解析时，能力拿到正确值。以下 3 种状况下值都为null：申请未实现、申请失败、申请胜利但返回数据无奈被正确解析时

如何追踪 ajax 申请的以后状态

在发一个 ajax 申请后，如果想追踪申请以后处于哪种状态，该怎么做呢？

用 xhr.readyState 这个属性即可追踪到。这个属性是只读属性，总共有 5 种可能值，别离对应 xhr 不同的不同阶段。每次 xhr.readyState 的值发生变化时，都会触发 xhr.onreadystatechange 事件，咱们能够在这个事件中进行相干状态判断。

  xhr.onreadystatechange = function () {    switch(xhr.readyState){case 1://OPENED //do something break; case 2://HEADERS_RECEIVED //do something break; case 3://LOADING //do something break; case 4://DONE //do something break;}
值 状态 形容
0 UNSENT (初始状态，未关上) 此时 xhr 对象被胜利结构，open()办法还未被调用
1 OPENED (已关上，未发送) open()办法已被胜利调用，send()办法还未被调用。留神：只有 xhr 处于 OPENED 状态，能力调用 xhr.setRequestHeader() 和xhr.send(), 否则会报错
2 HEADERS_RECEIVED(已获取响应头) send()办法曾经被调用, 响应头和响应状态曾经返回
3 LOADING (正在下载响应体) 响应体 (response entity body) 正在下载中，此状态下通过 xhr.response 可能曾经有了响应数据
4 DONE (整个数据传输过程完结) 整个数据传输过程完结，不论本次申请是胜利还是失败

如何设置申请的超时工夫

如果申请过了很久还没有胜利，为了不会白白占用的网络资源，咱们个别会被动终止申请。XMLHttpRequest提供了 timeout 属性来容许设置申请的超时工夫。

xhr.timeout

单位：milliseconds 毫秒
默认值：0，即不设置超时

很多同学都晓得：从 申请开始 算起，若超过 timeout 工夫申请还没有完结（包含胜利 / 失败），则会触发 ontimeout 事件，被动完结该申请。

【那么到底什么时候才算是 申请开始 ？】
——xhr.onloadstart 事件触发的时候，也就是你调用 xhr.send() 办法的时候。
因为 xhr.open() 只是创立了一个连贯，但并没有真正开始数据的传输，而 xhr.send() 才是真正开始了数据的传输过程。只有调用了xhr.send()，才会触发xhr.onloadstart。

【那么什么时候才算是 申请完结 ？】
—— xhr.loadend 事件触发的时候。

另外，还有 2 个须要留神的坑儿：

  1. 能够在 send()之后再设置此 xhr.timeout，但计时起始点仍为调用xhr.send() 办法的时刻。
  2. 当 xhr 为一个 sync 同步申请时，xhr.timeout必须置为0，否则会抛错。起因能够参考本文的【如何发一个同步申请】一节。

如何发一个同步申请

xhr默认发的是异步申请，但也反对发同步申请（当然理论开发中应该尽量避免应用）。到底是异步还是同步申请，由 xhr.open（） 传入的 async 参数决定。

open(method, url [, async = true [, username = null [, password = null]]])

  • method: 申请的形式，如 GET/POST/HEADER 等，这个参数不辨别大小写
  • url: 申请的地址，能够是绝对地址如 example.php，这个绝对是绝对于以后网页的url 门路；也能够是相对地址如http://www.example.com/example.php
  • async: 默认值为true，即为异步申请，若async=false，则为同步申请

在我认真研读 W3C 的 xhr 规范前，我总以为同步申请和异步申请只是阻塞和非阻塞的区别，其余什么事件触发、参数设置应该是一样的，事实证明我错了。

W3C 的 xhr 规范中对于 open() 办法有这样一段阐明：

Throws an “InvalidAccessError” exception if async is false, the JavaScript global environment is a document environment, and either the timeout attribute is not zero, the withCredentials attribute is true, or the responseType attribute is not the empty string.

从下面一段阐明能够晓得，当 xhr 为同步申请时，有如下限度：

  • xhr.timeout必须为0
  • xhr.withCredentials必须为 false
  • xhr.responseType必须为 ""（留神置为"text" 也不容许）

若下面任何一个限度不满足，都会抛错，而对于异步申请，则没有这些参数设置上的限度。

之前说过页面中应该尽量避免应用 sync 同步申请，为什么呢？
因为咱们无奈设置申请超时工夫（xhr.timeout为 0，即不限时）。在不限度超时的状况下，有可能同步申请始终处于pending 状态，服务端迟迟不返回响应，这样整个页面就会始终阻塞，无奈响应用户的其余交互。

另外，规范中并没有提及同步申请时事件触发的限度，但理论开发中我的确遇到过局部应该触发的事件并没有触发的景象。如在 chrome 中，当 xhr 为同步申请时，在 xhr.readyState 由2变成 3 时，并不会触发 onreadystatechange事件，xhr.upload.onprogress和 xhr.onprogress事件也不会触发。

如何获取上传、下载的进度

在上传或者下载比拟大的文件时，实时显示以后的上传、下载进度是很广泛的产品需要。
咱们能够通过 onprogress 事件来实时显示进度，默认状况下这个事件每 50ms 触发一次。须要留神的是，上传过程和下载过程触发的是不同对象的 onprogress 事件：

  • 上传触发的是 xhr.upload 对象的 onprogress事件
  • 下载触发的是 xhr 对象的 onprogress 事件
xhr.onprogress = updateProgress;xhr.upload.onprogress = updateProgress;function updateProgress(event) {if (event.lengthComputable) {var completedPercent = event.loaded / event.total;} }

能够发送什么类型的数据

void send(data);

xhr.send(data)的参数 data 能够是以下几种类型：

  • ArrayBuffer
  • Blob
  • Document
  • DOMString
  • FormData
  • null

如果是 GET/HEAD 申请，send()办法个别不传参或传 null。不过即便你真传入了参数，参数也最终被疏忽，xhr.send(data)中的 data 会被置为 null.

xhr.send(data)中 data 参数的数据类型会影响申请头部 content-type 的默认值：

  • 如果 data 是 Document 类型，同时也是 HTML Document 类型，则 content-type 默认值为text/html;charset=UTF-8; 否则为application/xml;charset=UTF-8；
  • 如果 data 是 DOMString 类型，content-type默认值为text/plain;charset=UTF-8；
  • 如果 data 是 FormData 类型，content-type默认值为multipart/form-data; boundary=[xxx]
  • 如果 data 是其余类型，则不会设置 content-type 的默认值

当然这些只是 content-type 的默认值，但如果用 xhr.setRequestHeader() 手动设置了中 content-type 的值，以上默认值就会被笼罩。

另外须要留神的是，若在断网状态下调用 xhr.send(data) 办法，则会抛错：Uncaught NetworkError: Failed to execute 'send' on 'XMLHttpRequest'。一旦程序抛出谬误，如果不 catch 就无奈继续执行前面的代码，所以调用 xhr.send(data)办法时，应该用 try-catch捕获谬误。

try{xhr.send(data)  }catch(e) {//doSomething...};

xhr.withCredentials与 CORS 什么关系

咱们都晓得，在发同域申请时，浏览器会将 cookie 主动加在 request header 中。但大家是否遇到过这样的场景：在发送跨域申请时，cookie并没有主动加在 request header 中。

造成这个问题的起因是：在 CORS 规范中做了规定，默认状况下，浏览器在发送跨域申请时，不能发送任何认证信息（credentials）如 ”cookies“ 和 ”HTTP authentication schemes“。除非 xhr.withCredentials 为true（xhr对象有一个属性叫withCredentials，默认值为false）。

所以根本原因是 cookies 也是一种认证信息，在跨域申请中，client端必须手动设置 xhr.withCredentials=true，且server 端也必须容许 request 能携带认证信息（即 response header 中蕴含 Access-Control-Allow-Credentials:true），这样浏览器才会主动将cookie 加在 request header 中。

另外，要特地留神一点，一旦跨域 request 可能携带认证信息，server端肯定不能将 Access-Control-Allow-Origin 设置为*，而必须设置为申请页面的域名。

xhr相干事件

事件分类

xhr相干事件有很多，有时记起来还挺容易凌乱。但当我理解了具体代码实现后，就容易理分明了。上面是 XMLHttpRequest 的局部实现代码：

interface XMLHttpRequestEventTarget : EventTarget {// event handlers attribute EventHandler onloadstart; attribute EventHandler onprogress; attribute EventHandler onabort; attribute EventHandler onerror; attribute EventHandler onload; attribute EventHandler ontimeout; attribute EventHandler onloadend;}; interface XMLHttpRequestUpload : XMLHttpRequestEventTarget {}; interface XMLHttpRequest : XMLHttpRequestEventTarget { // event handler attribute EventHandler onreadystatechange; readonly attribute XMLHttpRequestUpload upload;};

从代码中咱们能够看出：

  1. XMLHttpRequestEventTarget接口定义了 7 个事件：

    • onloadstart
    • onprogress
    • onabort
    • ontimeout
    • onerror
    • onload
    • onloadend
  2. 每一个 XMLHttpRequest 外面都有一个 upload 属性，而 upload 是一个 XMLHttpRequestUpload 对象
  3. XMLHttpRequest和 XMLHttpRequestUpload 都继承了同一个 XMLHttpRequestEventTarget 接口，所以 xhr 和xhr.upload都有第一条列举的 7 个事件
  4. onreadystatechange是 XMLHttpRequest 独有的事件

所以这么一看就很清晰了：
xhr一共有 8 个相干事件：7 个 XMLHttpRequestEventTarget 事件 + 1 个独有的 onreadystatechange 事件；而 xhr.upload 只有 7 个 XMLHttpRequestEventTarget 事件。

事件触发条件

上面是我本人整顿的一张 xhr 相干事件触发条件表，其中最须要留神的是 onerror 事件的触发条件。

事件 触发条件
onreadystatechange 每当 xhr.readyState 扭转时触发；但 xhr.readyState 由非 0 值变为 0 时不触发。
onloadstart 调用 xhr.send() 办法后立刻触发，若 xhr.send() 未被调用则不会触发此事件。
onprogress xhr.upload.onprogress在上传阶段 (即xhr.send() 之后，xhr.readystate=2之前)触发，每 50ms 触发一次；xhr.onprogress在下载阶段（即 xhr.readystate=3 时）触发，每 50ms 触发一次。
onload 当申请胜利实现时触发，此时xhr.readystate=4
onloadend 当申请完结（包含申请胜利和申请失败）时触发
onabort 当调用 xhr.abort() 后触发
ontimeout xhr.timeout不等于 0，由申请开始即 onloadstart 开始算起，当达到 xhr.timeout 所设置工夫申请还未完结即onloadend，则触发此事件。
onerror 在申请过程中，若产生 Network error 则会触发此事件（若产生 Network error 时，上传还没有完结，则会先触发 xhr.upload.onerror，再触发xhr.onerror；若产生Network error 时，上传曾经完结，则只会触发 xhr.onerror）。留神，只有产生了网络层级别的异样才会触发此事件，对于应用层级别的异样，如响应返回的xhr.statusCode 是4xx时，并不属于 Network error，所以不会触发onerror 事件，而是会触发 onload 事件。

事件触发程序

当申请一切正常时，相干的事件触发程序如下：

  1. 触发 xhr.onreadystatechange(之后每次readyState 变动时，都会触发一次)
  2. 触发xhr.onloadstart
    // 上传阶段开始：
  3. 触发xhr.upload.onloadstart
  4. 触发xhr.upload.onprogress
  5. 触发xhr.upload.onload
  6. 触发xhr.upload.onloadend
    // 上传完结，下载阶段开始：
  7. 触发xhr.onprogress
  8. 触发xhr.onload
  9. 触发xhr.onloadend

产生 abort/timeout/error 异样的解决

在申请的过程中，有可能产生 abort/timeout/error这 3 种异样。那么一旦产生这些异样，xhr后续会进行哪些解决呢？后续解决如下：

  1. 一旦产生 abort 或timeout或 error 异样，先立刻停止以后申请
  2. 将 readystate 置为 4，并触发 xhr.onreadystatechange 事件

  3. 如果上传阶段还没有完结，则顺次触发以下事件：

    • xhr.upload.onprogress
    • xhr.upload.[onabort 或 ontimeout 或 onerror]
    • xhr.upload.onloadend
  4. 触发 xhr.onprogress事件
  5. 触发 xhr.[onabort 或 ontimeout 或 onerror]事件
  6. 触发xhr.onloadend 事件

在哪个 xhr 事件中注册胜利回调？

从下面介绍的事件中，能够晓得若 xhr 申请胜利，就会触发 xhr.onreadystatechange 和xhr.onload两个事件。那么咱们到底要将胜利回调注册在哪个事件中呢？我偏向于 xhr.onload事件，因为 xhr.onreadystatechange 是每次 xhr.readyState 变动时都会触发，而不是 xhr.readyState=4 时才触发。

xhr.onload = function () {    // 如果申请胜利    if(xhr.status == 200){//do successCallback} }

下面的示例代码是很常见的写法：先判断 http 状态码是否是 200，如果是，则认为申请是胜利的，接着执行胜利回调。这样的判断是有坑儿的，比方当返回的http 状态码不是 200，而是201 时，申请尽管也是胜利的，但并没有执行胜利回调逻辑。所以更靠谱的判断办法应该是：当 http 状态码为 2xx 或304时才认为胜利。

  xhr.onload = function () {    // 如果申请胜利    if((xhr.status >= 200 && xhr.status < 300) || xhr.status == 304){//do successCallback} }

结语

终于写完了 ……
心愿这篇总结能帮忙刚开始接触 XMLHttpRequest 的你。

退出移动版