The XMLHttpRequest specification defines an API that provides scripted
client functionality for transferring data between a client and a server.
Status of this Document
This section describes the status of this document at the time of
its publication. Other documents may supersede this document. A list of
current W3C publications and the latest revision of this technical report
can be found in the W3C technical reports
index at http://www.w3.org/TR/.
This is the 20 August 2009 W3C Working Draft of the XMLHttpRequest
specification. Please send comments to public-webapps@w3.org (archived)
with [XHR] at the start of the subject
line.
Publication as a Working Draft does not imply endorsement by the W3C
Membership. This is a draft document and may be updated, replaced or
obsoleted by other documents at any time. It is inappropriate to cite this
document as other than work in progress.
The XMLHttpRequest object
implements an interface exposed by a scripting engine that allows scripts
to perform HTTP client functionality, such as submitting form data or
loading data from a server. It is the ECMAScript HTTP API.
The name of the object is XMLHttpRequest for compatibility with
the Web, though each component of this name is potentially misleading.
First, the object supports any text based format, including XML. Second,
it can be used to make requests over both HTTP and HTTPS (some
implementations support protocols in addition to HTTP and HTTPS, but that
functionality is not covered by this specification). Finally, it supports
"requests" in a broad sense of the term as it pertains to HTTP; namely all
activity involved with HTTP requests or responses for the defined HTTP
methods.
Some simple code to do something with data from an XML document fetched
over the network:
function test(data) {
// taking care of data
}
function handler() {
if(this.readyState == 4 && this.status == 200) {
// so far so good
if(this.responseXML != null && this.responseXML.getElementById('test').firstChild.data)
// success!
test(this.responseXML.getElementById('test').firstChild.data);
else
test(null);
} else if (this.readyState == 4 && this.status != 200) {
// fetched the wrong page or network error...
test(null);
}
}
var client = new XMLHttpRequest();
client.onreadystatechange = handler;
client.open("GET", "test.xml");
client.send();
If you just want to log a message to the server:
function log(message) {
var client = new XMLHttpRequest();
client.open("POST", "/log");
client.setRequestHeader("Content-Type", "text/plain;charset=UTF-8");
client.send(message);
}
Or if you want to check the status of a document on the server:
function fetchStatus(address) {
var client = new XMLHttpRequest();
client.onreadystatechange = function() {
// in case of network errors this might not give reliable results
if(this.readyState == 4)
returnStatus(this.status);
}
client.open("HEAD", address);
client.send();
}
2 Conformance
Everything in this specification is normative except for diagrams,
examples, notes and sections marked non-normative.
The key words must, must not, should and may in this document are to be
interpreted as described in RFC 2119. [RFC2119]
This specification defines the following classes of products:
Conforming user agent
A user agent must behave as described in this
specification in order to be considered conformant.
User agents may implement algorithms given in this
specification in any way desired, so long as the end result is
indistinguishable from the result that would be obtained by the
specification's algorithms.
This specification uses both the terms "conforming user
agent(s)" and "user agent(s)" to refer to this product class.
Conforming XML user agent
An XML user agent must be a conforming user agent and must be a conforming XML processor that reports violations
of namespace well-formedness. [XML]
2.1 Dependencies
This specification relies on several underlying specifications.
DOM
A conforming user agentmust support at least
the subset of the functionality defined in DOM Events and DOM Core that
this specification relies upon, such as various exceptions and
EventTarget. [DOM2Events] [DOM3Core]
HTML 5
A conforming user agentmust support at least the subset of the functionality
defined in HTML 5 that this specification relies upon, such as the
basics of the Window object and serializing a
Document object. [HTML5]
The Window Object
1.0 draft is not referenced normatively as it appears to be no
longer maintained and HTML 5 defines the Window object
in more detail. This specification already depends on HTML 5 for
other reasons so there is not much additional overhead because of this.
HTTP
A conforming user agentmust support some version of the HTTP protocol. It should support any HTTP method that matches the Method token production and must at least support the following methods:
GET
POST
HEAD
PUT
DELETE
OPTIONS
Other requirements regarding HTTP are made throughout the
specification. [RFC2616]
Web IDL
A conforming user agentmust also be a conforming implementation of the IDL
fragment in this specification, as described in the Web IDL
specification. [WebIDL]
2.2 Terminology
Comparing two strings in a case-sensitive
manner means comparing them exactly, codepoint for codepoint.
Comparing two strings in an ASCII
case-insensitive manner means comparing them exactly, codepoint for
codepoint, except that the characters in the range U+0041 .. U+005A (i.e.
LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z) and the corresponding
characters in the range U+0061 .. U+007A (i.e. LATIN SMALL LETTER A to
LATIN SMALL LETTER Z) are considered to also match.
Converting a string to ASCII uppercase means replacing
all characters in the range U+0061 .. U+007A (i.e. LATIN SMALL LETTER A to
LATIN SMALL LETTER Z) with the corresponding characters in the range
U+0041 .. U+005A (i.e. LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z).
The terms and algorithms <fragment>, <scheme>, document base
URL, event handler
attributes, event handler event
type, fully active, Function, innerHTML, origin, resolve a URL, same origin, storage
mutex, task, task
source, URL, URL
character encoding, and queue a task are
defined by the HTML 5 specification. [HTML5]
The term entity body is used as described in
RFC 2616. Method token is used as described in
section 5.1.1 of RFC 2616. field-name and field-value are used as described in
section 4.2 of RFC 2616. [RFC2616]
userinfo is used as described in
section 3.2.1 of RFC 3986. [RFC3986]
To dispatch a
readystatechange event means that an event with the
name readystatechange, with no namespace, which does not
bubble and is not cancelable, and which uses the Event
interface, is to be dispatched at the XMLHttpRequest object.
2.3 Extensibility
Extensions of the API defined by this specification are strongly
discouraged. User agents, Working Groups and other interested parties
should discuss extensions on a relevant public forum, preferably public-webapps@w3.org.
3 Security Considerations
Security related requirements are made throughout this specification.
4 The XMLHttpRequest Interface
The XMLHttpRequest object can
be used by scripts to programmatically connect to their originating server
via HTTP.
Each XMLHttpRequest object
has an associated XMLHttpRequest origin and an
XMLHttpRequest base
URL.
This specification defines their values when the global object is
represented by the Window object. When the XMLHttpRequest object used in other
contexts their values will have to be defined as appropriate for that
context. That is considered to be out of scope for this specification.
In environments where the global object is represented by the
Window object the XMLHttpRequest object has an associated
XMLHttpRequestDocument which is the Document object
associated with the Window object for which the XMLHttpRequest interface object was
created.
The XMLHttpRequest object can
be in several states. The readyState
attribute, on getting, must return the current state,
which must be one of the following values:
UNSENT
(numeric value 0)
The object has been constructed.
OPENED
(numeric value 1)
The open() method has been
successfully invoked. During this state request headers can be set using
setRequestHeader() and the
request can be made using the send()
method.
HEADERS_RECEIVED (numeric value 2)
All HTTP headers have been received. Several response members of the
object are now available.
The data transfer has been completed or something went wrong during
the transfer (e.g. infinite redirects).
The OPENED state has an
associated send() flag that indicates
whether the send() method has been
invoked. It can be either true or false and has an initial value of false.
The DONE state has an
associated error flag that indicates some type of
network error or abortion. It can be either true or false and has an
initial value of false.
4.6 Request
The XMLHttpRequest object
holds the following request metadata variables:
The asynchronous flag
A flag that is either true or false that indicates whether the request
is done asynchronously.
If url contains an unsupported <scheme> raise a
NOT_SUPPORTED_ERR and terminate these steps.
If the "user:password" format in the userinfo production is not supported for the
relevant scheme and url contains this format raise a
SYNTAX_ERR and terminate these steps.
If url contains the "user:password"
format let temp user be the user part and temp
password be the password part.
If url just contains the "user"
format let temp user be the user part.
Let async be the value of the async argument or
true if it was omitted.
If the user argument was not omitted follow these sub
steps:
If the syntax of user does not match the syntax specified
by the relevant authentication scheme, raise a SYNTAX_ERR
exception and terminate the overall set of steps.
If user is null let temp user be
null.
Otherwise let temp user be user.
These steps override anything that may have been set by the
url argument.
If the password argument was not omitted follow these sub
steps:
If the syntax of password does not match the syntax
specified by the relevant authentication scheme, raise a
SYNTAX_ERR exception and terminate the overall set of
steps.
If password is null let temp
password be null.
Otherwise let temp password be password.
These steps override anything that may have been set by the
url argument.
A future version or extension of this specification will
define a way of doing cross-origin requests.
4.6.2 The setRequestHeader() method
As indicated in the algorithm below certain headers cannot be set and
are left up to the user agent. In addition there are certain other headers
the user agent will take control of if they are not set by the author as
indicated at the end of the send() method
section.
When the setRequestHeader(header,
value) method is invoked, the user agent must run these steps (unless otherwise indicated):
If the state is not OPENED raise an INVALID_STATE_ERR exception and
terminate these steps.
If the send() flag is true raise
an INVALID_STATE_ERR exception and terminate these steps.
If header does not match the field-name production raise a
SYNTAX_ERR exception and terminate these steps.
If the value argument does not match the field-value production raise a
SYNTAX_ERR and terminate these steps.
The empty string is legal and represents the empty header
value.
For security reasons, these steps should be
terminated if header is an ASCII case-insensitive match for one
of the following headers:
Accept-Charset
Accept-Encoding
Connection
Content-Length
Cookie
Cookie2
Content-Transfer-Encoding
Date
Expect
Host
Keep-Alive
Referer
TE
Trailer
Transfer-Encoding
Upgrade
User-Agent
Via
… or if the start of header is an ASCII case-insensitive match for
Proxy- or Sec- (including when
header is just Proxy- or Sec-).
The above headers are not allowed to be set as they are
better controlled by the user agent as it knows best what value they
should have. Header names starting with Sec- are not
allowed to be set to allow new headers to be minted in the future that
are guaranteed not to come from XMLHttpRequest. (Older clients would
however still be vulnerable as they allow such headers to be set.)
If header is not in the author request headers list append
header with its associated value to the list and
terminate these steps.
If header is in the author request headers list either
use multiple headers, combine the values or use a combination of those
(section 4.2, RFC 2616). [RFC2616]
See also the send() method
regarding user agent header handling for caching, authentication, proxies,
and cookies.
// The following script:
var client = new XMLHttpRequest();
client.open('GET', 'demo.cgi');
client.setRequestHeader('X-Test', 'one');
client.setRequestHeader('X-Test', 'two');
client.send();
// ...would result in the following header being sent:
...
X-Test: one, two
...
Authors are encouraged to ensure that they have specified the
Content-Type header via setRequestHeader() before invoking
send() with a non-nulldata argument.
When the send(data) method is invoked, the
user agent must run the following steps (unless
otherwise noted). This algorithm gets aborted when the open() or abort() method is invoked. When the send() algorithm
is aborted the user agent must terminate the
algorithm after finishing the step it is on.
The send() algorithm can only be
aborted when the asynchronous flag is
true and only after the method call has returned.
If the state is not OPENED raise an INVALID_STATE_ERR exception and
terminate these steps.
If the send() flag is true raise
an INVALID_STATE_ERR exception and terminate these steps.
If the request method is GET or HEAD
act as if data is null.
If the data argument has not been omitted and is not
null use it for the request
entity body observing the following rules:
data is a DOMString
Encode data using UTF-8 for transmission.
If a Content-Type header is set using setRequestHeader() and its value
is not malformed, set the charset parameter of that
header, by either changing the charset parameter (if one
is present) or appending one, to UTF-8.
If no Content-Type header has been set using setRequestHeader() set a
Content-Type request header with a value of
text/plain;charset=UTF-8.
data is a Document
Let tempdata be the result of getting the innerHTML
attribute on the data object and encode it using
data.inputEncoding or UTF-8 if
data.inputEncoding is null.
Re-raise any exception this raises.
If the document cannot be serialized an
INVALID_STATE_ERR exception is raised.
Let data be tempdata.
If a Content-Type header is set using setRequestHeader() and its value
is not malformed, set the charset parameter of that
header, by either changing the charset parameter (if one
is present) or appending one, to the encoding used to encode
data.
If no Content-Type header has been set using setRequestHeader() set a
Content-Type request header with a value of
application/xml;charset=charset where
charset is the encoding used to encode data.
Subsequent changes to the Document have no
effect on what is submitted.
If the data argument has been omitted, or is
null, no request entity
body is used in the request.
If the user agent allows the end user to configure a proxy it should modify the request appropriately; i.e. connect to the
proxy host instead of the origin server, modify the
Request-Line and send Proxy-Authorization
headers as specified.
If the user agent supports HTTP Authentication and
Authorization is not in the list of author request headers, it should consider requests originating from the XMLHttpRequest object to be part of the
protection space that includes the accessed URIs and send
Authorization headers and handle 401
Unauthorized requests appropriately. If authentication fails, and
request username and request
password are both null, user agents should prompt
the end user for credentials. If authentication fails, and request username and request password are provided, user agents
must not prompt the end user for credentials. [RFC2617]
End users are not prompted if credentials are provided
through the open() API so that authors
can implement their own user interface.
If the user agent supports HTTP State Management it should persist, discard and send cookies (as received in the
Set-Cookie and Set-Cookie2 response headers, and
sent in the Cookie header) as applicable. [COOKIES]
If the user agent implements a HTTP cache it should
respect Cache-Control request headers set by setRequestHeader() (e.g.,
Cache-Control: no-cache bypasses the cache). It must not send Cache-Control or
Pragma request headers automatically unless the end user
explicitly requests such behavior (e.g. by (force-)reloading the page).
For 304 Not Modified responses that are a result of a user
agent generated conditional request the user agent must
act as if the server gave a 200 OK response with the
appropriate content. The user agent must allow setRequestHeader() to override
automatic cache validation by setting request headers (e.g.,
If-None-Match, If-Modified-Since), in which case
304 Not Modified responses must be passed
through. [RFC2616]
If the user agent implements server-driven content-negotiation it should set Accept-Encoding and
Accept-Charset headers as appropriate. Unless set through
setRequestHeader() user
agents should set the Accept and
Accept-Language headers as well. If Accept is
set by the user agent it must have the value
*/*. Responses must have the
content-encodings automatically decoded. [RFC2616]
Besides the author request headers
user agents should not include additional request
headers other than those mentioned above or other than those authors are
not allowed to set using setRequestHeader(). This ensures that
authors have a reasonably predictable API.
4.6.4
Infrastructure for the send() method
The cookie steps are as follows:
Wait until ownership of the storage mutex
can be taken.
Release the storage mutex so that it is
once again free.
The same-origin request event
rules are as follows:
If the response is an HTTP redirect
If the redirect does not violate security (it is same origin for instance), infinite loop
precautions, and the scheme is supported, transparently follow the
redirect while observing the same-origin request event
rules.
HTTP places requirements on the user agent regarding the
preservation of the request method and request entity body during redirects,
and also requires end users to be notified of certain kinds of automatic
redirections.
In case of DNS errors, TLS negotiation failure, or other type of
network errors, this is a network error. Do
not request any kind of end user interaction.
This does not include HTTP responses that indicate some
type of error, such as HTTP status code 410.
Once all HTTP headers have been received and the asynchronous flag is true
The status attribute must return the result of running these steps:
If the state is UNSENT or OPENED raise an INVALID_STATE_ERR exception and
terminate these steps.
If the error flag is true return
0 and terminate these steps.
Return the HTTP status code.
4.7.2 The statusText attribute
The statusText attribute must return the result of running these steps:
If the state is UNSENT or OPENED raise an INVALID_STATE_ERR exception and
terminate these steps.
If the error flag is true return the empty
string and terminate these steps.
Return the HTTP status text.
4.7.3 The
getResponseHeader() method
When the getResponseHeader(header)
is invoked, the user agent must run these steps:
If the state is UNSENT or OPENED raise an INVALID_STATE_ERR exception and
terminate these steps.
If header does not match the field-name production return
null and terminate these steps.
If the error flag is true return
null and terminate these steps.
If header is an ASCII
case-insensitive match for Set-Cookie or
Set-Cookie2 return null and terminate these
steps.
If header is an ASCII
case-insensitive match for multiple HTTP response headers, return
the values of these headers as a single concatenated string separated
from each other by a U+002C COMMA U+0020 SPACE character pair and
terminate these steps.
If header is an ASCII
case-insensitive match for a single HTTP response header, return the
value of that header and terminate these steps.
Return null.
// The following script:
var client = new XMLHttpRequest();
client.open("GET", "test.txt", true);
client.send();
client.onreadystatechange = function() {
if(this.readyState == 2) {
print(client.getResponseHeader("Content-Type"));
}
}
// ...should output something similar to the following text:
Content-Type: text/plain; charset=utf-8
4.7.4 The
getAllResponseHeaders() method
When the getAllResponseHeaders() method
is invoked, the user agent must run the following steps:
If the state is UNSENT or OPENED raise an INVALID_STATE_ERR exception and
terminate these steps.
If the error flag is true return the empty
string and terminate these steps.
Return all the HTTP headers, excluding headers that are an ASCII case-insensitive match for
Set-Cookie or Set-Cookie2, as a single string,
with each header line separated by a U+000D CR U+000A LF pair excluding
the status line, and with each header name and header value separated by
a U+003A COLON U+0020 SPACE pair.
// The following script:
var client = new XMLHttpRequest();
client.open("GET", "test.txt", true);
client.send();
client.onreadystatechange = function() {
if(this.readyState == 2) {
print(this.getAllResponseHeaders());
}
}
// ...should output something similar to the following text:
Date: Sun, 24 Oct 2004 04:58:38 GMT
Server: Apache/1.3.31 (Unix)
Keep-Alive: timeout=15, max=99
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: text/plain; charset=utf-8
If the response entity body is
null return the empty string and terminate these steps.
Let charset be null.
If there is no Content-Type header or there is a
Content-Type header which contains a MIME type that is
text/xml, application/xml or ends in +xml (ignoring any parameters) use the rules set forth
in the XML specifications to determine the character encoding. Let
charset be the determined character encoding. [XML]
If the Content-Type header contains a
text/html MIME type follow the rules set forth in the
HTML 5 specification to determine the character encoding. Let
charset be the determined character encoding. [HTML5]
If the MIME type specified by the Content-Type header
contains a charset parameter and charset is null
let charset be the value of that parameter.
The algorithms described by the XML and HTML specifications
already take Content-Type into account.
If charset is null then, for each of the rows in the
following table, starting with the first one and going down, if the
first bytes of bytes match the bytes given in the first
column, then let charset be the encoding given in the cell in
the second column of that row. If there is no match charset
remains null.
Bytes in Hexadecimal
Description
FE FF
UTF-16BE BOM
FF FE
UTF-16LE BOM
EF BB BF
UTF-8 BOM
If charset is null let charset be UTF-8.
Return the result of decoding the response entity body using
charset. Replace bytes or sequences of bytes that are not
valid according to the charset with a single U+FFFD
REPLACEMENT CHARACTER character.
Authors are strongly encouraged to encode their resources
using UTF-8.
If a Content-Type is present and it does not contain a
MIME type (ignoring any parameters) that is text/xml,
application/xml or ends in +xml
terminate these steps and return null. (Do not terminate
these steps if there is no Content-Type header at all.)
Parse the response entity body
into a document tree following the rules from the XML specifications.
Let the result be parsed document. If this fails (unsupported
character encoding, namespace well-formedness error, et cetera)
terminate these steps return null. [XML]
Scripts in the resulting document tree will not be
executed, resources referenced will not be loaded and no associated XSLT
will be applied.
Return an object implementing the Document interface
representing the parsed document.
4.7.6 The responseText attribute
The responseText attribute must return the result of running these steps:
If the state is not LOADING or DONE
return the empty string and terminate these steps.
Several algorithms in this specification may result in an exception
being thrown. These exceptions are all part of the group
ExceptionCode and use the DOMException object,
which is defined in DOM Level 3 Core. In addition this specification
extends the ExceptionCode group with several new constants as
indicated below. [DOM3Core]
Thus, exceptions used by this specification and not defined
in this section are defined by DOM Level 3 Core.
The SECURITY_ERR exception is
raised if an attempt is made to perform an operation or access some data
in a way that would be a security risk or a violation of the user agent's
security policy.
The NETWORK_ERR exception is
raised when a network error occurs in synchronous requests.
The ABORT_ERR exception is raised
when the user aborts a request in synchronous requests.
These exceptions might be folded into an update of DOM Level
3 Core in due course, as they are appropriate for other API specifications
as well.
Not in this Specification
This section is non-normative.
This specification does not include the following features which are
being considered for a future version of this specification:
load event and onload attribute;
error event and onerror attribute;
progress event and onprogress attribute;
abort event and onabort attribute;
Timers have been suggested, perhaps an ontimeout
attribute;
Property to disable following redirects;
responseXML for text/html
documents;
Cross-origin XMLHttpRequest;
responseBody to deal with byte streams;
overrideMimeType to fix up MIME types;
getRequestHeader() and
removeRequestHeader().
References
Unless marked "Non-normative" these references are normative.
The editor would like to thank Addison Phillips, Ahmed Kamel, Alex
Hopmann, Alex Vincent, Alexey Proskuryakov, Asbjørn Ulsberg, Boris
Zbarsky, Björn Höhrmann, Cameron McCormack, Christophe Jolif,
Charles McCathieNevile, Dan Winship, David Håsäther, Dean
Jackson, Denis Sureau, Doug Schepers, Douglas Livingstone, Elliotte
Harold, Eric Lawrence, Erik Dahlström, Geoffrey Sneddon, Gideon Cohn,
Gorm Haug Eriksen, Hallvord R. M. Steen, Håkon Wium Lie, Ian Davis,
Ian Hickson, Ivan Herman, Jeff Walden, Jens Lindström, Jim Deegan,
Jim Ley, Joe Farro, Jonas Sicking, Julian Reschke, Karl Dubost, Lachlan
Hunt, Maciej Stachowiak, Magnus Kristiansen, Marc Hadley, Marcos Caceres,
Mark Baker, Mark Birbeck, Mark Nottingham, Mohamed Zergaoui, Pawel
Glowacki, Robin Berjon, Ruud Steltenpool, Simon Pieters, Stewart Brodie,
Sunava Dutta, Thomas Roessler, Tom Magliery, and Zhenbin Xu for their
contributions to this specification.
Special thanks to the Microsoft employees who first implemented the
XMLHttpRequest interface, which was first widely
deployed by the Windows Internet Explorer browser.
Special thanks also to the WHATWG for drafting an initial version of
this specification in their Web Applications 1.0 document (now renamed to
HTML 5). [HTML5]
Thanks also to all those who have helped to improve this specification
by sending suggestions and corrections. (Please, keep bugging us with your
issues!)
翻译：