$.ajax()方法详解
jquery中的ajax方法参数总是记不住,这里记录一下。
1.url:
要求为String类型的参数,(默认为当前页地址)发送请求的地址。
2.type:
要求为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包mime信息返回responseXML或responseText,并作为回调函数参数传递。可用的类型如下:
xml:返回XML文档,可用JQuery处理。
html:返回纯文本HTML信息;包含的script标签会在插入DOM时执行。
script:返回纯文本JavaScript代码。不会自动缓存结果。除非设置了cache参数。注意在远程请求时(不在同一个域下),所有post请求都将转为get请求。
json:返回JSON数据。
jsonp:JSONP格式。使用SONP形式调用函数时,例如myurl?callback=?,JQuery将自动替换后一个“?”为正确的函数名,以执行回调函数。
text:返回纯文本字符串。
8.beforeSend:
要求为Function类型的参数,发送请求前可以修改XMLHttpRequest对象的函数,例如添加自定义HTTP头。在beforeSend中如果返回false可以取消本次ajax请求。XMLHttpRequest对象是惟一的参数。
function(XMLHttpRequest){
this; //调用本次ajax请求时传递的options参数
}
9.complete:
要求为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参数
}
11.error:
要求为Function类型的参数,请求失败时被调用的函数。该函数有3个参数,即XMLHttpRequest对象、错误信息、捕获的错误对象(可选)。ajax事件函数如下:
function(XMLHttpRequest, textStatus, errorThrown){
//通常情况下textStatus和errorThrown只有其中一个包含信息
this; //调用本次ajax请求时传递的options参数
}
12.contentType:
要求为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.dataFilter:
要求为Function类型的参数,给Ajax返回的原始数据进行预处理的函数。提供data和type两个参数。data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataType参数。函数返回的值将由jQuery进一步处理。
function(data, type){
//返回处理后的数据
return data;
}
15.global:
要求为Boolean类型的参数,默认为true。表示是否触发全局ajax事件。设置为false将不会触发全局ajax事件,ajaxStart或ajaxStop可用于控制各种ajax事件。
16.ifModified:
要求为Boolean类型的参数,默认为false。仅在服务器数据改变时获取新数据。服务器数据改变判断的依据是Last-Modified头信息。默认值是false,即忽略头信息。
17.jsonp:
要求为String类型的参数,在一个jsonp请求中重写回调函数的名字。该值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分,例如{jsonp:'onJsonPLoad'}会导致将"onJsonPLoad=?"传给服务器。
18.username:
要求为String类型的参数,用于响应HTTP访问认证请求的用户名。
19.password:
要求为String类型的参数,用于响应HTTP访问认证请求的密码。
20.processData:
要求为Boolean类型的参数,默认为true。默认情况下,发送的数据将被转换为对象(从技术角度来讲并非字符串)以配合默认内容类型"application/x-www-form-urlencoded"。如果要发送DOM树信息或者其他不希望转换的信息,请设置为false。
21.scriptCharset:
要求为String类型的参数,只有当请求时dataType为"jsonp"或者"script",并且type是GET时才会用于强制修改字符集(charset)。通常在本地和远程的内容编码不同时使用。
样例代码:
<script type="text/JavaScript"> function LimitAttach(form, file) { if (!file){ alert("对不起,请上传文件"); return false; } while (file.indexOf("\\") != -1) file = file.slice(file.indexOf("\\") + 1); ext = file.slice(file.indexOf(".")).toLowerCase(); if (".xls" == ext||".xlsx"==ext) form.submit(); else{ alert("对不起,只能上传以下格式的文件: " + ".xls和.xlsx" + "\n请重新选择符合条件的文件" + "再上传."); return false; } } $(function(){ $('#div-importData-dialog').dialog({ title:'选择出版社', autoOpen:false, resizable:false, dialogClass:'ui-dialog-custom', width:400, modal:true, focus:null, buttons:[{ 'id':'btnSt', 'class':'btn blue', 'text':'确定', click:function(e){ $("#publisherId").val($("#publisher option:selected").val()); var formData = new FormData($("#fileUploadPublisher")[0]); $.ajax({ type: "POST", contentType: false, processData: false, beforeSend:function (){ $("#processBar").append("<div><img src='${pageContext.request.contextPath}/resources/bootstrap/image/loading.gif' /><div>"); }, Accept:'text/html;charset=UTF-8', url:"/PodCloud/operate/importAccount.action", //url data:formData, async: true, complete:function(){ $("#processBar").remove(); }, success: function(data) { /* alert(JSON.stringify(data)); */ if (data.status == 200){ alert(data.responseText); $('#div-importData-dialog').dialog('close'); }else{ $('#loadingModal').modal('hide'); alert("导入失败! "); } }, error: function(data) { /* alert(JSON.stringify(data)); */ if (data.status != 200){ alert("导入失败! "); }else{ alert(data.responseText); $('#div-importData-dialog').dialog('close'); } } }); } }, { 'id':'btnCl', 'class':'btn', 'text':'取消', click:function(){ $(this).dialog('close'); } }], }); $('#button').click(function(){ var excelFile = $("#excelFile").val(); var point = excelFile.substr(excelFile.lastIndexOf(".")).toLowerCase(); if (excelFile == "") { alert("对不起,请上传文件"); } else if (point != ".xls" && point != ".xlsx" ) { alert("对不起,只能上传以下格式的文件:" + ".xls和.xlsx" + "\n请重新选择符合条件的文件" + "再上传."); } else { $('#div-importData-dialog').dialog('open'); } }); }); </script>
<!-- 选择出版社对话框 --> <div id="div-importData-dialog" class="hide" style="width: 472" > <form class="form-horizontal"> <div class="control-group" > <label class="control-label"><span class="required">*</span>出版社:</label> <div class="controls comsel" style="position:relative"> <select data-placeholder="" class="m-wrap large select2" id="publisher" style="width:250px !important;"> <c:forEach var="item" items="${publisherList}"> <option data-id="${item.id}" value="${item.id}">${item.name}</option> </c:forEach> </select> </div> </div> </form> <div id="processBar" style="text-align: center;"></div> </div> <div class="form-group"> <form class="form-horizontal" method="" action="post" id="fileUploadPublisher" name="fileUpload" enctype="multipart/form-data"> 出版单位账号: <input class="form-control" type="file" id="excelFile" name="file"/> <input type="hidden" id="publisherId" value="" name="publisherId"/> <button class="btn btn-success" type="button" id="button" >导入出版单位信息 <i class="fa fa-upload"></i></button> <span style="white-space:pre"> </span> </form> </div> <div class="form-group"> <form class="form-horizontal" method="post" action="/PodCloud/operate/importAccount.action" id="fileUpload" name="fileUpload" enctype="multipart/form-data"> <input class="form-control" type="file" id="excelFile" name="file"/> <button class="btn btn-success" type="button" onclick="LimitAttach(this.form, this.form.file.value)">导入出版单位信息 <i class="fa fa-upload"></i></button> <span style="white-space:pre"> </span> </form> </div>