ajax使用参数详解
参数及解析
- url:
String
(默认为当前页地址)发送请求的地址。 - type:
String
请求方式(post或get)默认为get。
注意其他http请求方法,例如put和delete也可以使用,但仅部分浏览器支持。 - timeout:
Number
设置请求超时时间(毫秒)。
此设置将覆盖$.ajaxSetup()方法的全局设置。 - async:
Boolean
默认设置true为异步请求。同步请求为false。 - cache:
Boolean
默认为true(当dataType为script时,默认为false),为false将不会从浏览器缓存中加载请求信息。 - data:
Object || String
发送到服务器的数据。
在参数 processData 默认为 true 的情况下,发送的数据被转换为对象。
在参数 processData 为 false 的情况下,发送的数据为字符串类型。
get 请求中的 data 参数将附加在 url 后。
对象必须为key/value格式,例如{foo1:“bar1”,foo2:“bar2”}转换为&foo1=bar1&foo2=bar2。如果是数组,JQuery将自动为不同值对应同一个名称。例如{foo:[“bar1”,“bar2”]}转换为&foo=bar1&foo=bar2。 - dataType:
String
预期服务器返回的数据类型。
如果不指定,JQuery将自动根据http包mime信息返回responseXML或responseText,并作为回调函数参数传递。
dataType 参数可用的类型如下:
xml:返回XML文档,可用JQuery处理。 html:返回纯文本HTML信息;包含的script标签会在插入DOM时执行。
script:返回纯文本JavaScript代码。不会自动缓存结果。除非设置了cache参数。注意在远程请求时(不在同一个域下),所有post请求都将转为get请求。
json:返回JSON数据。
jsonp:JSONP格式。使用SONP形式调用函数时,例如myurl?callback=?,JQuery将自动替换后一个“?”为正确的函数名,以执行回调函数。
text:返回纯文本字符串。 - beforeSend:
Function
类型的参数,发送请求前可以修改XMLHttpRequest对象的函数,例如添加自定义HTTP头。
在beforeSend中如果返回false可以取消本次ajax请求。XMLHttpRequest对象是惟一的参数。
function(XMLHttpRequest){
this; //调用本次ajax请求时传递的options参数
} - complete:
Function
类型的参数,请求完成后调用的回调函数(请求成功或失败时均调用)。
参数:XMLHttpRequest对象和一个描述成功请求类型的字符串。
function(XMLHttpRequest, textStatus){
this; //调用本次ajax请求时传递的options参数
} - success:
Function
类型的参数,请求成功后调用的回调函数,有两个参数。
(1)由服务器返回的数据;(数据是根据dataType的参数类型进行处理后的)。
(2)描述状态的字符串。
function(data, textStatus){
//data可能是xmlDoc、jsonObj、html、text等等
this; //调用本次ajax请求时传递的options参数
} - error:
Function
类型的参数,请求失败时被调用的函数。
该函数有3个参数,即XMLHttpRequest对象、错误信息、捕获的错误对象(可选)。ajax事件函数如下:
function(XMLHttpRequest, textStatus, errorThrown){
//通常情况下textStatus和errorThrown只有其中一个包含信息
this; //调用本次ajax请求时传递的options参数
} - contentType:
String
类型的参数,当发送信息至服务器时,内容编码类型默认为"application/x-www-form-urlencoded"。
该默认值适合大多数应用场合。 - dataFilter:
Function
类型的参数,给Ajax返回的原始数据进行预处理的函数。
提供data和type两个参数。
data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataType参数。
函数返回的值将由jQuery进一步处理。
function(data, type){
//返回处理后的数据
return data;
} - global:
Boolean
类型的参数,默认为true。表示是否触发全局ajax事件。
设置为false将不会触发全局ajax事件,ajaxStart或ajaxStop可用于控制各种ajax事件。 - ifModified:
Boolean
类型的参数,默认为false。
仅在服务器数据改变时获取新数据。
服务器数据改变判断的依据是Last-Modified头信息。默认值是false,即忽略头信息。 - jsonp:
String
类型的参数,在一个jsonp请求中重写回调函数的名字。
该值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分,
例如{jsonp:‘onJsonPLoad’}会导致将"onJsonPLoad=?"传给服务器。 - username:
String
类型的参数,用于响应HTTP访问认证请求的用户名。 - password:
String
类型的参数,用于响应HTTP访问认证请求的密码。 - processData:
Boolean
类型的参数,默认为true。
默认情况下,发送的数据将被转换为对象(从技术角度来讲并非字符串)以配合默认内容类型"application/x-www-form-urlencoded"。
如果要发送DOM树信息或者其他不希望转换的信息,请设置为false。 - scriptCharset:
String
类型的参数,只有当请求时dataType为"jsonp"或者"script",并且type是GET时才会用于强制修改字符集(charset)。通常在本地和远程的内容编码不同时使用。
代码示例:
// GET请求示例
$.ajax({
type: "GET",
url: "test.json",
data: {username:$("#username").val(), content:$("#content").val()},
dataType: "json",
success: function(data){
console.log(data)
}
});
// POST请求示例
$.ajax({
url : baseURL + "index/helloWorld",
type : 'post',
async : false,
dataType : "json",
data : { parma : {
userId : 57,
userName:"测试这个name",
time : "20191211142355"
}},
success : function (data) {
console.log(data);
},
error : function (XMLHttpRequest, textStatus, errorThrown) {
console.log(XMLHttpRequest);
console.log(textStatus);
console.log(errorThrown);
}
});