$.ajax()⽅法参数详解
$.ajax()⽅法是jQuery最底层的Ajax实现。它的结构为:
$.ajax(options)
该⽅法只有⼀个参数,但是这个对象⾥包含了$.ajax()⽅法所需要的请求设置以及回调函数等信息,参数以key/value的形式存在,所有的参数都是可选的。常⽤参数见下表:
1.url
要求为String类型的参数,(默认为当前地址)发送请求的页⾯。
要求为String类型的参数,请求⽅式(post或get)默认为get。注意其他http请求⽅法,例如put和delete也可以使⽤,但仅部分浏览器⽀持。
3.timeout
要求为Number类型的参数,设置请求超时时间(毫秒)。此设置将覆盖$.ajaxSetup()⽅法的全局设置。
4.async
要求为Boolean类型的参数,默认设置为true,所有请求均为异步请求。如果需要同步请求,请将此选项设置为false。注意,同步请求将锁住浏览器,⽤户其他操作必须等待请求完成才可以执⾏。
5.cache
要求为Boolean类型的参数,默认为true(当dataType为Script时,默认为false),设置false将不会从浏览器缓存中加载请求信息。
6.data
要求为Object或String类型的参数,发送到服务器的数据。如果不是字符串,将⾃动转换为字符串格式。get请求中将附加在URL后。防⽌这种⾃动转换,可以查看 processData选项。对象必须为key/value格式,例如{foo1:"bar1",foo2:"bar2"}转换为
&foo1=bar1&foo2=bar2。如果是数组,JQuery将⾃动为不同值对应同⼀个名称。例如{foo:["bar1","bar2"]}转换为
&foo=bar1&foo=bar2。
7.dataType
要求为String类型的参数,预期服务器返回的数据类型。如果不指定,jQuery将⾃动根据HTTP包的mine信息返回responseXML或responseText,并作为回调函数参数传递。可⽤的类型如下:
xml:返回XML⽂档,可⽤jQuery处理。
html:返回纯⽂本HTML信息;包含的script标签会在插⼊DOM时执⾏。
script:返回纯⽂本javascript代码。不会⾃动缓存结果,除⾮设置了cache参数。注意在远程请求时(不在同⼀个域下),所有post 请求都将转为get请求。
json:返回JSON数据。
jsonp:JSON格式。使⽤JSONP形式调⽤函数时,例如myurl?callback=?,JQuery将⾃动替换后⼀个“?”为正确的函数名,以执⾏回调函数。
text:返回纯⽂本字符串。
8.beforeSend
要求为Function类型的参数,发送请求前可以修改XMLHttpRequest对象的函数,例如添加⾃定义HTTP头。在beforeSend中如果返回false可以取消本次ajax请求。XMLHttpRequest对象是唯⼀的参数。
function(XMLHttpRequest){
this;//调⽤本次ajax请求时传递的options参数
}
9plete
要求为Function类型的参数,请求完成后调⽤的回调函数(请求成功或失败均调⽤)。参数:XMLHttpRequest对象和⼀个描述成功请求类型的字符串。
function(XMLHttpRequest,textStatus){
this; //调⽤本次ajax请求时传递的options参数
}
10.success
要求为Function类型的参数,请求成功后调⽤的回调函数,有两个参数。
(1)由服务器返回,并根据dataType参数进⾏处理后的数据。
(2)描述状态的字符串。
function(data,textStatus){
//data可能是xmlDoc、jsonObj、html、text等
this; //调⽤本次ajax请求时传递的options参数
}
<
要求为Function类型的参数,请求失败时被调⽤的函数。该函数有3个参数,即XMLHttpRequest对象、错误信息、捕获的错误对象(可选)。ajax事件函数如下:
function(XMLHttpRequest,textStatus,errorThrown){
//通常情况下textStatus和errorThrown只有其中⼀个包含信息
this; //调⽤本次ajax请求时传递的options参数
}
要求为String类型的参数,当发送信息⾄服务器时。内容编码类型默认为"application/x-www-form-urlencoded"。该默认值适合⼤多数应⽤场合。
13.dataFilter
要求为Function类型的参数,给Ajax返回的原始数据进⾏预处理的函数。提供data和type两个参数。data是Ajax返回的原始数据,type是调⽤jQuery.ajax时提供的dataTYpe参数。函数返回的值将由jQuery进⼀步处理。
function(data,type){
//返回处理后的数据
return data;
}
14.global
要求为Boolean类型的参数,默认为true。表⽰是否触发全局ajax事件。设置为false将不会触发全局ajax事件,ajaxStart和ajaxStop可⽤于控制各种ajax事件。
15.ifModified
要求为Boolean类型的参数,默认为false。仅在服务器数据改变时获取新数据。服务器数据改变判断的依据是Last-Modified头信息。默认值是false,即忽略头信息。
16.jsonp
要求为String类型的参数,在⼀个jsonp请求中重写回调函数的名字。该值⽤来替代在"callback=?"这种GET或POST请求中URL参数⾥的"callback"部分,例如{jsonp:'onJsonPLoad'}会导致将"onJsonPLoad=?"传给服务器。
17.username
要求为String类型的参数,⽤于响应HTTP访问认证请求的⽤户。
jquery ajax例子18.password
要求为String类型的参数,⽤于响应HTTP访问认证请求的密码。
19.processData
要求为Boolean类型的参数,默认为true。默认情况下,发送的数据将被转换为对象(从技术⾓度来讲⽽⾮字符串)以配合默认内容类型"application/x-www-form-urlencoded"。如果要发送DOM树信息或者其他不希望转换的信息,请设置为false。
20.scriptCharset
要求为String类型的参数,只有当请求时dataType为"jsonp"或者"script",并且type是GET时才会⽤于强制修改字符集(charset)。通常在本地和远程的内容编码不同时使⽤。
案例代码:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20$(function(){
$('#send').click(function(){
$.ajax({
type: "GET",
url: "test.json",
data: {username:$("#username").val(), content:$("#content").val()},
dataType: "json",
success: function(data){
$('#resText').empty(); //清空resText⾥⾯的所有内容
var html = '';
$.each(data, function(commentIndex, comment){
html += '<div class="comment"><h6>'+ comment['username'] + ':</h6><p class="para"'+ comment['content']
+ '</p></div>';
});
$('#resText').html(html);
}
});
});
});
知识链接:
1、$.each()函数:$.each()函数不同于jQuery对象的each()⽅法,它是⼀个全局函数,不操作jQuery对象。该函数接收两个参数,第1个参数是⼀个数组或对象,第2个参数是⼀个回调函数。回调函数拥有两个参数:第1个参数为数组的索引或对象的成员,第2个参数为对应的变量或内容。
$.each(data,function(commentIndex,comment){
//doSomething;
})
2、ajaxStart()与ajaxStop():当Ajax请求开始时,会触发ajaxStart()⽅法的回调函数。当Ajax请求结束时,会触发ajaxStop()⽅法的回调函数。这些⽅法都是全局的⽅法,因此⽆论创建它们的代码位于何处,只要有Ajax请求发⽣时,就会触发它们。
有时候页⾯需要加载⼀些图⽚,可能速度会⽐较慢,如果在加载过程中,不给⽤户提供⼀些提⽰和反馈信息,很容易让⽤户误认为按钮单击⽆⽤,使⽤户对⽹站失去信息。
此时,我们就需要为⽹页添加⼀个提⽰信息,常⽤的提⽰信息是“加载中...”,代码如下:
1<div id="loading">加载中...</div>
当Ajax请求开始时,将此元素显⽰,⽤来提⽰⽤户Ajax请求正在进⾏;当Ajax请求结束后,将此元素隐藏。代码如下:
1 2 3 4 5$("#loading").ajaxStart(function(){ $(this).show();
}).ajaxStop(function(){
$(this).hide();
})
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论