jQuery 发送的所有 Ajax 请求,内部都会通过调用 $.ajax()
函数来实现。通常没有必要直接调用这个函数,可以使用几个已经封装的简便方法,如$.get()
和.load()
。如果你需要用到那些不常见的选项,那么, $.ajax()
使用起来更灵活。
在简单地说, $.ajax()
函数可以不带参数调用:
1 |
|
注意: 所有的选项都可以通过$.ajaxSetup()
函数来全局设置
这个例子中,不使用选项,加载当前页面的内容,但其结果没用的。若要使用结果,我们可以实现的回调功能之一。
从jQuery 1.5开始,$.ajax()
返回XMLHttpRequest(jqXHR)对象,该对象是浏览器的原生的XMLHttpRequest对象的一个超集。例如,它包含responseText
和responseXML
属性,以及一个getResponseHeader()
方法。当传输机制不是是XMLHttpRequest时(例如,一个JSONP请求脚本,返回一个脚本 tag 时),jqXHR对象尽可能的模拟原生的XHR功能。
从jQuery 1.5.1开始, jqXHR
对象还包含了overrideMimeType
方法 (它在jQuery 1.4.x中是有效的,但是在jQuery 1.5中暂时的被移除)。.overrideMimeType()
方法可能用在beforeSend()
的回调函数中,例如,修改响应的Content-Type信息头:
1 2 3 4 5 6 7 8 9 10 |
|
从 jQuery 1.5 开始,$.ajax()
返回的jqXHR对象 实现了 Promise 接口, 使它拥有了 Promise 的所有属性,方法和行为。(见Deferred object获取更多信息)。为了让回调函数的名字统一,便于在$.ajax()
中使用。jqXHR也提供.error()
.success()
和.complete()
方法。这些方法都带有一个参数,该参数是一个函数,此函数在 $.ajax()
请求结束时被调用,并且这个函数接收的参数,与调用 $.ajax()
函数时的参数是一致。这将允许你在一次请求时,对多个回调函数进行赋值,甚至允许你在请求已经完成后,对回调函数进行赋值(如果该请求已经完成,则回调函数会被立刻调用)。
一个可供选择的 success 回调选项的构造函数,.done()
方法取代了的过时的jqXHR.success()
方法。请参阅deferred.done()
的实现细节。
一种可供选择的 error 回调选项的构造函数,.fail()
方法取代了的过时的.error()
方法。请参阅deferred.fail()
的实现细节。
一种可供选择的 complete 回调选项的构造函数,.always()
方法取代了的过时的.complete()
方法。
在响应一个成功的请求后,该函数的参数和.done()
的参数是相同的:data, textStatus, 和 jqXHR 对象.对于失败的请求,参数和.fail()
的参数是相同的:jqXHR 对象, textStatus, 和 errorThrown。请参阅deferred.always()
的实现细节。
包含了 .done()
和 .fail()
方法的功能,(从 jQuery 1.8 开始)允许底层被操纵。请参阅deferred.then()
的实现细节。
推荐使用的注意事项: jqXHR.success()
, jqXHR.error()
, 和 jqXHR.complete()
回调从 jQuery 1.8开始 被弃用。他们将最终被取消,您的代码应做好准备,使用jqXHR.done()
, jqXHR.fail()
, 和 jqXHR.always()
代替。
1 2 3 4 5 6 7 8 9 10 11 |
|
this
在所有的回调中的引用,是这个对象在传递给$.ajax
的设置中上下文;如果没有指定context(上下文)
,this
引用的是Ajax设置的本身。
为了向后兼容XMLHttpRequest
,一jqXHR
对象将公开下列属性和方法:
readyState
status
statusText
responseXML
and/or responseText
当底层的请求分别作出XML和/或文本响应setRequestHeader(name, value)
从标准出发,通过替换旧的值为新的值,而不是替换的新值到旧值getAllResponseHeaders()
getResponseHeader()
abort()
假如没有onreadystatechange
属性,因为不同的状态可以分别在 success
, error
, complete
和statusCode
方法中进行处理。
beforeSend
, error
, dataFilter
, success
和 complete
接受的回调函数是在合适的时间调用。
从jQuery 1.5开始, fail
, done
,和从jQuery 1.6开始的always
回调钩子(hooks)采用先入先出队列管理。这意味着你可以为每个挂钩分配多个回调。见Deferred object methods ,这是实现内部的$.ajax()
回调钩子(hooks)。
这里有$.ajax()
提供的回调钩子 (hooks),如下:
jqXHR
对象和settings
作为参数对象。jqXHR
,字符串表示的错误类型,以及异常对象(如果有的话)。一些内置的错误会将 "abort", "timeout", "No Transport" 等字符串作为异常对象。dataFilter
在请求成功之后调用。传入返回的数据以及dataType
参数的值。并且必须返回新的数据(可能是处理过的)传递给success
回调函数。success
当请求成功并接收到返回数据之后调用。传入返回后的数据,以及包含成功代码的字符串和jqXHR
对象。 .done()
, .fail()
, .always()
, and .then()
— 根据他们注册的顺序被调用。 complete
请求完成时,无论是在失败或成功,它们按顺序依次执行回调。他们收到jqXHR
对象,以及一个包含成功或错误代码。 $.ajax()
调用不同类型的响应,被传递到成功处理函数之前,会经过不同种类的预处理。 预处理的类型取决于由更加接近默认的Content-Type响应,但可以明确使用dataType
选项进行设置。如果提供了dataType
选项, 响应的Content-Type头信息将被忽略。
有效的数据类型是text
, html
, xml
, json
,jsonp
,和 script
.
如果指定的是text
或 html
, 则不会预处理。 这些数据被简单地传递给成功处理函数, 并通过该jqXHR
对象的responseText
属性获得的。
如果指定的是xml
, 响应结果作为XMLDocument
,在传递给成功处理函数之前使用jQuery.parseXML
进行解析。 XML文档是可以通过该jqXHR
对象的responseXML
属性获得的。
如果指定的是json
,响应结果作为一个对象,在传递给成功处理函数之前使用jQuery.parseJSON
进行解析。 解析后的JSON对象可以通过该jqXHR
对象的responseJSON
属性获得的。
如果指定的是script
,$.ajax()
执行这段 JavaScript,这段 JavaScript 从服务器接收到,在传递给成功处理函数之前是一个字符串。
如果指定的是jsonp
,$.ajax()
会自动在请求的URL后面增加一个查询字符串参数 callback=?
(默认) 。传递给$.ajax()
设置中的jsonp
和 jsonpCallback
属性可以被用来指定, 分别为 查询字符串参数的名称和JSONP回调函数的名称。服务器应返回有效的JavaScript,传递JSON响应到回调函数(愚人码头注:例如,flightHandler({"code": "CA1998","price": 1780,"tickets": 5});等)。 在包含JSON对象的相应结果传递给成功处理函数之前,$.ajax()
将执行返回的JavaScript, 调用JSONP回调函数。
更多JSONP信息可以参阅详细介绍了其使用的原帖.
默认情况下,Ajax请求使用GET方法。如果要使用POST方法,可以设定type
参数值。这个选项也会影响 data
选项中的内容如何发送到服务器。POST数据将被发送到服务器使用UTF-8字符集,根据W3C XMLHttpRequest的标准。
data选项既可以包含一个查询字符串,比如 key1=value1&key2=value2
,也可以是一个映射,比如 {key1: 'value1', key2: 'value2'}
。如果使用了后者的形式,则数据再发送前会用jQuery.param()
将其转换成查询字符串。这个处理过程也可以通过设置processData
选项为false
来回避。如果我们希望发送一个XML对象给服务器时,这种处理可能并不合适。并且在这种情况下,我们也应当改变contentType
选项的值,用其他合适的MIME类型来取代默认的 application/x-www-form-urlencoded
。
global选项用于阻止响应注册的回调函数,比如.ajaxSend()
, .ajaxError()
,以及类似的方法。这在有些时候很有用,比如发送的请求非常频繁且简短的时候,就可以在.ajaxSend()
里禁用这个。跨域脚本和JSONP请求,全局选项自动设置为false
。更多关于这些方法的详细信息,请参阅下面的内容。
如果服务器需要HTTP认证,可以使用用户名和密码可以通过 username
和 password
选项来设置。
Ajax请求是限时的,所以错误警告被捕获并处理后,可以用来提升用户体验。请求超时这个参数通常就保留其默认值,要不就通过$.ajaxSetup()
来全局设定,很少为特定的请求重新设置timeout
选项。
默认情况下,请求总会被发出去,但浏览器有可能从他的缓存中调取数据。要禁止使用缓存的结果,可以设置cache
参数为false
。如果希望判断数据自从上次请求后没有更改过就报告出错的话,可以设置ifModified
为true
。
scriptCharset
允许给<script>标签的请求设定一个特定的字符集,用于script
或者 jsonp
类似的数据。当脚本和页面字符集不同时,这特别好用。
Ajax的第一个字母是“asynchronous”的开头字母,这意味着所有的操作都是并行的,完成的顺序没有前后关系。$.ajax()
的async
参数总是设置成true
,这标志着在请求开始后,其他代码依然能够执行。强烈不建议把这个选项设置成false
,这意味着所有的请求都不再是异步的了,这也会导致浏览器被锁死。
$.ajax()
函数返回他创建的XMLHttpRequest
对象。通常jQuery只在内部处理并创建这个对象,但用户也可以通过xhr
选项来传递一个自己创建的xhr对象。返回的对象通常已经被丢弃了,但依然提供一个底层接口来观察和操控请求。比如说,调用对象上的.abort()
可以在请求完成前挂起请求。
目前, 在Firefox中有一个bug,虽然.getResponseHeader('Content-Type')
返回一个非空的字符串,但是 .getAllResponseHeaders()
还是返回空字符串, 在Firefox中使用jQuery不支持自动解码JSON CORS 响应。
重写jQuery.ajaxSettings.xhr
的一种解决方案,如下
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
|
从jQuery 1.5开始,,jQuery的Ajax实现包括预prefilters, transports和传输,让您更加灵活的扩展Ajax。如需有关这些先进功能的信息,请参阅Extending Ajax
$.ajax()
的转换器支持的数据类型映射到其它数据类型。但是,如果你想把自定义数据类型映射到一个已知的类型(json
等),您必须contents
选项在响应的Content-Type和实际的数据类型之间的添加一个相关的转换函数:
1 2 3 4 5 6 7 8 9 10 11 |
|
这额外的对象是必要的,因为响应内容类型(Content-Types)和数据类型从来没有一个严格的一对一对应关系(正则表达式表示结果)。
转换一个支持的类型(例如text
, json
)成自定义数据类型,然后再返回,使用另一个直通转换器:
1 2 3 4 5 6 7 8 9 10 11 12 |
|
现在上面的代码允许通过从text
为mycustomtype
,进而,mycustomtype
转换为 json
。
联系客服