13日 四月 2020

XMLHttpRequest

XMLHttpRequest 是一个内建的浏览器对象,它允许使用 JavaScript 发送 HTTP 请求。

虽然它的名字里面有 “XML” 一词,但它可以操作任何数据,而不仅仅是 XML 格式。我们可以用它来上传/下载文件,跟踪进度等。

现如今,我们有一个更为现代的方法叫做 fetch,它的出现使得 XMLHttpRequest 在某种程度上被弃用。

在现代 Web 开发中,出于以下三种原因,我们还在使用 XMLHttpRequest

  1. 历史原因:我们需要支持现有的使用了 XMLHttpRequest 的脚本。
  2. 我们需要兼容旧浏览器,并且不想用 polyfill(例如为了使脚本更小)。
  3. 我们需要做一些 fetch 目前无法做到的事情,例如跟踪上传进度。

这些话听起来熟悉吗?如果是,那么请继续阅读下面的 XMLHttpRequest 相关内容吧。如果还不是很熟悉的话,那么请先阅读 Fetch 一章的内容。

XMLHttpRequest 基础

XMLHttpRequest 有两种执行模式:同步(synchronous)和异步(asynchronous)。

我们首先来看看最常用的异步模式:

要发送请求,需要 3 个步骤:

  1. 创建 XMLHttpRequest

    let xhr = new XMLHttpRequest();

    此构造器没有参数。

  2. 初始化它,通常就在 new XMLHttpRequest 之后:

    xhr.open(method, URL, [async, user, password])

    此方法指定请求的主要参数:

    • method —— HTTP 方法。通常是 "GET""POST"
    • URL —— 要请求的 URL,通常是一个字符串,也可以是 URL 对象。
    • async —— 如果显式地设置为 false,那么请求将会以同步的方式处理,我们稍后会讲到它。
    • userpassword —— HTTP 基本身份验证(如果需要的话)的登录名和密码。

    请注意,open 调用与其名称相反,不会建立连接。它仅配置请求,而网络活动仅以 send 调用开启。

  3. 发送请求。

    xhr.send([body])

    这个方法会建立连接,并将请求发送到服务器。可选参数 body 包含了 request body。

    一些请求方法,像 GET 没有 request body。还有一些请求方法,像 POST 使用 body 将数据发送到服务器。我们稍后会看到相应示例。

  4. 监听 xhr 事件以获取响应。

    这三个事件是最常用的:

    • load —— 当请求完成(即使 HTTP 状态为 400 或 500 等),并且响应已完全下载。
    • error —— 当无法发出请求,例如网络中断或者无效的 URL。
    • progress —— 在下载响应期间定期触发,报告已经下载了多少。
    xhr.onload = function() {
      alert(`Loaded: ${xhr.status} ${xhr.response}`);
    };
    
    xhr.onerror = function() { // 仅在根本无法发出请求时触发
      alert(`Network Error`);
    };
    
    xhr.onprogress = function(event) { // 定期触发
      // event.loaded —— 已经下载了多少字节
      // event.lengthComputable = true,当服务器发送了 Content-Length header 时
      // event.total —— 总字节数(如果 lengthComputable 为 true)
      alert(`Received ${event.loaded} of ${event.total}`);
    };

下面是一个完整的示例。它从服务器加载 /article/xmlhttprequest/example/load,并打印加载进度:

// 1. 创建一个 new XMLHttpRequest 对象
let xhr = new XMLHttpRequest();

// 2. 配置它:从 URL /article/.../load GET-request
xhr.open('GET', '/article/xmlhttprequest/example/load');

// 3. 通过网络发送请求
xhr.send();

// 4. 当接收到响应后,将调用此函数
xhr.onload = function() {
  if (xhr.status != 200) { // 分析响应的 HTTP 状态
    alert(`Error ${xhr.status}: ${xhr.statusText}`); // 例如 404: Not Found
  } else { // 显示结果
    alert(`Done, got ${xhr.response.length} bytes`); // response 是服务器响应
  }
};

xhr.onprogress = function(event) {
  if (event.lengthComputable) {
    alert(`Received ${event.loaded} of ${event.total} bytes`);
  } else {
    alert(`Received ${event.loaded} bytes`); // 没有 Content-Length
  }

};

