返回值:xmlhttprequestjquery.ajax(url,[settings])
概述
通过 http 请求加载远程数据。
jquery 底层 ajax 实现。简单易用的高层实现见 $.get, $.post 等。$.ajax() 返回其创建的 xmlhttprequest 对象。大多数情况下你无需直接操作该函数,除非你需要操作不常用的选项,以获得更多的灵活性。
最简单的情况下,$.ajax()可以不带任何参数直接使用。
注意,所有的选项都可以通过$.ajaxsetup()函数来全局设置。
回调函数
如果要处理$.ajax()得到的数据,则需要使用回调函数。beforesend、error、datafilter、success、complete。
- beforesend 在发送请求之前调用,并且传入一个xmlhttprequest作为参数。
- error 在请求出错时调用。传入xmlhttprequest对象,描述错误类型的字符串以及一个异常对象(如果有的话)
- datafilter 在请求成功之后调用。传入返回的数据以及"datatype"参数的值。并且必须返回新的数据(可能是处理过的)传递给success回调函数。
- success 当请求之后调用。传入返回后的数据,以及包含成功代码的字符串。
- complete 当请求完成之后调用这个函数,无论成功或失败。传入xmlhttprequest对象,以及一个包含成功或错误代码的字符串。
数据类型
$.ajax()函数依赖服务器提供的信息来处理返回的数据。如果服务器报告说返回的数据是xml,那么返回的结果就可以用普通的xml方法或者jquery的选择器来遍历。如果见得到其他类型,比如html,则数据就以文本形式来对待。
通过datatype选项还可以指定其他不同数据处理方式。除了单纯的xml,还可以指定 html、json、jsonp、script或者text。
其中,text和xml类型返回的数据不会经过处理。数据仅仅简单的将xmlhttprequest的responsetext或responsehtml属性传递给success回调函数,
'''注意''',我们必须确保网页服务器报告的mime类型与我们选择的datatype所匹配。比如说,xml的话,服务器端就必须声明 text/xml 或者 application/xml 来获得一致的结果。
如果指定为html类型,任何内嵌的javascript都会在html作为一个字符串返回之前执行。类似的,指定script类型的话,也会先执行服务器端生成javascript,然后再把脚本作为一个文本数据返回。
如果指定为json类型,则会把获取到的数据作为一个javascript对象来解析,并且把构建好的对象作为结果返回。为了实现这个目的,他首先尝试使用json.parse()。如果浏览器不支持,则使用一个函数来构建。json数据是一种能很方便通过javascript解析的结构化数据。如果获取的数据文件存放在远程服务器上(域名不同,也就是跨域获取数据),则需要使用jsonp类型。使用这种类型的话,会创建一个查询字符串参数 callback=? ,这个参数会加在请求的url后面。服务器端应当在json数据前加上回调函数名,以便完成一个有效的jsonp请求。如果要指定回调函数的参数名来取代默认的callback,可以通过设置$.ajax()的jsonp参数。
注意,jsonp是json格式的扩展。他要求一些服务器端的代码来检测并处理查询字符串参数。更多信息可以参阅 最初的文章。
如果指定了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()可以在请求完成前挂起请求。
参数
url,[settings]objectv1.5
url:一个用来包含发送请求的url字符串。
settings:ajax 请求设置。所有选项都是可选的。
v1.0settings:选项
acceptsmap
默认: 取决于数据类型。
内容类型发送请求头,告诉服务器什么样的响应会接受返回。如果accepts设置需要修改,推荐在$.ajaxsetup()方法中做一次。
asyncboolean
(默认: true) 默认设置下,所有请求均为异步请求。如果需要发送同步请求,请将此选项设置为 false。注意,同步请求将锁住浏览器,用户其它操作必须等待请求完成才可以执行。
beforesend(xhr)function
发送请求前可修改 xmlhttprequest 对象的函数,如添加自定义 http 头。xmlhttprequest 对象是唯一的参数。这是一个 ajax 事件。如果返回false可以取消本次ajax请求。
function (xmlhttprequest) { this; // 调用本次ajax请求时传递的options参数 }
cacheboolean
(默认: true,datatype为script和jsonp时默认为false) jquery 1.2 新功能,设置为 false 将不缓存此页面。
complete(xhr, ts)function
请求完成后回调函数 (请求成功或失败之后均调用)。参数: xmlhttprequest 对象和一个描述成功请求类型的字符串。 ajax 事件。
function (xmlhttprequest, textstatus) { this; // 调用本次ajax请求时传递的options参数 }
contentsmapv1.5
一个以"{字符串:正则表达式}"配对的对象,用来确定jquery将如何解析响应,给定其内容类型。
contenttypestring
(默认: "application/x-www-form-urlencoded") 发送信息至服务器时内容编码类型。默认值适合大多数情况。如果你明确地传递了一个content-type给 $.ajax() 那么他必定会发送给服务器(即使没有数据要发送)
contextobject
这个对象用于设置ajax相关回调函数的上下文。也就是说,让回调函数内this指向这个对象(如果不设定这个参数,那么this就指向调用本次ajax请求时传递的options参数)。比如指定一个dom元素作为context参数,这样就设置了success回调函数的上下文为这个dom元素。就像这样:
$.ajax({ url: "test.html", context: document.body, success: function(){ $(this).addclass("done"); }});
convertersmapv1.5
默认: {"* text": window.string, "text html": true, "text json": jquery.parsejson, "text xml": jquery.parsexml}
一个数据类型对数据类型转换器的对象。每个转换器的值是一个函数,返回响应的转化值
crossdomainmapv1.5
默认: 同域请求为false
跨域请求为true如果你想强制跨域请求(如jsonp形式)同一域,设置crossdomain为true。这使得例如,服务器端重定向到另一个域
dataobject,string
发送到服务器的数据。将自动转换为请求字符串格式。get 请求中将附加在 url 后。查看 processdata 选项说明以禁止此自动转换。必须为 key/value 格式。如果为数组,jquery 将自动为不同值对应同一个名称。如 {foo:["bar1", "bar2"]} 转换为 "&foo=bar1&foo=bar2"。
datafilterfunction
给ajax返回的原始数据的进行预处理的函数。提供data和type两个参数:data是ajax返回的原始数据,type是调用jquery.ajax时提供的datatype参数。函数返回的值将由jquery进一步处理。
function (data, type) { // 对ajax返回的原始数据进行预处理 return data // 返回处理后的数据 }
datatypestring
预期服务器返回的数据类型。如果不指定,jquery 将自动根据 http 包 mime 信息来智能判断,比如xml mime类型就被识别为xml。在1.4中,json就会生成一个javascript对象,而script则会执行这个脚本。随后服务器端返回的数据会根据这个值解析后,传递给回调函数。可用值:
"xml": 返回 xml 文档,可用 jquery 处理。
"html": 返回纯文本 html 信息;包含的script标签会在插入dom时执行。
"script": 返回纯文本 javascript 代码。不会自动缓存结果。除非设置了"cache"参数。'''注意:'''在远程请求时(不在同一个域下),所有post请求都将转为get请求。(因为将使用dom的script标签来加载)
"json": 返回 json 数据 。
"jsonp": jsonp 格式。使用 jsonp 形式调用函数时,如 "myurl?callback=?" jquery 将自动替换 ? 为正确的函数名,以执行回调函数。
"text": 返回纯文本字符串
errorfunction
(默认: 自动判断 (xml 或 html)) 请求失败时调用此函数。有以下三个参数:xmlhttprequest 对象、错误信息、(可选)捕获的异常对象。如果发生了错误,错误信息(第二个参数)除了得到null之外,还可能是"timeout", "error", "notmodified" 和 "parsererror"。ajax 事件。
function (xmlhttprequest, textstatus, errorthrown) { // 通常 textstatus 和 errorthrown 之中 // 只有一个会包含信息 this; // 调用本次ajax请求时传递的options参数 }
globalboolean
(默认: true) 是否触发全局 ajax 事件。设置为 false 将不会触发全局 ajax 事件,如 ajaxstart 或 ajaxstop 可用于控制不同的 ajax 事件。
headersmapv1.5
default: {}
一个额外的"{键:值}"对映射到请求一起发送。此设置被设置之前beforesend函数被调用;因此,消息头中的值设置可以在覆盖beforesend函数范围内的任何设置。
ifmodifiedboolean
(默认: false) 仅在服务器数据改变时获取新数据。使用 http 包 last-modified 头信息判断。在jquery 1.4中,他也会检查服务器指定的'etag'来确定数据没有被修改过。
islocalmapv1.5.1
默认: 取决于当前的位置协议
允许当前环境被认定为“本地”,(如文件系统),即使jquery默认情况下不会承认它。以下协议目前公认为本地:file, *-extension, and widget。如果islocal设置需要修改,建议在$.ajaxsetup()方法中这样做一次。
jsonpstring
在一个jsonp请求中重写回调函数的名字。这个值用来替代在"callback=?"这种get或post请求中url参数里的"callback"部分,比如{jsonp:'onjsonpload'}会导致将"onjsonpload=?"传给服务器。
jsonpcallbackstring
为jsonp请求指定一个回调函数名。这个值将用来取代jquery自动生成的随机函数名。这主要用来让jquery生成度独特的函数名,这样管理请求更容易,也能方便地提供回调函数和错误处理。你也可以在想让浏览器缓存get请求的时候,指定这个回调函数名。
mimetypestringv1.5.1
一个mime类型用来覆盖xhr的 mime类型。
passwordstring
用于响应http访问认证请求的密码
processdataboolean
(默认: true) 默认情况下,通过data选项传递进来的数据,如果是一个对象(技术上讲只要不是字符串),都会处理转化成一个查询字符串,以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 dom 树信息或其它不希望转换的信息,请设置为 false。
scriptcharsetstring
只有当请求时datatype为"jsonp"或"script",并且type是"get"才会用于强制修改charset。通常只在本地和远程的内容编码不同时使用。
statuscodemapv1.5
默认: {}
一组数值的http代码和函数对象,当响应时调用了相应的代码。例如,如果响应状态是404,将触发以下警报:
$.ajax({ statuscode: {404: function() { alert('page not found'); } });
success(data, textstatus, jqxhr)function,array
请求成功后的回调函数。参数:由服务器返回,并根据datatype参数进行处理后的数据;描述状态的字符串。还有 jqxhr(在jquery 1.4.x的中,xmlhttprequest) 对象 。在jquery 1.5, 成功设置可以接受一个函数数组。每个函数将被依次调用。 ajax 事件。
function (data, textstatus) { // data 可能是 xmldoc, jsonobj, html, text, 等等... this; // 调用本次ajax请求时传递的options参数 }
traditionalboolean
如果你想要用传统的方式来序列化数据,那么就设置为true。请参考工具分类下面的jquery.param 方法。
timeoutnumber
设置请求超时时间(毫秒)。此设置将覆盖全局设置。
typestring
(默认: "get") 请求方式 ("post" 或 "get"), 默认为 "get"。注意:其它 http 请求方法,如 put 和 delete 也可以使用,但仅部分浏览器支持。
urlstring
(默认: 当前页地址) 发送请求的地址。
usernamestring
用于响应http访问认证请求的用户名
xhrfunction
需要返回一个xmlhttprequest 对象。默认在ie下是activexobject 而其他情况下是xmlhttprequest 。用于重写或者提供一个增强的xmlhttprequest 对象。这个参数在jquery 1.3以前不可用。
xhrfieldsmapv1.5
一对“文件名-文件值”在本机设置xhr对象。例如,如果需要的话,你可以用它来设置withcredentials为true的跨域请求。
示例
描述:
加载并执行一个 js 文件。
jquery 代码:
$.ajax({
type: "get",
url: "test.js",
datatype: "script"
});
描述:
保存数据到服务器,成功时显示信息。
jquery 代码:
$.ajax({
type: "post",
url: "some.php",
data: "name=john&location=boston",
success: function(msg){
alert( "data saved: " + msg );
}
});
描述:
装入一个 html 网页最新版本。
jquery 代码:
$.ajax({
url: "test.html",
cache: false,
success: function(html){
$("#results").append(html);
}
});
描述:
同步加载数据。发送请求时锁住浏览器。需要锁定用户交互操作时使用同步方式。
jquery 代码:
var html = $.ajax({
url: "some.php",
async: false
}).responsetext;
描述:
发送 xml 数据至服务器。设置 processdata 选项为 false,防止自动转换数据格式。
jquery 代码:
var xmldocument = [create xml document];
$.ajax({
url: "page.php",
processdata: false,
data: xmldocument,
success: handleresponse
});