Ajax之魂-WEB中的XMLHttpRequest规范

写在前面

本篇主要内容是结合“XMLHttpRequest Level 1”规范和w3school网站中针对XML DOM - XMLHttpRequest 对象的介绍写的，其中大量的代码段都是来自于XMLHttpRequest Level 1规范。由于英语水平有限，如有翻译错误或理解偏差之处，请告知。

简介

XMLHttpRequest 对象是一组获取资源的API。

XMLHttpRequest 对象提供了对 HTTP 协议的完全的访问，包括做出 POST 和 HEAD 请求以及普通的 GET 请求的能力。XMLHttpRequest 可以同步或异步地返回 Web 服务器的响应，并且能够以文本或者一个 DOM 文档的形式返回内容。

这个对象的名称“XMLHttpRequest”中的每个组件（XML，Http，Request）都非常具有误导性，之所以取这个名称更多的是为了适合Web。之所以说这个名称具有误导性主要有以下三点：
首先，这个对象支持任何基于文本（TEXT）的数据格式，包括XML；
其次、可以使用它创建基于HTTP和HTTPS协议（有些实现还支持其他协议，但这不属于本规范）的请求（Request）；
最后，它支持HTTP协议中所有的方法，并且可以处理Response响应。

浏览器兼容性

XMLHttpRequest 得到了所有现代浏览器较好的支持。唯一的浏览器依赖性涉及 XMLHttpRequest 对象的创建。在 IE 5 和 IE 6 中，必须使用特定于 IE 的 ActiveXObject() 构造函数。IE7及更高版本的IE对XMLHttpRequest对象的创建与其他浏览器（Chrome，Firefox等）一样。

XMLHttpRequest 接口定义

下来的代码来自W3C的“XMLHttpRequest Level 1”规范。

[NoInterfaceObject]
interface XMLHttpRequestEventTarget : EventTarget {
  // 事件句柄
  attribute EventHandler onloadstart;
  attribute EventHandler onprogress;
  attribute EventHandler onabort;
  attribute EventHandler onerror;
  attribute EventHandler onload;
  attribute EventHandler ontimeout;
  attribute EventHandler onloadend;
};

interface XMLHttpRequestUpload : XMLHttpRequestEventTarget {

};

enum XMLHttpRequestResponseType {
  "",
  "arraybuffer",
  "blob",
  "document",
  "json",
  "text"
};

[Constructor]
interface XMLHttpRequest : XMLHttpRequestEventTarget {
  // event handler
  attribute EventHandler onreadystatechange;

  // states
  const unsigned short UNSENT = 0;
  const unsigned short OPENED = 1;
  const unsigned short HEADERS_RECEIVED = 2;
  const unsigned short LOADING = 3;
  const unsigned short DONE = 4;
  readonly attribute unsigned short readyState;

  // request
  void open(ByteString method, [EnsureUTF16] DOMString url);
  void open(ByteString method, [EnsureUTF16] DOMString url, boolean async, optional [EnsureUTF16] DOMString? username = null, optional [EnsureUTF16] DOMString? password = null);
  void setRequestHeader(ByteString header, ByteString value);
           attribute unsigned long timeout;
           attribute boolean withCredentials;
  readonly attribute XMLHttpRequestUpload upload;
  void send(optional (ArrayBufferView or Blob or Document or [EnsureUTF16] DOMString or FormData)? data = null);
  void abort();

  // response
  readonly attribute unsigned short status;
  readonly attribute ByteString statusText;
  ByteString? getResponseHeader(ByteString header);
  ByteString getAllResponseHeaders();
  void overrideMimeType(DOMString mime);
           attribute XMLHttpRequestResponseType responseType;
  readonly attribute any response;
  readonly attribute DOMString responseText;
  readonly attribute Document? responseXML;
};

每一个XMLHttpRequest对象都有一个唯一XMLHttpRequestUpload对象与之相关联。

如何创建XMLHttpRequest对象

在浏览器兼容性一节中已经介绍过，所有现代浏览器创建XMLHttpRequest的方法已经统一了，如下代码所示。

client= newXMLHttpRequest();
// 返回一个XMLHttpRequest对象

XMLHttpRequest对象的属性

关于XMLHttpRequest 对象的属性，在W3School中的介绍对程序员来说更有参考价值，而“XMLHttpRequest Level 1规范”中的介绍更适合XMLHttpRequest对象的实现者研读。下面的介绍多来自于W3School。

readyState

HTTP 请求的状态.当一个 XMLHttpRequest 初次创建时，这个属性的值从 0 开始，直到接收到完整的 HTTP 响应，这个值增加到 4。