xhr.onerror = function() {
  alert("Request failed");
};

一旦服务器有了响应,我们可以在以下 xhr 属性中接收结果:

status
HTTP 状态码(一个数字):200404403 等,如果出现非 HTTP 错误,则为 0
statusText
HTTP 状态消息(一个字符串):状态码为 200 对应于 OK404 对应于 Not Found403 对应于 Forbidden
response(旧脚本可能用的是 responseText
服务器 response body。

我们还可以使用相应的属性指定超时(timeout):

xhr.timeout = 10000; // timeout 单位是 ms,此处即 10 秒

如果在给定时间内请求没有成功执行,请求就会被取消,并且触发 timeout 事件。

URL 搜索参数(URL search parameters)

为了向 URL 添加像 ?name=value 这样的参数,并确保正确的编码,我们可以使用 URL 对象:

let url = new URL('https://google.com/search');
url.searchParams.set('q', 'test me!');

// 参数 'q' 被编码
xhr.open('GET', url); // https://google.com/search?q=test+me%21

响应类型

我们可以使用 xhr.responseType 属性来设置响应格式:

  • ""(默认)—— 响应格式为字符串,
  • "text" —— 响应格式为字符串,
  • "arraybuffer" —— 响应格式为 ArrayBuffer(对于二进制数据,请参见 ArrayBuffer,二进制数组),
  • "blob" —— 响应格式为 Blob(对于二进制数据,请参见 Blob),
  • "document" —— 响应格式为 XML document(可以使用 XPath 和其他 XML 方法),
  • "json" —— 响应格式为 JSON(自动解析)。

例如,我们以 JSON 格式获取响应:

let xhr = new XMLHttpRequest();

xhr.open('GET', '/article/xmlhttprequest/example/json');

xhr.responseType = 'json';

xhr.send();

// 响应为 {"message": "Hello, world!"}
xhr.onload = function() {
  let responseObj = xhr.response;
  alert(responseObj.message); // Hello, world!
};
请注意:

在旧的脚本中,你可能会看到 xhr.responseText,甚至会看到 xhr.responseXML 属性。

它们是由于历史原因而存在的,以获取字符串或 XML 文档。如今,我们应该在 xhr.responseType 中设置格式,然后就能获取如上所示的 xhr.response 了。

readyState

XMLHttpRequest 的状态(state)会随着它的处理进度变化而变化。可以通过 xhr.readyState 来了解当前状态。

规范 中提到的所有状态如下:

UNSENT = 0; // 初始状态
OPENED = 1; // open 被调用
HEADERS_RECEIVED = 2; // 接收到 response header
LOADING = 3; // 响应正在被加载(接收到一个数据包)
DONE = 4; // 请求完成

XMLHttpRequest 对象以 0123 → … → 34 的顺序在它们之间转变。每当通过网络接收到一个数据包,就会重复一次状态 3

我们可以使用 readystatechange 事件来跟踪它们:

xhr.onreadystatechange = function() {
  if (xhr.readyState == 3) {
    // 加载中
  }
  if (xhr.readyState == 4) {
    // 请求完成
  }
};

你可能在非常老的代码中找到 readystatechange 这样的事件监听器,它的存在是有历史原因的,因为曾经有很长一段时间都没有 load 以及其他事件。如今,它已被 load/error/progress 事件处理程序所替代。

中止请求(Aborting)

我们可以随时终止请求。调用 xhr.abort() 即可:

xhr.abort(); // 终止请求

它会触发 abort 事件,且 xhr.status 变为 0

同步请求

如果在 open 方法中将第三个参数 async 设置为 false,那么请求就会以同步的方式进行。

换句话说,JavaScript 执行在 send() 处暂停,并在收到响应后恢复执行。这有点儿像 alertprompt 命令。

下面是重写的示例,open 的第三个参数为 false

let xhr = new XMLHttpRequest();

xhr.open('GET', '/article/xmlhttprequest/hello.txt', false);

try {
  xhr.send();
  if (xhr.status != 200) {
    alert(`Error ${xhr.status}: ${xhr.statusText}`);
  } else {
    alert(xhr.response);
  }
} catch(err) { // 代替 onerror
  alert("Request failed");
}

这看起来好像不错,但是很少使用同步调用,因为它们会阻塞页面内的 JavaScript,直到加载完成。在某些浏览器中,滚动可能无法正常进行。如果一个同步调用执行时间过长,浏览器可能会建议关闭“挂起(hanging)”的网页。

XMLHttpRequest 的很多高级功能在同步请求中都不可用,例如向其他域发起请求或者设置超时。并且,正如你所看到的,没有进度指示。

基于这些原因,同步请求使用的非常少,几乎从不使用。在这我们就不再讨论它了。

HTTP-header

XMLHttpRequest 允许发送自定义 header,并且可以从响应中读取 header。

HTTP-header 有三种方法:

setRequestHeader(name, value)

使用给定的 namevalue 设置 request header。

例如:

xhr.setRequestHeader('Content-Type', 'application/json');
Header 的限制

一些 header 是由浏览器专门管理的,例如 RefererHost。 完整列表请见 规范

为了用户安全和请求的正确性,XMLHttpRequest 不允许更改它们。

不能移除 header

XMLHttpRequest 的另一个特点是不能撤销 setRequestHeader

一旦设置了 header,就无法撤销了。其他调用会向 header 中添加信息,但不会覆盖它。

例如:

xhr.setRequestHeader('X-Auth', '123');
xhr.setRequestHeader('X-Auth', '456');

// header 将是:
// X-Auth: 123, 456
getResponseHeader(name)

获取具有给定 name 的 header(Set-CookieSet-Cookie2 除外)。

例如:

xhr.getResponseHeader('Content-Type')
getAllResponseHeaders()

返回除 Set-CookieSet-Cookie2 外的所有 response header。

header 以单行形式返回,例如:

Cache-Control: max-age=31536000
Content-Length: 4260
Content-Type: image/png
Date: Sat, 08 Sep 2012 16:53:16 GMT

header 之间的换行符始终为 "\r\n"(不依赖于操作系统),所以我们可以很容易地将其拆分为单独的 header。name 和 value 之间总是以冒号后跟一个空格 ": " 分隔。这是标准格式。

因此,如果我们想要获取具有 name/value 对的对象,则需要用一点 JavaScript 代码来处理它们。

像这样(假设如果两个 header 具有相同的名称,那么后者就会覆盖前者):

let headers = xhr
  .getAllResponseHeaders()
  .split('\r\n')
  .reduce((result, current) => {
    let [name, value] = current.split(': ');
    result[name] = value;
    return result;
  }, {});

// headers['Content-Type'] = 'image/png'

POST,FormData

要建立一个 POST 请求,我们可以使用内建的 FormData 对象。

语法为:

let formData = new FormData([form]); // 创建一个对象,可以选择从 <form> 中获取数据
formData.append(name, value); // 附加一个字段

我们创建它,可以选择从一个表单中获取数据,如果需要,还可以 append 更多字段,然后:

  1. xhr.open('POST', ...) —— 使用 POST 方法。
  2. xhr.send(formData) 将表单发送到服务器。

例如:

<form name="person">
  <input name="name" value="John">
  <input name="surname" value="Smith">
</form>

<script>
  // 从表单预填充 FormData
  let formData = new FormData(document.forms.person);

  // 附加一个字段
  formData.append("middle", "Lee");

  // 将其发送出去
  let xhr = new XMLHttpRequest();
  xhr.open("POST", "/article/xmlhttprequest/post/user");
  xhr.send(formData);

  xhr.onload = () => alert(xhr.response);
</script>

multipart/form-data 编码发送表单。

或者,如果我们更喜欢 JSON,那么可以使用 JSON.stringify 并以字符串形式发送。

只是,不要忘记设置 header Content-Type: application/json,只要有了它,很多服务端框架都能自动解码 JSON:

let xhr = new XMLHttpRequest();

let json = JSON.stringify({
  name: "John",
  surname: "Smith"
});

xhr.open("POST", '/submit')
xhr.setRequestHeader('Content-type', 'application/json; charset=utf-8');

xhr.send(json);

.send(body) 方法就像一个非常杂食性的动物。它几乎可以发送任何 body,包括 BlobBufferSource 对象。

上传进度

progress 事件仅在下载阶段触发。

也就是说:如果我们 POST 一些内容,XMLHttpRequest 首先上传我们的数据(request body),然后下载响应。

如果我们要上传的东西很大,那么我们肯定会对跟踪上传进度感兴趣。但是 xhr.onprogress 在这里并不起作用。

这里有另一个对象,它没有方法,它专门用于跟踪上传事件:xhr.upload

它会生成事件,类似于 xhr,但是 xhr.upload 仅在上传时触发它们:

  • loadstart —— 上传开始。
  • progress —— 上传期间定期触发。
  • abort —— 上传中止。
  • error —— 非 HTTP 错误。
  • load —— 上传成功完成。
  • timeout —— 上传超时(如果设置了 timeout 属性)。
  • loadend —— 上传完成,无论成功还是 error。

handler 示例:

xhr.upload.onprogress = function(event) {
  alert(`Uploaded ${event.loaded} of ${event.total} bytes`);
};

xhr.upload.onload = function() {
  alert(`Upload finished successfully.`);
};

xhr.upload.onerror = function() {
  alert(`Error during the upload: ${xhr.status}`);
};

这是一个真实示例:带有进度指示的文件上传:

<input type="file" onchange="upload(this.files[0])">

<script>
function upload(file) {
  let xhr = new XMLHttpRequest();

  // 跟踪上传进度
  xhr.upload.onprogress = function(event) {
    console.log(`Uploaded ${event.loaded} of ${event.total}`);
  };

  // 跟踪完成:无论成功与否
  xhr.onloadend = function() {
    if (xhr.status == 200) {
      console.log("success");
    } else {
      console.log("error " + this.status);
    }
  };

  xhr.open("POST", "/article/xmlhttprequest/post/upload");
  xhr.send(file);
}
</script>

跨源请求

XMLHttpRequest 可以使用和 fetch 相同的 CORS 策略进行跨源请求。

就像 fetch 一样,默认情况下不会将 cookie 和 HTTP 授权发送到其他域。要启用它们,可以将 xhr.withCredentials 设置为 true

let xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.open('POST', 'http://anywhere.com/request');
...

有关跨源 header 的详细信息,请见 Fetch:跨源请求 一章。

总结

使用 XMLHttpRequest 的 GET 请求的典型代码:

let xhr = new XMLHttpRequest();

xhr.open('GET', '/my/url');

xhr.send();

xhr.onload = function() {
  if (xhr.status != 200) { // HTTP error?
    // 处理 error
    alert( 'Error: ' + xhr.status);
    return;
  }

  // 获取来自 xhr.response 的响应
};

xhr.onprogress = function(event) {
  // 报告进度
  alert(`Loaded ${event.loaded} of ${event.total}`);
};

xhr.onerror = function() {
  // 处理非 HTTP error(例如网络中断)
};

实际上还有很多事件,在 现代规范 中有详细列表(按生命周期排序):

  • loadstart —— 请求开始。
  • progress —— 一个响应数据包到达,此时整个 response body 都在 response 中。
  • abort —— 调用 xhr.abort() 取消了请求。
  • error —— 发生连接错误,例如,域错误。不会发生诸如 404 这类的 HTTP 错误。
  • load —— 请求成功完成。
  • timeout —— 由于请求超时而取消了该请求(仅发生在设置了 timeout 的情况下)。
  • loadend —— 在 loaderrortimeoutabort 之后触发。

erroraborttimeoutload 事件是互斥的。其中只有一种可能发生。

最常用的事件是加载完成(load),加载失败(error),或者我们可以使用单个 loadend 处理程序并检查请求对象 xhr 的属性,以查看发生了什么。

我们还了解了另一个事件:readystatechange。由于历史原因,它早在规范制定之前就出现了。如今我们已经无需使用它了,我们可以用新的事件代替它,但通常可以在旧的代码中找到它。

如果我们需要专门跟踪上传,那么我们应该在 xhr.upload 对象上监听相同的事件。

教程路线图

评论

在评论之前先阅读本内容…
  • 如果你发现教程有错误,或者有其他需要修改和提升的地方 — 请 提交一个 GitHub issue 或 pull request,而不是在这评论。
  • 如果你对教程的内容有不理解的地方 — 请详细说明。
  • 使用 <code> 标签插入只有几个词的代码,插入多行代码可以使用 <pre> 标签,对于超过 10 行的代码,建议你使用沙箱(plnkrJSBincodepen…)