jQuery.ajax()
jQuery.ajax( url, [ settings ] ) 返回: jqXHR
描述: 执行一个异步的HTTP(Ajax)的请求。
-
version added: 1.5jQuery.ajax( url, [ settings ] )
url一个用来包含发送请求的URL字符串。
settings一个以"{键:值}"组成的AJAX 请求设置。所有选项都是可选的。可以使用$.ajaxSetup()设置任何默认参数。看jQuery.ajax( settings )下所有设置的完整列表。
-
version added: 1.0jQuery.ajax( settings )
settings一个以"{键:值}"组成的AJAX 请求设置。所有选项都是可选的。可以使用$.ajaxSetup()设置任何默认参数。
$.ajax()
函数所有的基础jQuery的Ajax请求发送。它往往不是必须的,直接调用这个函数,几个高层次的替代品如$.get()
和.load()
可用,更容易使用,如果不常见的选项是必需的,不过, $.ajax()
可以使用更灵活。
在简单地说, $.ajax()
函数可以不带参数调用:
$.ajax();
注意: 所有的选项都可以通过$.ajaxSetup()
函数来全局设置
这个例子中,不使用选项,加载当前页面的内容,但其结果没有。若要使用结果,我们可以实现的回调功能之一。
jqXHR 对象
该jQuery的XMLHttpRequest(jqXHR)对象返回$.ajax()
在jQuery 1.5是一个对象的超集浏览器的原生的XMLHttpRequest。例如,它包含responseText
和responseXML
性能,以及一个getResponseHeader()
方法。当传输机制是XMLHttpRequest以外的东西(例如,一个一个JSONP请求脚本标签)的jqXHR对象尽可能的模拟原生的XHR功能。
在jQuery 1.5.1, 在jqXHR
对象还包含了overrideMimeType
方法。
$.ajax()
返回的jqXHR对象 实现约定的接口,给他们的所有属性,方法,和约定的行为(见Deferred object获取更多信息)。为了方便和一致性$.ajax()
回调函数名称中使用。jqXHR也提供.error()
.success()
和.complete()
方法。这些方法当$.ajax()
请求终止时需要一个函数参数调用,这个函数接收$.ajax()
回调函数名相同的参数。在jQuery 1.5这允许你指定一个请求的多个回调,甚至可能分配请求后已完成回调。(如果请求已经完成,回调立即触发。)
// Assign handlers immediately after making the request, // and remember the jqxhr object for this request var jqxhr = $.ajax({ url: "example.php" }) .success(function() { alert("success"); }) .error(function() { alert("error"); }) .complete(function() { alert("complete"); }); // perform other work here ... // Set another completion function for the request above jqxhr.complete(function(){ alert("second complete"); });
为了向后兼容XMLHttpRequest
,一jqXHR
对象将公开下列属性和方法:
readyState
status
statusText
-
responseXML
and/orresponseText
当底层的请求分别作出XML和/或文本响应 -
setRequestHeader(name, value)
这背离了换上了新一旧的价值,而不是串联的新值与旧标准 getAllResponseHeaders()
getResponseHeader()
abort()
假如没有onreadystatechange
机制,不管怎样
由于success
, error
, complete
和statusCode
覆盖所有可能的要求。
回调函数
如果要处理$.ajax()得到的数据,则需要使用回调函数。beforeSend、error、dataFilter、success、complete。
在jQuery 1.5, error
, success
,和complete
回调钩子先入先出队列管理。这意味着你可以为每个挂钩分配多个回调。见Deferred object methods ,这是实现内部的$.ajax()
回调挂钩。
在this
回调是在所有参考对象在context
选项传递给$.ajax
在设置;如果context
没有指定, this
是他们自己的Ajax设置参考。
某些类型Ajax的请求,如JSONP形式和跨域的GET请求,请不要使用XHR;在这些情况下XMLHttpRequest
和textStatus
参数传递给回调是undefined
。
这里有$.ajax()
提供的钩子回调 :
- beforeSend 在发送请求之前调用,它接收
jqXHR
对象和settings
作为参数对象。 - error 在请求出错时调用。如果请求失败,在它们的顺序依次登记。他们收到
jqXHR
,字符串表示的错误类型,如果适用的异常对象。一些内置的错误,将提供作为例外对象的字符串: "abort", "timeout", "No Transport"。 dataFilter
在请求成功之后调用。传入返回的数据以及dataType
参数的值。并且必须返回新的数据(可能是处理过的)传递给success
回调函数。success
当请求之后调用。传入返回后的数据,以及包含成功代码的字符串。他们收到返回的数据,一个包含成功的代码和jqXHR
对象。complete
它们的顺序依次登记回调,请求完成时,无论是在失败或成功。他们收到jqXHR
对象,以及一个包含成功或错误代码。
For example, 通过使用返回的HTML,我们可以实现一个success
事件处理器:
$.ajax({ url: 'ajax/test.html', success: function(data) { $('.result').html(data); alert('Load was performed.'); } });
数据类型
$.ajax()函数依赖服务器提供的信息来处理返回的数据。如果服务器报告说返回的数据是XML,那么返回的结果就可以用普通的XML方法或者jQuery的选择器来遍历。如果见得到其他类型,比如HTML,则数据就以文本形式来对待。
通过dataType选项还可以指定其他不同数据处理方式。除了单纯的XML,还可以指定 html、json、jsonp、script或者text。
其中,text和xml类型返回的数据不会经过处理。这些数据仅仅是传递给处理程序的成功,无论是通过responseText
或responseXML
所有的jqXHR
对象。
注意:我们必须确保网页服务器报告的MIME类型与我们选择的dataType所匹配。比如说,XML的话,服务器端就必须声明 text/xml
或者 application/xml
来获得一致的结果。
如果指定为 html
类型,任何内嵌的JavaScript都会在HTML作为一个字符串返回之前执行。类似的,指定script
类型的话,也会先执行服务器端生成JavaScript,然后再把脚本作为一个文本数据返回。
如果指定为json
类型,则会把获取到的数据作为一个JavaScript对象来解析,并且把构建好的对象作为结果返回。为了实现这个目的,他首先尝试使用jQuery.parseJSON()
。如果浏览器不支持,则使用一个Function
来构建。JSON数据是一种能很方便通过JavaScript解析的结构化数据。如果获取的数据文件存放在远程服务器上(域名不同,也就是跨域获取数据),则需要使用jsonp类型。使用这种类型的话,会创建一个查询字符串参数 callback=?
,这个参数会加在请求的URL后面。服务器端应当在JSON数据前加上回调函数名,以便完成一个有效的JSONP请求。如果要指定回调函数的参数名来取代默认的callback,可以通过设置$.ajax()
的jsonp参数。
注意:JSONP是JSON格式的扩展。他要求一些服务器端的代码来检测并处理查询字符串参数。更多信息可以参阅original post detailing its use.
如果指定了script
或者jsonp
类型,那么当从服务器接收到数据时,实际上是用了<script>标签而不是XMLHttpRequest对象。这种情况下,$.ajax()不再返回一个XMLHttpRequest对象,并且也不会传递事件处理函数,比如beforeSend。
发送数据到服务器
默认情况下,Ajax请求使用GET方法。如果要使用POST方法,可以设定type
参数值。这个选项也会影响data选项中的内容如何发送到服务器。
data选项既可以包含一个查询字符串,比如 key1=value1&key2=value2 ,也可以是一个映射,比如 {key1: 'value1', key2: 'value2'} 。如果使用了后者的形式,则数据再发送器会被转换成查询字符串。这个处理过程也可以通过设置processData选项为false来回避。如果我们希望发送一个XML对象给服务器时,这种处理可能并不合适。并且在这种情况下,我们也应当改变contentType选项的值,用其他合适的MIME类型来取代默认的 application/x-www-form-urlencoded 。
高级选项
global选项用于阻止响应注册的回调函数,比如.ajaxSend,或者ajaxError,以及类似的方法。这在有些时候很有用,比如发送的请求非常频繁且简短的时候,就可以在ajaxSend里禁用这个。更多关于这些方法的详细信息,请参阅下面的内容。
如果服务器需要HTTP认证,可以使用用户名和密码可以通过username和password选项来设置。
Ajax请求是限时的,所以错误警告被捕获并处理后,可以用来提升用户体验。请求超时这个参数通常就保留其默认值,要不就通过jQuery.ajaxSetup来全局设定,很少为特定的请求重新设置timeout选项。
默认情况下,请求总会被发出去,但浏览器有可能从他的缓存中调取数据。要禁止使用缓存的结果,可以设置cache参数为false。如果希望判断数据自从上次请求后没有更改过就报告出错的话,可以设置ifModified为true。
scriptCharset允许给<script>标签的请求设定一个特定的字符集,用于script或者jsonp类似的数据。当脚本和页面字符集不同时,这特别好用。
Ajax的第一个字母是asynchronous的开头字母,这意味着所有的操作都是并行的,完成的顺序没有前后关系。$.ajax()的async参数总是设置成true,这标志着在请求开始后,其他代码依然能够执行。强烈不建议把这个选项设置成false,这意味着所有的请求都不再是异步的了,这也会导致浏览器被锁死。
$.ajax函数返回他创建的XMLHttpRequest对象。通常jQuery只在内部处理并创建这个对象,但用户也可以通过xhr选项来传递一个自己创建的xhr对象。返回的对象通常已经被丢弃了,但依然提供一个底层接口来观察和操控请求。比如说,调用对象上的.abort()可以在请求完成前挂起请求。
扩展的Ajax
在jQuery 1.5,,jQuery的Ajax实现包括预过滤器,转换器和传输,让您扩展了很大的灵活性Ajax。如需有关这些先进功能的信息,请参阅Extending Ajax
其他注意事项:
- 由于浏览器的安全限制,大多数“Ajax”的要求,均采用同一起源的政策 ;该请求不能成功地检索来自不同的域,子域或协议的数据。
- Script和JSONP形式请求不受同源策略的限制。
Examples:
Example: 加载并执行一个 JS 文件。
$.ajax({
type: "GET",
url: "test.js",
dataType: "script"
});
Example: 保存数据到服务器,成功时显示信息。
$.ajax({
type: "POST",
url: "some.php",
data: "name=John&location=Boston",
success: function(msg){
alert( "Data Saved: " + msg );
}
});
Example: 装入一个 HTML 网页最新版本。
$.ajax({
url: "test.html",
cache: false,
success: function(html){
$("#results").append(html);
}
});
Example: 同步加载数据。发送请求时锁住浏览器。需要锁定用户交互操作时使用同步方式。
var html = $.ajax({
url: "some.php",
async: false
}).responseText;
Example: 发送 XML 数据至服务器。设置 processData 选项为 false,防止自动转换数据格式。
var xmlDocument = [create xml document];
$.ajax({
url: "page.php",
processData: false,
data: xmlDocument,
success: handleResponse
});
Example: 作为发送数据到服务器的ID,保存一些数据到服务器,并通知用户一旦它的完成。请注意,此用法 - 返回到一个变量的调用的结果 - 需要同步(阻塞)的要求! (异步:假)
bodyContent = $.ajax({
url: "script.php",
global: false,
type: "POST",
data: ({id : this.getAttribute('id')}),
dataType: "html",
async:false,
success: function(msg){
alert(msg);
}
}
).responseText;