5 个状态中每一个都有一个相关联的非正式的名称，下表列出了状态、名称和含义：

| 状态 | 名称 | 描述 |
| -- | -- | --| -- |
| 0 | Uninitialized | 初始化状态。XMLHttpRequest 对象已创建或已被 abort() 方法重置。|
| 1 | Open | open() 方法已调用，但是 send() 方法未调用。请求还没有被发送。|
| 2 | Sent | Send() 方法已调用，HTTP 请求已发送到 Web 服务器。未接收到响应。|
| 3 | Receiving | 所有响应头部都已经接收到。响应体开始接收但未完成。|
| 4 | Loaded | HTTP 响应已经完全接收。|

readyState 的值不会递减，除非当一个请求在处理过程中的时候调用了 abort() 或 open() 方法。每次这个属性的值增加的时候，都会触发 onreadystatechange 事件句柄。

responseText

目前为止为XMLHttpRequest接收到的响应体（不包括头部），或者如果还没有接收到数据的话，就是空字符串。

如果 readyState 小于 3，这个属性就是一个空字符串。当 readyState 为 3，这个属性返回目前已经接收的响应部分。如果 readyState 为 4，这个属性保存了完整的响应体。

如果响应包含了为响应体指定字符编码的头部，就使用该编码。否则，假定使用 Unicode UTF-8。

responseXML

XMLHttpRequest接收到的响应，解析为 XML 并作为Document 对象返回。

status

由服务器返回的HTTP 状态代码，如 200 表示成功，而 404 表示 "Not Found" 错误。当 readyState 小于 3 的时候读取这一属性会导致一个异常。

statusText

这个属性用名称而不是数字指定了请求的 HTTP 的状态代码。也就是说，当状态为 200 的时候它是 "OK"，当状态为 404 的时候它是 "Not Found"。和 status 属性一样，当 readyState 小于 3 的时候读取这一属性会导致一个异常。

timeout

以毫秒为单位的一个超时时间，这个时间是相对于请求开始时间计算的。

如果被设置为一个非0值，那么请求将在开始（调用send方法时）后计时，在执行时间达到timeout指定的时间如果还没有完成请求将被强行中止；同时会有一个超时事件被触发，或者抛出一个 TimeoutError 异常。

需要注意的是，如果执行的是同步请求，设置timeout为非0值会抛出 InvalidAccessError 异常。

另外，timeout属性的值可以在send方法调用之后、请求完成之前的任何时间进行设置，并且无论何时设置，计时都是从调用send方法的那一刻开始的。

事件句柄

以下是XMLHttpRequest对象支持的事件句柄(及其相应的事件句柄所对应的事件类型),这些是继承自XMLHttpRequestEventTarget的接口对象必须实现的属性:

事件句柄	事件名	事件类型	何时触发
onloadstart	loadstart	ProgressEvent	请求开始时
onprogress	progress	ProgressEvent	数据传输的过程中 可能会触发多次
onabort	abort	ProgressEvent	请求被中止时，如调用 abort() 方法时
onerror	error	ProgressEvent	请求出错时
onload	load	ProgressEvent	请求成功完成时（强调语法成功）
ontimeout	timeout	ProgressEvent	在请求完成之前，并已经达到指定的超时时间
onloadend	loadend	ProgressEvent	请求完成时(无论成功或失败)

下面也是XMLHttpRequest对象支持的事件句柄(及其相应的事件句柄所对应的事件类型),这些只能通过XMLHttpRequest对象支持:

事件句柄	事件名	事件类型	何时触发
onreadystatechange	readystatechange	Event	readyState属性变化时

每次 readyState 属性改变的时候都会调用 onreadystatechange 事件句柄函数。当 readyState 为 3 时，它也可能调用多次。

方法

abort()

取消当前响应，关闭连接并且结束任何未完成的网络活动。
这个方法把 XMLHttpRequest 对象重置为 readyState 为 0 的状态，并且取消所有未完成的网络活动。例如，如果请求用了太长时间，而且响应不再必要的时候，可以调用这个方法。

getResponseHeader()

返回指定的 HTTP 响应头部的值。其参数是要返回的 HTTP 响应头部的名称。可以使用任何大小写来制定这个头部名字，和响应头部的比较是不区分大小写的。

该方法的返回值是指定的 HTTP 响应头部的值，如果没有接收到这个头部或者 readyState 小于 3 则为空字符串。如果接收到多个有指定名称的头部，这个头部的值被连接起来并返回，使用逗号和空格分隔开各个头部的值。

getAllResponseHeaders()

