ajax()參數settings一個Object對象,其中的每個屬性用來指定傳送請求所需的額外參數設定。
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)。通常在本地和远程的内容编码不同时使用。
22.jsonpCallback
为jsonp请求指定一个回调函数名。jquery会自动生成随机函数名,用这个值可以修改此名。
23. mimetype
jQuery1.5.1添加。可以用来覆盖XHR中的mimetype。
24. statusCode
jQuery1.5添加。用来定义http的返回码对应的处理函数。下面的例子定义了返回404后的处理方法。
$.ajax({ statusCode: { 404: function() { alert("page not found"); } } });
25.success(data,textStatus,jqXHR)
请求成功后的回调函数。参数由服务器返回,并会根据datatype参数进行参数处理。
26.timeout
设置请求超时时间,毫秒为单位。此设置会覆盖全局设置,即所有ajax请求共享同一个超时时间。
27.traditional
设置为true,用传统的方式来序列化数据。
28.type
请求方式,get或post或put或delete。默认为get。put和delte不是得到所有的浏览器支持。
29.url
发送请求的地址。为空表示当前页。
30.username
用于响应http访问认证请求的用户名。同password配对。
31.xhr
默认在ie下是ActiveXObject而其他浏览器是XMLHttpRequest。用于重写或提供一个增强的XMLHttpRequest对象。
32.xhrFields
jQuery1.5.1添加。它可以添加到原生xhr对象上的key/value对。举个例子,你可以通过它来设置跨域的withCredentials为true。
$.ajax({ url: a_cross_domain_url, xhrFields: { withCredentials: true } });
以上是jquery中ajax的各種參數詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章!