jQuery.ajax( url [, settings])
说明:执行一个异步的HTTP(Ajax)的请求。
jQuery.ajax( url [, settings])(添加的版本:1.5)
url
类型:String
一个用来包含发送请求的URL字符串。
settings
类型:PlainObject
一个以“{键:值}”组成的AJAX请求设置。所有选项都是可选的。可以使用$.ajaxSetup()设置任何默认参数。
例如,我们可以事先设置服务器重复响应的默认URL参数:
$.ajaxSetup({ url: "ping.php" });现在每次Ajax请求将自动使用这个“ping.php”URL:
$.ajax({ // url not set here; uses ping.php data: {"name": "Dan"} });
jQuery.ajax([settings])
settings
类型:PlainObject
一个以“{键:值}”组成的AJAX请求设置。所有选项都是可选的。可以使用$.ajaxSetup()设置任何默认参数。
accepts(默认:取决于数据类型)
类型:PlainObject一个键/值对集合映射给定的dataType到其的MIME类型,它可以从发送Accept请求头信息中获得。请求头信息通知服务器该请求接收何种类型的返回结果。例如,下面定义一个自定义类型的mycustomtype与请求一起发送:
$.ajax({ accepts: { mycustomtype: "application/x-some-custom-type" }, // Instructions for how to deserialize a "mycustomtype" converters: { "text mycustomtype": function(result){ // Do Stuff return newresult; } }, // Expect a "mycustomtype" back from server dataType: "mycustomtype" });注意:对于这种类型,为了使其正常工作,您将需要在converters中指定补充项。
async(默认:true)
类型:Boolean默认设置下,所有请求均为异步请求(也就是说这是默认设置为true)。如果需要发送同步请求,情将此选项设置为false。跨域请求和dataType:“jsonp”请求不支持同步操作。注意,同步请求将锁住浏览器,用户其它操作必须等待请求完成才可以执行。从jQuery1.8开始,jqXHR($.Deferred)中使用async: false已经过时。你必须谁用success/error/complete的回调选项代替相应的jqXHR对象的方法,比如jqXHRjqXHR.done()或过时的jqXHR.success()。
beforeSend
cache(默认:true,dataType为“script”和“jsonp”时默认为false)
类型:Boolean
如果设置为false,浏览器将不缓存此页面。注意:设置cache为false将在POST和GET请求中正常工作。它的工作原理是在GET请求参数中附加“_={timestamp}”。该参数不是其他请求所必须的,除了在IE8中,当一个POST请求一个已经用GET请求过的URL。
complete
类型:Function(jqXHR jqXHR, String textStatus)
请求完成后回调函数(请求success和error之后均调用)。这个回调函数得到2个参数:jqXHR(在jQuery1.4x中是XMLHTTPRequest)对象和一个描述请求状态的字符串(“success”,“notmodified”,“nocontent”,“error”,“timeout”,“abort”或者“parsererror”)。从jQuery1.5开始,complete设置可以接受一个函数的数组。每个函数将被依次调用。
contents
类型:PlainObject
一个以“{字符串/正则表达式}”配对的对象,根据给定的内容类型,解析请求的返回结果。
contetType(default:“application/x-www-form-urlencoded;charset=UTF-8”)
Type:Boolean or String
当将数据发送到服务器时,使用该内容类型。默认值是“application/x-www-form-urlencoded;charset=UTF-8”,适合大多数情况。如果你明确地传递了一个内容类型(Content-Type)给$.ajax(),那么它总是会发送给服务器(即使没有数据要发送)。从jQuery1.6开始,你可以传递false来告诉jQuery,没有设置任何内容类型头信息。注意:W3C的XMLHttpRequest的规范规定,数据将总是使用UTF-8字符集传递给服务器;指定其它字符集无法强制浏览器更改编码。注意:对于跨域请求,内容类型设置为application/x-www-form-urlencoded,multipart/form-data,或text/plain以外,将触发浏览器发送一个预检OPTIONS请求到服务器。
context
$.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})
crossDomain(默认:同域请求为false,跨域请求为true)
data
类型:PlainObject或String或ArraydataFilter
类型:Function(String data, String type)=>Anything
一个函数被用来处理XMLHttpRequest的原始响应数据。这是一个预过滤功能,净化响应。你应该返回安全数据。提供data和type两个参数:data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataType参数。
dataType(default:Intelligent Guess(xml,json,script,or html))
Type:String
从服务器返回你期望的数据类型。如果没有指定,jQuery将尝试通过MIME类型的响应信息来智能判断(一个XML MIME类型就被识别为XML,在1.4中JSON将生成一个JavaScript对象,在1.4中script将执行该脚本,其他任何类型会返回一个字符串)。可用的类型(以及结果作为第一个参数传递给成功回调函数)有:
- “xml”:返回XML文档,可以通过jQuery处理。
- “html”:返回纯文本HTML文本;包含的script标签会在插入DOM时执行。
- “script”:把响应的结果当作JavaScript执行,并将其当作纯文本返回。默认情况下会通过在URL中附加查询字符串变量,_=[TIMESTAMP],禁用缓存结果,除非设置了cache参数为true。注意:在远程请求时(不在同一个域下),所有POST请求都将转为GET请求。(因为将使用DOM的script标签来加载)
- “json”:把响应的结果当作JSON执行,并返回一个JavaScript对象。跨域“json”请求转换为“jsonp”,除非该请求在其请求选项中设置了jsonp:false。JSON数据以严格的方式解析;任何畸形的JSON将被拒绝,并且抛出解析错误信息。在jQuery1.9中,一个空响应也将被拒绝;服务器应该返回null或{}响应代替。
- “jsonp”:以JSONP的方式载入JSON数据块。会自动在所请求的URL最后添加“?callback=?”。默认情况下会通过在URL中附加查询字符串变量,_=[TIMESTAMP],禁用缓存结果,除非设置了cache参数为true。
- “text”:返回纯文本字符串。
error
类型:Function(jqXHR jqXHR, String textStatus, String errorThrown)
请求失败时调用此函数。有以下三个参数:jqXHR(在jQuery1.4.x前为XMLHttpRequest)对象、描述发生错误类型的一个字符串和捕获的异常对象。如果发生了错误,错误信息(第二个参数)除了得到null之外,还可能是“timeout”,“error”,“abort”和“parseerror”。当一个HTTP错误发生时,errorThrown接收HTTP状态的文本部分,比如:“Not Found”(没有找到)或者“Internal Server Error.”(服务器内部错误)。从jQuery1.5开始,在error设置可以接受函数组成的数组。每个函数将被依次调用。注意:此处理程序在跨域脚本和JSONP形式的请求时不被调用。
global(默认:true)
类型:Boolean
无论怎么样这个请求将触发全局AJAX事件处理程序。默认是true。设置为false将不会触发全局AJAX事件,如ajaxStart或者ajaxStop。这可以用来孔子各种Ajax Event。
headers(默认:{})
类型:Boolean
一个额外的“{键:值}”对映射到请求一起发送。此设置会在beforeSend函数调用之前被设置;因此,请求头中的设置值,会被beforeSend函数内的设置覆盖。
ifModified(默认:false)
类型:Boolean
只有上次请求响应改变时,才允许请求成功。使用HTTP包Last-Modified头信息判断。默认值是false,忽略HTTP头信息。在jQuery1.4中,他也会检查服务器的“etag”来确定数据没有被修改过。
isLocal(默认:取决于当前的位置协议)
类型:Boolean
允许当前环境被认定为“本地”,(如文件系统),即使jQuery默认情况下不会这么做。以下协议目前公认为本地:file,*-extension,and widget。如果isLocal设置需要修改,建议在$.ajaxSetup()方法中这样做一次。
jsonp
类型:String或者Boolean
在一个JSONP请求中重写回调函数的名字。这个值用来替代在“callback=?”这种GET或POST请求中URL参数里的“callback”部分,比如{jsonp:'onJsonPLoad'}会导致将“onJsonPLoad=?”传给服务器。在jQuery1.5,设置jsonp选项为false,阻止了从jQuery加入“?callback”字符串的URL或试图使用“=?”转换。在这种情况下,你也应该明确设置jsonpCallback设置。例如,{ jsonp:false, jsonpCallback: "callbackName" }。如果你不信任你的Ajax请求的目标,处于安全原因,考虑设置jsonp属性为false。
jsonpCallback
类型:String,Function
为jsonp请求指定一个回调函数名。这个值将用来取代jQuery自动生成的随机函数名。这主要用来让 jQuery生成一个独特的函数名,这样管理请求更容易,也能方便地提供回调函数和错误处理。你也可以在想让浏览器缓存GET请求的时候,指定这个回掉函数名。从jQuery1.5开始,你也可以使用一个函数作为该参数设置,在这种情况下,该函数的返回值就是jsonpCallback的结果。
method(default:“GET”)
Type:String
HTTP请求方法(比如:“POST”,"GET","PUT")。(如果是jQuery1.9.0之前的版本,你需要使用type选项。)
mimeType
类型:String
一个mime类型用来覆盖XHR的MIME类型。
password
类型:String
用于响应HTTP访问认证请求的密码
processData(默认:true)
类型:Boolean
默认情况下,通过data选项传递进来的数据,如果是一个对象(技术上讲只要不是字符串),都会处理转化成一个查询字符串,以配合默认内容类型“application/x-www-form-urlencoded”。如果要发送DOM树信息或其它不希望转换的信息,请设置为false。
scriptCharset
statusCode(默认:{})
类型:PlainObject
一个HTTP响应状态码和当请求响应相应的状态码时执行的函数组成的对象。例如:下面的代码将在http响应状态码为404时弹出“page not found”。
$.ajax({ statusCode: { 404: function() { alert("page not found"); } } });如果请求成功,响应状态代码对应的函数会带着success回调函数相同的参数;如果请求结果是错误的(包含3xx之类的重定向),他们会采用error回调函数相同的参数。
success
Type:Function(Anything data, String textStatus, jqXHR jqXHR)请求成功后的回调函数。这个函数传递3个参数:从服务器返回的数据,并根据dataType参数进行处理后的数据或dataFilter回调函数,如果指定的话;一个描述状态的字符串;还有jqXHR(在jQuery1.4.x前为XMLHttpRequest)对象。在jQuery1.5,成功设置可以接受一个函数数组。每个函数将被依次调用。
timeout
类型:Number
设置请求超时时间(毫秒)。值为0表示没有超时。此设置将覆盖$.ajaxSetup()里的全局设置。超时周期开始于$.ajax访问成功的那个时间点;
traditional
类型:Boolean
如果你想要用传统的方式来序列化数据,那么就设置为true。
type(默认:“GET”)
类型:String
method选项的别名。如果你使用jQuery1.9.0之前的版本,你需要使用type选项。
url(默认:当前页面地址)
类型:String
发送请求的地址。
username
类型:String
响应HTTP访问认证请求的用户名
xhr(默认:当可用的ActiveXObject(IE)中,否则为XMLHttpRequest)
类型:Function()
回调创建XMLHttpRequest对象。当可用时默认为ActiveObject(IE)中,否则为XMLHttpRequest。提供覆盖你自己的执行的XMLHttpRequest或增强工厂。
xhrFields
类型:PlainObject
一对“文件名-文件值”组成的映射,用于设定原生的XHR对象。例如,如果需要的话,在进行跨域请求时,你可以用它来设置withCredentials为true。
$.ajax({ url: a_cross_domain_url, xhrFields: { withCredentials: true } });在jQuery1.5中,withCredentials属性不会传递给原生的XHR从而对于需要使用此属性的CORS请求,则只能忽略这个属性。出于这个原因,我们建议你使用1.5.1+,如果你需要使用它。
jQuery发送的所有Ajax请求,内部都会通过调用$.ajax()函数来实现。通常没有必要直接调用这个函数,可以使用几个已经封装的简便方法,如$.get()和.load()。如果你需要用到哪些不常见的选项,那么,$.ajax()使用起来更灵活。
再简单地说,$.ajax()函数可以不带参数调用:
$.ajax();注意:所有的选项都可以通过$.ajaxSetup()函数来全局设置
这个例子中,不使用选项,加载当前页面的内容,但其结果没用的。若要使用结果,我们可以实现回调功能。
jqXHR对象
从jQuery1.5开始,$.ajax()返回XMLHttpRequest(jqXHR)对象,该对象是浏览器的原生的XMLHttpRequest对象的一个超集。例如,它包含responseText和responseXML属性,以及一个getResponseHeader()方法。当传输机制不是XMLHttpRequest时(例如,一个JSONP请求脚本,返回一个脚本tag时),jqXHR对象尽可能的模拟原生的XHR功能。从jQuery1.5开始,jqXHR对象还包含了overrideMimeType方法(它在jQuery1.4.x中是有效的,但是在jQuery1.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)); } });从jQuery1.5开始,$.ajax()返回的jqXHR对象实现了Promise接口,使它拥有了Promise的所有属性,方法和行为。为了让回调函数的名字统一,便于在$.ajax()中使用。jqXHR也提供.error() .success()和.complete()方法。这些方法都带有一个参数,该参数是一个函数,此函数在$.ajax()请求结束时被调用,并且这个函数接收的参数,与调用$.ajax()函数时的参数是一致。这将允许你在一次请求时,对多个回调函数进行赋值,甚至允许你在请求已经完成后,对回调函数进行赋值(如果该请求已经完成,则回调函数会被立刻调用)。
- jqXHR.done(function(data,textStatus,jqXHR){}):一个可供选择的success回调选项的构造函数。
- jqXHR.fail(function(jqXHR,textStatus,errorThrown){}):一种可供选择的error回调选项的构造函数,.fail()方法取代了过时的.error方法。
- jqXHR.always(function(data|jqXHR,textStatus,jqXHR|errorThrown){}):一个可供选择的complete回调选项的构造函数,.always()方法取代了过时的.complete()方法。在响应一个成功的请求后,该函数的参数和.done()的参数是相同的:data,textStatus和jqXHR对象。对于失败的请求,参数和.fail()的参数是相同的:jqXHR对象,textStatus和errorThrown。
- jqXHR.then(function(data, textStatus, jqXHR){}, function(jqXHR, textStatus, errorThrown){}):包含了.done()和.fail()方法的功能,(从jQuery1.8开始)允许底层被操纵。
推荐使用的注意事项:jqXHR.success(), jqXHR.error()和jqXHR.complete()回调从jQuery1.8开始被弃用过时。它们终将被取消,你的代码应做好准备,从jQuery3.0开始被删除,你可以使用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设置的本身。
- readyState
- status
- statusText
- responseXML and/or responseText 当底层的请求分别作出XML和/或文本响应
- setRequestHeader(name, value)从标准出发,通过替换旧的值为新的值,而不是替换新值到旧值
- getAllRequestHeaders()
- getResponseHeader()
- abort()
Callback Function Queues(回调函数)
beforeSend,error,dataFilter,success和complete接受的回调函数是在合适的时间调用。- beforeSend在发送请求之前调用,它接收jqXHR对象和settings作为参数对象。
- error在请求出错时调用。如果请求失败,在它们的顺序依次登记。它们接受jqXHR,字符串表示的错误类型,以及异常对象(如果有的话)。一些内置的错误会将“abort”,“timeout”,“No Transport”等字符串作为异常对象。
- dataFilter在请求成功之后调用。传入返回的数据以及dataType参数的值。并且必须返回新的数据(可能是处理过的)传递给success回调函数。
- success当请求成功并接收到返回数据之后调用。传入返回后的数据,以及包含成功代码的字符串和jqXHR对象。
- Promise callbacks - .done(), .fail(), .always() and .then()。根据它们注册的顺序被调用。
- complete请求完成时,无论是在失败或成功,它们按顺序依次执行回调。它们收到jqXHR对象,以及一个包含成功或错误代码。
Data Types(数据类型)
$.ajax()调用不同类型的响应,被传递到成功处理函数之前,会经过不同种类的预处理。预处理的类型取决于由更加接近默认的Content-Type响应,但可以明确使用dataType选项进行设置。如果提供了dataType选项,响应的Content-Type头信息将被忽略。Sending Data to the Server(发送数据到服务器)
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.ajaxSettins.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; }; })();
Extending Ajax(扩展Ajax)
从jQuery1.5开始,jQuery的Ajax实现包括预prefilters,transports和传输,让你更加灵活的扩展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。
Additoinal Notes:(其它注意事项)
- 由于浏览器的安全限制,大多数“Ajax”的要求,均采用同一起源的政策;该请求不能成功地检索来自不同的域,子域或协议的数据。
- Script和JSONP形式请求不受同源策略的限制。
例子:
$.ajax({ method: "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", method: "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({ method: "GET", url: "test.js", dataType: "script" });