把 HTTP 响应头部作为未解析的字符串返回。
如果 readyState 小于 3，这个方法返回 null。否则，它返回服务器发送的所有 HTTP 响应的头部。头部作为单个的字符串返回，一行一个头部。每行用换行符 "\r\n" 隔开。

open()

初始化 HTTP 请求参数，例如 URL 和 HTTP 方法，但是并不发送请求。

语法

xhr.open(method, url[, async[, username[, password]]])

method 参数是用于请求的 HTTP 方法。值包括 GET、POST 和 HEAD。

url 参数是请求的主体。大多数浏览器实施了一个同源安全策略，并且要求这个 URL 与包含脚本的文本具有相同的主机名和端口。

async 参数指示请求使用应该异步地执行。如果这个参数是 false，请求是同步的，后续对 send() 的调用将阻塞，直到响应完全接收。如果这个参数是 true 或省略，请求是异步的，且通常需要一个 onreadystatechange 事件句柄。

username 和 password 参数是可选的，为 url 所需的授权提供认证资格。如果指定了，它们会覆盖 url 自己指定的任何资格。

说明

这个方法初始化请求参数以供 send() 方法稍后使用。它把 readyState 设置为 1，删除之前指定的所有请求头部，以及之前接收的所有响应头部，并且把 responseText、responseXML、status 以及 statusText 参数设置为它们的默认值。当 readyState 为 0 的时候（当 XMLHttpRequest 对象刚创建或者 abort() 方法调用后）以及当 readyState 为 4 时（已经接收响应时），调用这个方法是安全的。当针对任何其他状态调用的时候，open() 方法的行为是未指定的。

除了保存供 send() 方法使用的请求参数，以及重置 XMLHttpRequest 对象以便复用，open() 方法没有其他的行为。要特别注意，当这个方法调用的时候，实现通常不会打开一个到 Web 服务器的网络连接。

注意事项

如果method不是一个有效的HTTP方法或url不能被解析，将抛出TypeError异常。

setRequestHeader()

向一个打开但未发送的请求设置或添加一个 HTTP 请求头。

语法

setRequestHeader(name, value)

name 参数是要设置的头部的名称。这个参数不应该包括空白、冒号或换行。

value 参数是头部的值。这个参数不应该包括换行。

说明

setRequestHeader() 方法指定了一个 HTTP 请求的头部，它应该包含在通过后续 send() 调用而发布的请求中。这个方法只有当 readyState 为 1 的时候才能调用，也就是说必须在调用了 open() 之后，且在调用 send() 之前。

如果带有指定名称的头部已经被指定了，这个头部的新值就是：之前指定的值，加上逗号、空白以及这个调用指定的值。

如果 open() 调用指定了认证资格（给定了name和password参数），XMLHttpRequest 自动发送一个适当的 Authorization 请求头部。但是，你可以使用 setRequestHeader() 来添加这个头部。如果 Web 服务器已经保存并传递给 open() 的 URL 相关联的 cookie，适当的 Cookie 或 Cookie2 头部也自动地包含到请求中。也可以通过调用 setRequestHeader() 来把这些 cookie 添加到头部。XMLHttpRequest 也可以为 User-Agent 头部提供一个默认值。如果这么做了，你为该头部指定的任何值都会添加到这个默认值后面。

有些请求头部由 XMLHttpRequest 自动设置而不是由这个方法设置，以符合 HTTP 协议。这包括如下和代理相关的头部：

• Host
• Connection
• Keep-Alive
• Accept-charset
• Accept-Encoding
• If-Modified-Since
• If-None-Match
• If-Range
• Range

send()

发送 HTTP 请求，使用传递给 open() 方法的参数，以及传递给该方法的可选请求体。

语法

xhr.send(data)

如果通过调用 open() 指定的 HTTP 方法是 POST 或 PUT，data 参数指定了请求实体的主体，data 的类型将在下面详细介绍。如果请求体不是必须的话，这个参数就为 null。对于任何其他方法，这个参数是不可用的，应该为 null（有些实现不允许省略该参数）。

说明

这个方法导致一个 HTTP 请求发送。如果之前没有调用 open()，或者更具体地说，如果 readyState 不是 1，send() 抛出一个异常。否则，它发送一个 HTTP 请求，该请求由以下几部分组成：

1. 之前调用 open() 时指定的 HTTP 方法、URL 以及认证资格（如果有的话）。
2. 之前调用 setRequestHeader() 时指定的请求头部（如果有的话）。
3. 传递给这个方法的body参数。

一旦请求发布了，send() 把 readyState 设置为 2，并触发 onreadystatechange 事件句柄。

