- .add()
- .addBack()
- .addClass()
- .ajaxComplete()
- .after()
- .ajaxError()
- .ajaxSend()
- .ajaxStart()
- .ajaxStop()
- .ajaxSuccess()
- All Selector ("*")
- .andSelf()
- .animate()
- :animated Selector
- .append()
- .appendTo()
- .attr()
- Attribute Contains Prefix Selector [name|="value"]
- Attribute Contains Selector [name*="value"]
- Attribute Contains Word Selector [name~="value"]
- Attribute Ends With Selector [name$="value"]
- Attribute Equals Selector [name="value"]
- Attribute Not Equal Selector [name!="value"]
- Attribute Starts With Selector [name^="value"]
- .before()
- .bind()
- .blur()
- :button Selector
- callbacks.add()
- callbacks.disable()
- callbacks.disabled()
- callbacks.empty()
- callbacks.fire()
- callbacks.fireWith()
- callbacks.fired()
- callbacks.has()
- callbacks.lock()
- callbacks.locked()
- callbacks.remove()
- .change()
- :checkbox Selector
- :checked Selector
- Child Selector ("parent > child")
- .children()
- Class Selector (".class")
- .clearQueue()
- .click()
- .clone()
- .closest()
- :contains() Selector
- .contents()
- .context
- .css()
- .data()
- .dblclick()
- deferred.always()
- deferred.done()
- deferred.fail()
- deferred.isRejected()
- deferred.isResolved()
- deferred.notify()
- deferred.notifyWith()
- deferred.pipe()
- deferred.progress()
- deferred.promise()
- deferred.reject()
- deferred.rejectWith()
- deferred.resolve()
- deferred.resolveWith()
- deferred.state()
- deferred.then()
- .delay()
- .delegate()
- .dequeue()
- Descendant Selector ("ancestor descendant")
- .detach()
- .die()
- :disabled Selector
- .each()
- Element Selector ("element")
- :empty Selector
- .empty()
- :enabled Selector
- .end()
- :eq() Selector
- .eq()
- .error()
- :even Selector
- event.currentTarget
- event.data
- event.delegateTarget
- event.isDefaultPrevented()
- event.isImmediatePropagationStopped()
- event.isPropagationStopped()
- event.metaKey
- event.namespace
- event.pageX
- event.pageY
- event.preventDefault()
- event.relatedTarget
- event.result
- event.stopImmediatePropagation()
- event.stopPropagation()
- event.target
- event.timeStamp
- event.type
- event.which
- .fadeIn()
- .fadeOut()
- .fadeTo()
- .fadeToggle()
- :file Selector
- .filter()
- .find()
- .finish()
- :first-child Selector
- :first-of-type Selector
- :first Selector
- .first()
- :focus Selector
- .focus()
- .focusin()
- .focusout()
- .get()
- :gt() Selector
- Has Attribute Selector [name]
- :has() Selector
- .has()
- .hasClass()
- :header Selector
- .height()
- :hidden Selector
- .hide()
- .hover()
- .html()
- ID Selector ("#id")
- :image Selector
- .innerHeight()
- .index()
- .innerWidth()
- :input Selector
- .insertAfter()
- .insertBefore()
- .is()
- jQuery.Callbacks()
- jQuery.Deferred()
- jQuery.ajax()
- jQuery.ajaxPrefilter()
- jQuery.ajaxSetup()
- jQuery.ajaxTransport()
- jQuery.boxModel
- jQuery.browser
- jQuery.contains()
- jQuery.cssHooks
- jQuery.cssNumber
- jQuery.data()
- jQuery.dequeue()
- jQuery.each()
- jQuery.error()
- jQuery.extend()
- jQuery.fn.extend()
- jQuery.fx.interval
- jQuery.fx.off
- jQuery.get()
- jQuery.getJSON()
- jQuery.getScript()
- jQuery.globalEval()
- jQuery.grep()
- jQuery.hasData()
- jQuery.holdReady()
- jQuery()
- jQuery.inArray()
- jQuery.isArray()
- jQuery.isEmptyObject()
- jQuery.isFunction()
- jQuery.isNumeric()
- jQuery.isPlainObject()
- jQuery.isWindow()
- jQuery.isXMLDoc()
- jQuery.makeArray()
- jQuery.map()
- jQuery.merge()
- jQuery.noConflict()
- jQuery.noop()
- jQuery.now()
- jQuery.param()
- jQuery.parseHTML()
- jQuery.parseJSON()
- jQuery.parseXML()
- jQuery.post()
- jQuery.proxy()
- jQuery.queue()
- jQuery.removeData()
- jQuery.sub()
- jQuery.support
- jQuery.trim()
- jQuery.type()
- jQuery.unique()
- jQuery.when()
- .jquery
- .keydown()
- .keypress()
- .keyup()
- :lang() Selector
- :last-child Selector
- :last-of-type Selector
- :last Selector
- .last()
- .length
- .live()
- .load()
- .load()
- :lt() Selector
- .map()
- .mousedown()
- .mouseenter()
- .mouseleave()
- .mousemove()
- .mouseout()
- .mouseover()
- .mouseup()
- Multiple Attribute Selector [name="value"][name2="value2"]
- Multiple Selector ("selector1, selector2, selectorN")
- Next Adjacent Selector ("prev + next")
- Next Siblings Selector ("prev ~ siblings")
- .next()
- .nextAll()
- .nextUntil()
- :not() Selector
- .not()
- :nth-child() Selector
- :nth-last-child() Selector
- :nth-last-of-type() Selector
- :nth-of-type() Selector
- :odd Selector
- .off()
- .offset()
- .offsetParent()
- .on()
- .one()
- :only-child Selector
- :only-of-type Selector
- .outerHeight()
- .outerWidth()
- :parent Selector
- .parent()
- .parents()
- .parentsUntil()
- :password Selector
- .position()
- .prepend()
- .prependTo()
- .prev()
- .prevAll()
- .prevUntil()
- .promise()
- .prop()
- .pushStack()
- .queue()
- :radio Selector
- .ready()
- .remove()
- .removeAttr()
- .removeClass()
- .removeData()
- .removeProp()
- .replaceAll()
- .replaceWith()
- :reset Selector
- .resize()
- :root Selector
- .scroll()
- .scrollLeft()
- .scrollTop()
- .select()
- :selected Selector
- .selector
- .serialize()
- .serializeArray()
- .show()
- .siblings()
- .size()
- .slice()
- .slideDown()
- .slideToggle()
- .slideUp()
- .stop()
- :submit Selector
- .submit()
- :target Selector
- :text Selector
- .text()
- .toArray()
- .toggle()
- .toggle()
- .toggleClass()
- .trigger()
- .triggerHandler()
- .unbind()
- .undelegate()
- .unload()
- .unwrap()
- .val()
- :visible Selector
- .width()
- .wrap()
- .wrapAll()
- .wrapInner()
jQuery.ajax()
jQuery.ajax( url [, settings ] )返回: jqXHR
说明: 执行一个异步的HTTP(Ajax)的请求。
添加的版本: 1.5jQuery.ajax( url [, settings ] )
- url 类型: String 一个用来包含发送请求的URL字符串。
- settings 类型: PlainObject 一个以"{键:值}"组成的AJAX 请求设置。所有选项都是可选的。可以使用$.ajaxSetup()设置任何默认参数。看jQuery.ajax( settings )下所有设置的完整列表。
添加的版本: 1.0jQuery.ajax( [settings ] )
- settings 类型: PlainObject 一个以"{键:值}"组成的AJAX 请求设置。所有选项都是可选的。可以使用$.ajaxSetup()设置任何默认参数。
- accepts (默认:
取决于数据类型
)类型: PlainObject 内容类型发送请求头(Content-Type),用于通知服务器该请求需要接收何种类型的返回结果。如果accepts
设置需要修改,推荐在$.ajaxSetup()
方法中设置一次。 - async (默认:
true
)类型: Boolean 默认设置下,所有请求均为异步请求(也就是说这是默认设置为true
)。如果需要发送同步请求,请将此选项设置为false
。跨域请求和dataType: "jsonp"
请求不支持同步操作。注意,同步请求将锁住浏览器,用户其它操作必须等待请求完成才可以执行。从 jQuery 1.8 开始, jqXHR ($.Deferred
)中使用async: false
已经过时。您必须使用的 success/error/complete 的回调选项代替相应的jqXHR对象的方法,比如jqXHR.done()
或者过时的jqXHR.success()
- beforeSend类型: Function( jqXHR jqXHR, PlainObject settings )请求发送前的回调函数,用来修改请求发送前jqXHR(在jQuery 1.4.x的中,XMLHttpRequest)对象,此功能用来设置自定义 HTTP 头信息,等等。该jqXHR和设置对象作为参数传递。这是一个Ajax事件 。在
beforeSend
函数中返回false
将取消这个请求。从jQuery 1.5开始,beforeSend
选项将被访问,不管请求的类型。 - cache (默认:
true, dataType为"script"和"jsonp"时默认为false
)类型: Boolean 如果设置为 false ,浏览器将不缓存此页面。注意: 设置cache
为 false将在 HEAD和GET请求中正常工作。它的工作原理是在GET请求参数中附加"_={timestamp}"(译者注:时间戳)。该参数不是其他请求所必须的,除了在IE8中,当一个POST请求一个已经用GET请求过的URL。 - complete类型: Function( jqXHR jqXHR, String textStatus )请求完成后回调函数 (请求
success
和error
之后均调用)。这个回调函数得到2个参数: jqXHR (在 jQuery 1.4.x中是 XMLHTTPRequest) 对象和一个描述请求状态的字符串("success"
,"notmodified"
,"error"
,"timeout"
,"abort"
, 或者"parsererror"
) 。从jQuery 1.5开始,complete
设置可以接受一个函数的数组。每个函数将被依次调用。这是一个Ajax事件 。 - contents类型: PlainObject 一个以"{字符串/正则表达式}"配对的对象,根据给定的内容类型,解析请求的返回结果。 (1.5新增)
- contentType (默认:
'application/x-www-form-urlencoded; charset=UTF-8'
)类型: String 发送信息至服务器时内容编码类型。默认值是"application/x-www-form-urlencoded; charset=UTF-8",适合大多数情况。如果你明确地传递了一个内容类型(Content-Type)给$.ajax()
,那么他必定会发送给服务器(即使没有数据要发送)。数据将总是使用UTF-8字符集传递给服务器;你必须在服务器端进行适当的解码。 - context类型: Object 这个对象用于设置Ajax相关回调函数的上下文。 默认情况下,这个上下文是一个ajax请求使用的参数设置对象,(
$.ajaxSettings
合并独傲这个设置,传递给$.ajax
)。比如指定一个DOM元素作为context参数,这样就设置了complete
回调函数的上下文为这个DOM元素。就像这样:$.ajax({ url: "test.html", context: document.body }).done(function() { $(this).addClass("done"); });
- converters (默认:
{"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML}
)类型: PlainObject 一个数据类型到数据类型转换器的对象。每个转换器的值是一个函数,返回经转换后的请求结果。 ( 1.5新增) - crossDomain (默认:
同域请求为false, 跨域请求为true
)类型: Boolean 如果你想在同一域中强制跨域请求(如JSONP形式),例如,想服务器端重定向到另一个域,那么需要将crossDomain设置为true
。 ( 1.5 新增) - data类型: Object, String 发送到服务器的数据。将自动转换为请求字符串格式。GET 请求中将附加在 URL 后面。查看
processData
选项说明,以禁止此自动转换。对象必须为"{键:值}"格式。如果这个参数是一个数组,jQuery会按照traditional
参数的值, 将自动转化为一个同名的多值查询字符串(查看下面的说明)。注:如 {foo:["bar1", "bar2"]} 转换为 '&foo=bar1&foo=bar2'。 - dataFilter类型: Function( Object data, String type ) => Object 一个函数被用来处理XMLHttpRequest的原始响应数据。这是一个预过滤功能,净化响应。您应该返回安全数据。提供data和type两个参数:data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataType参数。
- dataType (默认:
Intelligent Guess (xml, json, script, or html)
)类型: String 预期服务器返回的数据类型。如果不指定,jQuery 将自动根据 HTTP 包 MIME 信息来智能判断,比如XML MIME类型就被识别为XML。在1.4中,JSON就会生成一个JavaScript对象,而script则会执行这个脚本。随后服务器端返回的数据会根据这个值解析后,传递给回调函数。可用值:- "xml": 返回 XML 文档,可用 jQuery 处理。.
- "html": 返回纯文本 HTML 信息;包含的script标签会在插入dom时执行。
- "script": 把响应的结果当作 JavaScript 执行。并将其当作纯文本返回。默认情况下不会通过在URL中附加查询字符串变量 "_=[TIMESTAMP]" 进行自动缓存结果,除非设置了
cache
参数为true
。Note: 在远程请求时(不在同一个域下),所有POST请求都将转为GET请求。(因为将使用DOM的script标签来加载) - "json": 把响应的结果当作 JSON 执行,并返回一个JavaScript对象。在 jQuery 1.4 中,JSON 格式的数据以严格的方式解析,如果格式有错误,jQuery都会被拒绝并抛出一个解析错误的异常。(见json.org的更多信息,正确的JSON格式。)
- "jsonp": 以 JSONP 的方式载入 JSON 数据块。会自动在所请求的URL最后添加 "?callback=?"。默认情况下不会通过在URL中附加查询字符串变量 "_=[TIMESTAMP]" 进行自动缓存结果,除非将
cache
参数设置为true
。 - "text": 返回纯文本字符串。
- 多个空格分割的值:从 jQuery 1.5 开始, jQuery可以内容类型(Content-Type)头收到并转换一个您需要的数据类型。例如,如果你想要一个文本响应为XML处理,使用"text xml"数据类型。您也可以将一个JSONP的请求,以文本形式接受,并用jQuery以XML解析: "jsonp text xml"。同样地可以使用"jsonp xml"简写,首先会尝试从 jsonp 到 xml 的转换,如果转换失败,就先将 jsonp 转换成 text, 然后再由 text 转换成 xml。
- error类型: Function( jqXHR jqXHR, String textStatus, String errorThrown )请求失败时调用此函数。有以下三个参数:jqXHR (在 jQuery 1.4.x前为XMLHttpRequest) 对象、描述发生错误类型的一个字符串 和 捕获的异常对象。如果发生了错误,错误信息(第二个参数)除了得到
null
之外,还可能是"timeout"
,"error"
,"abort"
,和"parsererror"
。当一个HTTP错误发生时,errorThrown
接收HTTP状态的文本部分,比如: "Not Found"(没有找到) 或者 "Internal Server Error."(服务器内部错误)。 从jQuery 1.5开始, 在error
设置可以接受函数组成的数组。每个函数将被依次调用。 注意:此处理程序在跨域脚本和JSONP形式的请求时不被调用。这是一个 Ajax Event。 - global (默认:
true
)类型: Boolean 无论怎么样这个请求将触发全局AJAX事件处理程序。默认是true
。设置为false
将不会触发全局 AJAX 事件,如ajaxStart
或者ajaxStop
。这可以用来控制各种 Ajax Event. - headers (默认:
{}
)类型: PlainObject 一个额外的"{键:值}"对映射到请求一起发送。此设置会在beforeSend
函数调用之前被设置 ;因此,请求头中的设置值,会被beforeSend
函数内的设置覆盖 。 (1.5 新增 ) - ifModified (默认:
false
)类型: Boolean 只有上次请求响应改变时,才允许请求成功。使用 HTTP 包 Last-Modified 头信息判断。默认值是false
,忽略HTTP头信息。在jQuery 1.4中,他也会检查服务器指定的'etag'来确定数据没有被修改过。 - isLocal (默认:
取决于当前的位置协议
)类型: Boolean 允许当前环境被认定为“本地”,(如文件系统),即使jQuery默认情况下不会这么做。以下协议目前公认为本地:file
,*-extension
, andwidget
。如果isLocal
设置需要修改,建议在$.ajaxSetup()
方法中这样做一次。 (1.5 新增 ) - jsonp类型: String 在一个jsonp请求中重写回调函数的名字。这个值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分,比如{jsonp:'onJsonPLoad'}会导致将"onJsonPLoad=?"传给服务器。在jQuery 1.5,,设置
jsonp
选项为false
,阻止了jQuery从加入"?callback"字符串的URL或试图使用"=?"转换。在这种情况下,你也应该明确设置jsonpCallback
设置。例如,{ jsonp: false, jsonpCallback: "callbackName" }
- jsonpCallback类型: String, Function 为jsonp请求指定一个回调函数名。这个值将用来取代jQuery自动生成的随机函数名。这主要用来让jQuery生成一个独特的函数名,这样管理请求更容易,也能方便地提供回调函数和错误处理。你也可以在想让浏览器缓存GET请求的时候,指定这个回调函数名。从jQuery 1.5开始,你也可以使用一个函数作为该参数设置,在这种情况下,该函数的返回值就是
jsonpCallback
的结果。 - mimeType类型: String 一个mime类型用来覆盖XHR的 MIME类型。 (1.5 新增 )
- password类型: String 用于响应HTTP访问认证请求的密码
- processData (默认:
true
)类型: Boolean 默认情况下,通过data选项传递进来的数据,如果是一个对象(技术上讲只要不是字符串),都会处理转化成一个查询字符串,以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息,请设置为false
。 - scriptCharset类型: String 仅适用于当"script"传输使用时(例如,跨域的"jsonp"或 dataType选项为"script" 和 "GET"类型)。请求中使用在script标签上设置
charset
属性。通常只在本地和远程的内容编码不同时使用。 - statusCode (默认:
{}
)类型: PlainObject一组数值的HTTP代码和函数对象,当响应时调用了相应的代码。例如,如果响应状态是404,将触发以下警报:
$.ajax({ statusCode: { 404: function() { alert("page not found"); } } });
如果请求成功,状态代码对应的函数作为回调的成功相同的参数;如果在一个错误的结果,他们采取了相同的参数
(1.5 新增 )error
回调。 - success类型: Function( Object data, String textStatus, jqXHR jqXHR )请求成功后的回调函数。这个函数传递3个参数:从服务器返回的数据,并根据dataType参数进行处理后的数据,一个描述状态的字符串;还有 jqXHR(在jQuery 1.4.x前为XMLHttpRequest) 对象 。在jQuery 1.5, 成功设置可以接受一个函数数组。每个函数将被依次调用。这是一个 Ajax Event
- timeout类型: Number 设置请求超时时间(毫秒)。此设置将覆盖$.ajaxSetup() 里的全局设置。 超时周期开始于
$.ajax
访问成功的那个时间点;如果几个其他请求都在进步并且浏览器有没有可用的连接,它有可能在被发送前就超时了。在 jQuery 1.4.x 和前面的版本中, 如果请求超时,XMLHttpRequest对象是处于无效状态;访问任何对象的成员可能会抛出一个异常。只有在 Firefox 3.0+,script 和 JSONP请求在超时后不能被取消;该脚本将运行即使超时后到达。 - traditional类型: Boolean 如果你想要用传统的方式来序列化数据,那么就设置为
true
。请参考工具分类下面的jQuery.param 方法. - type (默认:
'GET'
)类型: String 请求方式 ("POST" 或 "GET"), 默认为 "GET"。注意:其它 HTTP 请求方法,如 PUT 和 DELETE 也可以使用,但仅部分浏览器支持。 - url (默认:
当前页面地址
)类型: String 发送请求的地址。 - username类型: String 于响应HTTP访问认证请求的用户名
- xhr (默认:
当可用的ActiveXObject(IE)中,否则为XMLHttpRequest
)类型: Function()回调创建XMLHttpRequest对象。当可用时默认为ActiveXObject(IE)中,否则为XMLHttpRequest。提供覆盖你自己的执行的XMLHttpRequest或增强工厂。 - xhrFields类型: PlainObject
一对“文件名-文件值”组成的映射,用于设定原生的
XHR
对象。例如,如果需要的话,在进行跨域请求时,你可以用它来设置withCredentials
为true
。$.ajax({ url: a_cross_domain_url, xhrFields: { withCredentials: true } });
在 jQuery 1.5中,
(1.5.1新增)withCredentials
属性不会传递给原生的XHR
从而对于需要使用此属性的 CORS 请求,则只能忽略这个属性。。出于这个原因,我们建议您使用jQuery1.5.1+,如果您需要使用它。
- accepts (默认:
- settings 类型: PlainObject 一个以"{键:值}"组成的AJAX 请求设置。所有选项都是可选的。可以使用$.ajaxSetup()设置任何默认参数。
jQuery 发送的所有 Ajax 请求,内部都会通过调用 $.ajax()
函数来实现。通常没有必要直接调用这个函数,可以使用几个已经封装的简便方法,如$.get()
和.load()
。如果你需要用到那些不常见的选项,那么, $.ajax()
使用起来更灵活。
在简单地说, $.ajax()
函数可以不带参数调用:
$.ajax();
注意: 所有的选项都可以通过$.ajaxSetup()
函数来全局设置
这个例子中,不使用选项,加载当前页面的内容,但其结果没用的。若要使用结果,我们可以实现的回调功能之一。
jqXHR 对象
从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信息头:
$.ajax({
url: "http://fiddle.jshell.net/favicon.png",
beforeSend: function ( xhr ) {
xhr.overrideMimeType("text/plain; charset=x-user-defined");
}
}).done(function ( data ) {
if( console && console.log ) {
console.log("Sample of data:", data.slice(0, 100));
}
});
从 jQuery 1.5 开始,$.ajax()
返回的jqXHR对象 实现了 Promise 接口, 使它拥有了 Promise 的所有属性,方法和行为。(见Deferred object获取更多信息)。为了让回调函数的名字统一,便于在$.ajax()
中使用。jqXHR也提供.error()
.success()
和.complete()
方法。这些方法都带有一个参数,该参数是一个函数,此函数在 $.ajax()
请求结束时被调用,并且这个函数接收的参数,与调用 $.ajax()
函数时的参数是一致。这将允许你在一次请求时,对多个回调函数进行赋值,甚至允许你在请求已经完成后,对回调函数进行赋值(如果该请求已经完成,则回调函数会被立刻调用)。
- jqXHR.done(function(data, textStatus, jqXHR) {});
一个可供选择的 success 回调选项的构造函数,
.done()
方法取代了的过时的jqXHR.success()
方法。请参阅deferred.done()
的实现细节。 - jqXHR.fail(function(jqXHR, textStatus, errorThrown) {});
一种可供选择的 error 回调选项的构造函数,
.fail()
方法取代了的过时的.error()
方法。请参阅deferred.fail()
的实现细节。 - jqXHR.always(function(data|jqXHR, textStatus, jqXHR|errorThrown) { });
一种可供选择的 complete 回调选项的构造函数,
.always()
方法取代了的过时的.complete()
方法。在响应一个成功的请求后,该函数的参数和
.done()
的参数是相同的:data, textStatus, 和 jqXHR 对象.对于失败的请求,参数和.fail()
的参数是相同的:jqXHR 对象, textStatus, 和 errorThrown。请参阅deferred.always()
的实现细节。 - jqXHR.then(function(data, textStatus, jqXHR) {}, function(jqXHR, textStatus, errorThrown) {});
包含了
.done()
和.fail()
方法的功能,(从 jQuery 1.8 开始)允许底层被操纵。请参阅deferred.then()
的实现细节。
推荐使用的注意事项: jqXHR.success()
, jqXHR.error()
, 和 jqXHR.complete()
回调从 jQuery 1.8开始 被弃用。他们将最终被取消,您的代码应做好准备,使用jqXHR.done()
, jqXHR.fail()
, 和 jqXHR.always()
代替。
// Assign handlers immediately after making the request,
// and remember the jqxhr object for this request
var jqxhr = $.ajax( "example.php" )
.done(function() { alert("success"); })
.fail(function() { alert("error"); })
.always(function() { alert("complete"); });
// perform other work here ...
// Set another completion function for the request above
jqxhr.always(function() { alert("second complete"); });
this
在所有的回调中的引用,是这个对象在传递给$.ajax
的设置中上下文;如果没有指定context(上下文)
,this
引用的是Ajax设置的本身。
为了向后兼容XMLHttpRequest
,一jqXHR
对象将公开下列属性和方法:
readyState
status
statusText
responseXML
and/orresponseText
当底层的请求分别作出XML和/或文本响应setRequestHeader(name, value)
从标准出发,通过替换旧的值为新的值,而不是替换的新值到旧值getAllResponseHeaders()
getResponseHeader()
abort()
假如没有onreadystatechange
属性,因为不同的状态可以分别在 success
, error
, complete
和statusCode
方法中进行处理。
Callback Function Queues(回调函数)
beforeSend
, error
, dataFilter
, success
和 complete
接受的回调函数是在合适的时间调用。
从jQuery 1.5开始, fail
, done
,和从jQuery 1.6开始的always
回调钩子(hooks)采用先入先出队列管理。这意味着你可以为每个挂钩分配多个回调。见Deferred object methods ,这是实现内部的$.ajax()
回调钩子(hooks)。
这里有$.ajax()
提供的回调钩子 (hooks),如下:
- beforeSend 在发送请求之前调用,它接收
jqXHR
对象和settings
作为参数对象。 - error 在请求出错时调用。如果请求失败,在它们的顺序依次登记。他们接受
jqXHR
,字符串表示的错误类型,以及异常对象(如果有的话)。一些内置的错误会将 "abort", "timeout", "No Transport" 等字符串作为异常对象。 dataFilter
在请求成功之后调用。传入返回的数据以及dataType
参数的值。并且必须返回新的数据(可能是处理过的)传递给success
回调函数。success
当请求成功并接收到返回数据之后调用。传入返回后的数据,以及包含成功代码的字符串和jqXHR
对象。complete
请求完成时,无论是在失败或成功,它们按顺序依次执行回调。他们收到jqXHR
对象,以及一个包含成功或错误代码。
Data Types(数据类型)
$.ajax()函数依赖服务器提供的信息来处理返回的数据。如果服务器报告说返回的数据是XML,那么返回的结果就可以用普通的XML方法或者jQuery的选择器来遍历。如果见得到其他类型,比如HTML,则数据就以文本形式来对待。
通过dataType
选项还可以指定其他不同数据处理方式。除了单纯的xml
,dataType
还可以指定 html
, json
, jsonp
, script
, 或者 text
。
其中,text
和 xml
类型返回的数据不会经过处理。无论是通过jqXHR
对象的responseText
或responseXML
,这些数据仅仅是传递给处理程序的成功
注意:我们必须确保网页服务器报告的MIME类型与我们选择的 dataType
. 所匹配。比如说,XML的话,服务器端就必须声明 text/xml
或者 application/xml
来获得一致的结果。
如果指定为 html
类型,任何内嵌的JavaScript都会在HTML作为一个字符串返回之前执行。类似的,指定script
类型的话,也会先执行服务器端生成JavaScript,然后再把脚本作为一个文本数据返回。
如果指定为json
类型,则会把获取到的数据作为一个JavaScript对象来解析,并且把构建好的对象作为结果返回。为了实现这个目的,他首先尝试使用jQuery.parseJSON()
。如果浏览器不支持,则使用一个Function
来constructor。畸形的JSON数据将抛出一个解析错误(查看json.org了解更多信息)。JSON数据是一种能很方便通过JavaScript解析的结构化数据。如果获取的数据文件存放在远程服务器上(域名不同,也就是跨域获取数据),则需要使用jsonp
类型代替。
jsonp
类型会给请求的URL后面创建一个查询字符串参数 callback=?
。服务器端应当在JSON数据前加上回调函数名,以便完成一个有效的JSONP请求。如果要指定回调函数的参数名来取代默认的callback
,可以通过设置$.ajax()
的jsonp
参数。
注意:JSONP是JSON格式的扩展。他要求一些服务器端的代码来检测并处理查询字符串参数。更多信息可以参阅详细介绍了其使用的原帖.
当数据被从远程服务器取回(这是唯一可能使用script
或者 jsonp
数据类型),error
回调和全局事件将永远不会被触发。
愚人码头注:如果指定了script
或者jsonp
类型,那么当从服务器接收到数据时,实际上是用了<script>标签而不是XMLHttpRequest对象。这种情况下,$.ajax()不再返回一个XMLHttpRequest对象,并且也不会传递事件处理函数,比如beforeSend。
Sending Data to the Server(发送数据到服务器)
默认情况下,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
。
Advanced Options(高级选项)
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
的一种解决方案,如下
(function () {
var _super = jQuery.ajaxSettings.xhr,
xhrCorsHeaders = [ "Cache-Control", "Content-Language", "Content-Type", "Expires", "Last-Modified", "Pragma" ];
jQuery.ajaxSettings.xhr = function () {
var xhr = _super(),
getAllResponseHeaders = xhr.getAllResponseHeaders;
xhr.getAllResponseHeaders = function () {
var allHeaders = "";
try {
allHeaders = getAllResponseHeaders.apply( xhr );
if ( allHeaders ) {return allHeaders;
}
} catch ( e ) {
}
$.each( xhrCorsHeaders, function ( i, headerName ) {
if ( xhr.getResponseHeader( headerName ) ) {allHeaders += headerName + ": " + xhr.getResponseHeader( headerName ) + "\n";
}
});
return allHeaders;
};
return xhr;
};
})();
Extending Ajax(扩展 Ajax)
从jQuery 1.5开始,,jQuery的Ajax实现包括预prefilters, transports和传输,让您更加灵活的扩展Ajax。如需有关这些先进功能的信息,请参阅Extending Ajax
Using Converters(使用转换器)
$.ajax()
的转换器支持的数据类型映射到其它数据类型。但是,如果你想把自定义数据类型映射到一个已知的类型(json
等),您必须contents
选项在响应的Content-Type和实际的数据类型之间的添加一个相关的转换函数:
$.ajaxSetup({
contents: {
mycustomtype: /mycustomtype/
},
converters: {
"mycustomtype json": function ( result ) {
// do stuff
return newresult;
}
}
});
这额外的对象是必要的,因为响应内容类型(Content-Types)和数据类型从来没有一个严格的一对一对应关系(正则表达式表示结果)。
转换一个支持的类型(例如text
, json
)成自定义数据类型,然后再返回,使用另一个直通转换器:
$.ajaxSetup({
contents: {
mycustomtype: /mycustomtype/
},
converters: {
"text mycustomtype": true,
"mycustomtype json": function ( result ) {
// do stuff
return newresult;
}
}
});
现在上面的代码允许通过从text
为mycustomtype
,进而,mycustomtype
转换为 json
。
Additional Notes:(其他注意事项:)
- 由于浏览器的安全限制,大多数“Ajax”的要求,均采用同一起源的政策 ;该请求不能成功地检索来自不同的域,子域或协议的数据。
- Script和JSONP形式请求不受同源策略的限制。
例子:
Example: 保存数据到服务器,成功时显示信息。
$.ajax({
type: "POST",
url: "some.php",
data: { name: "John", location: "Boston" }
}).done(function( msg ) {
alert( "Data Saved: " + msg );
});
Example: 装入一个 HTML 网页最新版本。
$.ajax({
url: "test.html",
cache: false
}).done(function( html ) {
$("#results").append(html);
});
Example: 发送 XML 数据至服务器。设置 processData 选项为 false
,防止自动转换数据格式。
var xmlDocument = [create xml document];
var xmlRequest = $.ajax({
url: "page.php",
processData: false,
data: xmlDocument
});
xmlRequest.done(handleResponse);
Example: 发送id作为数据发送到服务器, 保存一些数据到服务器上, 并通一旦它的完成知用户。 如果请求失败,则提醒用户。
var menuId = $("ul.nav").first().attr("id");
var request = $.ajax({
url: "script.php",
type: "POST",
data: {id : menuId},
dataType: "html"
});
request.done(function(msg) {
$("#log").html( msg );
});
request.fail(function(jqXHR, textStatus) {
alert( "Request failed: " + textStatus );
});
Example: 载入并执行一个JavaScript文件.
$.ajax({
type: "GET",
url: "test.js",
dataType: "script"
});
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论