如果之前调用的 open() 参数 async 为 false，这个方法会阻塞并不会返回，直到 readyState 为 4 并且服务器的响应被完全接收。如果 async 参数为 true，或者这个参数省略了，send() 立即返回，并且正如后面所介绍的，服务器响应将在一个后台线程中处理。

如果服务器响应带有一个 HTTP 重定向，send() 方法或后台线程自动遵从重定向。当所有的 HTTP 响应头部已经接收，send() 或后台线程把 readyState 设置为 3 并触发 onreadystatechange 事件句柄。如果响应较长，send() 或后台线程可能在状态 3 中多次触发 onreadystatechange 事件句柄：这可以作为一个下载进度指示器。最后，当响应完成，send() 或后台线程把 readyState 设置为 4，并最后一次触发 onreadystatechange 事件句柄。

data 参数的有效类型

ArrayBufferView

如果 data 的类型为ArrayBufferView，则设置请求实体的主体（Request Entiry Body）为 data 中的数据。

Blob 对象

如果data是Blob对象，则设置请求实体的主体（Request Entiry Body）为 data 中的数据。
如果 Blob 对象的属性不是空字符串，则设置 MIME-Type 为Blob的类型。

document 对象

如果data是document对象，会进行如下设置：

1. 设置Request请求的编码为UTF-8;
2. 如果 data 是html document对象，则设置 MIME-Type 为 “text/html” 或 “application/xml”，并在MIME-Type后追加字符“;charset=UTF-8”。
3. 对请求实体的主体（Request Entiry Body）进行序列化，并编码 UTF-8 格式。

注意：如果数据不能被序列化,将抛出一个“InvalidStateError”异常。

string

如果 data 是一个字符串，则把字符串的内容设置为请求实体的主体，并把请求的编码设置为UTF-8；设置MIME-Type为“text/plain;charset=UTF-8”；然后对请求实体的主体进行UTF-8编码。

FormData

data为FormData类型时会进行如下操作：

1. 对data数据进行UTF-8编码后使用“multipart/form-data”算法处理，将返回的结果设置为请求实体的主体。“multipart/form-data”算法会生成“boundary=”字符串，并使用 boundary 字符分隔开请求实体的主体中的各部分数据。
2. 设置MIME-Type的值为“multipart/form-data”

FormData 接口

以下代码来自W3C的“XMLHttpRequest Level 1”规范。

[Constructor(optional HTMLFormElement form )]
interfaceFormData { 

  void append([EnsureUTF16] DOMStringname, Blob value, optional EnsureUTF16] DOMStringfilename );

  void append([EnsureUTF16] DOMStringname, [EnsureUTF16] DOMStringvalue);

};

FormData中的数据是一系列条目（entry）的有序列表；这些 entry 必须包含name和value两个属性。

如何得到 FormData对象

fd = new FormData([form]);

数据form是可选的，如果传了form参数，它必须是一全form元素的DOM对象。

如何向FormData对象中添加数据

fd.append(name,value[,filename]);

参数 name 必须是一个字符串；value 可以是一个字符中，也可以是一个Blob对象；如果value是一个Blob对象时，filename参数是可选的，用来说明Blob对象的名字。

FormData 小结

之所以要在这里写个小结，是因为这里介绍的FormData对象太过简单了；其实FormData对象还有很多方法和属性，并且组成FormData对象的条目（entry）对象也是需要花大段文字来说明的。由于篇幅和时间限制，这里就先简单介绍一下，后续我会对FomData对象写一篇专门的介绍。

刚发布不久就有朋友反应FomData部分的内容看不懂；不得以，只能加班把FomData介绍的文章赶出来。如果你也有同样的困惑请移步Ajax之魂-WEB中的XMLHttpRequest规范：附FormData详解。

总结

其实很不想写总结，因为还有很多东西没有介绍清楚。有些东西在W3C的“XMLHttpRequest Level 1”规范写的很详细，由于本人英文水平限制，有些内容无法解理，还有些理解了但无法准备的翻译成中文。如果有想要完全了解XMLHttpRequest对象的同学，可以去W3C官网看一下XMLHttpRequest Level 1规范的英文原文。

在本篇中，有很多依赖的内容没有做详细的解决，如：Blob对象，ArrayBufferView 对象，DOM 4 规范等。其实这些内容都有对应的规范，有些我是看过了解一些，有些也只是知道，并没有详细看过规范文档。由于作者是一个求知欲很强的人，所以那些没有看过的文档肯定会抽出时间来研读，届时一定也会整理出文章分享给大家。而那些已经看过有点了解的规范，会在我每有闲暇之时就整理出来分享给大家。有兴趣的同学可以关注一下。