jquery ajax 方法及各參數詳解
1.$.ajax() 只有一個參數:參數key/value 物件,包含各配置及回呼函數資訊。
參數清單:
參數名稱 | #類型 | 描述 |
url | String | (預設: 目前頁位址) 傳送請求的位址。 |
type | String | #(預設: "GET") 請求方式("POST" 或"GET") , 預設為"GET"。注意:其它 HTTP 請求方法,如 PUT 和 DELETE 也可以使用,但僅部分瀏覽器支援。 |
timeout | Number | #設定請求逾時時間(毫秒)。此設定將覆蓋全域設定。 |
async | Boolean | (預設: true) 預設設定下,所有請求均為非同步請求。如果需要傳送同步請求,請將此選項設為 false。注意,同步請求將鎖住瀏覽器,使用者其它操作必須等待請求完成才可以執行。 |
beforeSend | Function | 發送請求前可修改XMLHttpRequest 物件的函數,如新增自訂HTTP 頭。 XMLHttpRequest 物件是唯一的參數。 function (XMLHttpRequest) { this; // the options for this ajax request } |
cache | #Boolean | (預設: true) jQuery 1.2 新功能,設定為false 將不會從瀏覽器快取載入請求資訊。 |
complete | Function | 要求完成後回呼函數 (請求成功或失敗時均呼叫)。參數: XMLHttpRequest 對象,成功訊息字串。 function (XMLHttpRequest, textStatus) { this; // the options for this ajax request } |
contentType | #String |
(預設: "application/x-www-form -urlencoded") 發送訊息至伺服器時內容編碼類型。預設值適合大多數應用程式場合。告訴伺服器從瀏覽器提交過來的資料格式。 例如:我們提交資料時假如使用了 JSON2.js 中方法 JSON.stringify(obj) 格式化為json字串後,再預設提交就會報錯。這個時候就需要指定提交的內容格式為:"application/json"。 |
data |
#Object, String |
傳送到伺服器的數據。 若data資料型別為JavaScript物件或陣列,Jquery在提交之前自動呼叫JQuery.param()方法把要傳送的資料編碼成為"application/x-www-form-urlencoded"格式的資料(即name=value&name1=value1);JavaScript物件必須為Key/Value 格式;如果為數組,jQuery 會自動為不同值對應同一個名稱。如{foo:["bar1", "bar2"]} 轉換為'&foo=bar1&foo=bar2'; 若data資料類型為String類型,則直接預設資料已經依照"application/x- www-form-urlencoded"格式編碼完成,不再轉換。 processData選項可以控制是否進行轉換。該選項預設為true。 |
dataType | String |
预期服务器返回的数据类型。设定HttpHeader中“Accept”域的内容,告诉服务器浏览器可以想要返回的数据格式类型,同时JQuery也会根据该类型对返回的数据进行处理。如果不指定,jQuery 将自动根据 HTTP 包 MIME 信息返回 responseXML 或 responseText,并作为回调函数参数传递,可用值: "xml": 返回 XML 文档,可用 jQuery 处理。 "html": 返回纯文本 HTML 信息;包含 script 元素。 "script": 返回纯文本 JavaScript 代码。不会自动缓存结果。 "json": 返回 JSON 数据 。JQuery将返回的字符串格式数据自动转化为Javascript对象,便于直接使用obj.property格式访问。若没有指定该选项,即使返回的是JSON格式的字符串,JQuery也不会自动转换。 "jsonp": JSONP 格式。使用 JSONP 形式调用函数时,如 "myurl?callback=?" jQuery 将自动替换 ? 为正确的函数名,以执行回调函数。 |
error | Function | (默认: 自动判断 (xml 或 html)) 请求失败时将调用此方法。这个方法有三个参数:XMLHttpRequest 对象,错误信息,(可能)捕获的错误对象。function (XMLHttpRequest, textStatus, errorThrown) { // 通常情况下textStatus和errorThown只有其中一个有值 this; // the options for this ajax request } |
global | Boolean | (默认: true) 是否触发全局 AJAX 事件。设置为 false 将不会触发全局 AJAX 事件,如 ajaxStart 或 ajaxStop 。可用于控制不同的Ajax事件 |
ifModified | Boolean | (默认: false) 仅在服务器数据改变时获取新数据。使用 HTTP 包 Last-Modified 头信息判断。 |
processData | Boolean | (默认: true) 默认情况下,发送的数据将被转换为对象(技术上讲并非字符串) 以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息,请设置为 false。 |
success | Function | 请求成功后回调函数。这个方法有两个参数:服务器返回数据,返回状态function (data, textStatus) { // data could be xmlDoc, jsonObj, html, text, etc... this; // the options for this ajax request } |
2. jQuery.get(url, [data], [callback], [type]):使用GET方式來進行非同步請求.
參數:
url (String) : 發送請求的URL位址.
data (Map) : (可選) 要傳送給伺服器的數據,以Key/value 的鍵值對形式表示。
callback (Function) : (可選) 載入成功時回呼函數(只有當Response的回傳狀態是success才是呼叫該方法)。
type (String) : (可選)官方的說明是:Type of data to be sent。其實應該為客戶端請求的類型(JSON,XML,等等)
3. jQuery.post( url, [data], [callback], [type] ) :使用POST方式來進行非同步請求
參數:
url (String) : 發送請求的URL位址.
data (Map) : (可選) 要傳送給伺服器的數據,以Key/ value 的鍵值對形式表示。
callback (Function) : (可選) 載入成功時回呼函數(只有當Response的回傳狀態是success才是呼叫該方法)。
type (String) : (可選)官方的說明是:Type of data to be sent。其實應該為客戶端請求的型別(JSON,XML,等等)
1.$.ajax() 只有一個參數:參數 key/value 對象,包含各組態及回呼函數資訊。
參數清單:
參數名稱 | #類型 | 描述 |
url | String | (預設: 目前頁位址) 傳送請求的位址。 |
type | String | #(預設: "GET") 請求方式("POST" 或"GET") , 預設為"GET"。注意:其它 HTTP 請求方法,如 PUT 和 DELETE 也可以使用,但僅部分瀏覽器支援。 |
timeout | Number | #設定請求逾時時間(毫秒)。此設定將覆蓋全域設定。 |
async | Boolean | (預設: true) 預設設定下,所有請求均為非同步請求。如果需要傳送同步請求,請將此選項設為 false。注意,同步請求將鎖住瀏覽器,使用者其它操作必須等待請求完成才可以執行。 |
beforeSend | Function | 可修改 XMLHttpRequest 在傳送請求前物件的函數,例如新增自訂 HTTP 頭。 XMLHttpRequest 物件是唯一的參數。 function (XMLHttpRequest) { this; // the options for this ajax request } |
cache | Boolean | (預設: true) jQuery 1.2 新功能,設定為false 將不會從瀏覽器快取中載入請求資訊。 |
complete | Function | 要求完成後回呼函數 (請求成功或失敗時均呼叫)。參數: XMLHttpRequest 對象,成功資訊字串。 function (XMLHttpRequest, textStatus) { this; // the options for this ajax request } |
contentType | #String |
(預設: "application/x-www-form -urlencoded") 發送訊息至伺服器時內容編碼類型。預設值適合大多數應用程式場合。告訴伺服器從瀏覽器提交過來的資料格式。 例如:我們提交資料時假如使用了 JSON2.js 中方法 JSON.stringify(obj) 格式化為json字串後,再預設提交就會報錯。這個時候就需要指定提交的內容格式為:"application/json"。 |
data | Object, String |
傳送到伺服器的資料。 若data資料型別為JavaScript物件或數組,Jquery在提交前自動呼叫JQuery.param()方法把要傳送的資料編碼變成"application/x-www-form-urlencoded"格式的資料(即name=value&name1=value1);JavaScript物件必須為Key/Value 格式;若為陣列,jQuery 會自動為不同值對應同一個名稱。如{foo:["bar1", "bar2"]} 轉換為'&foo=bar1&foo=bar2'; 若data資料類型為String類型,則直接預設資料已經依照"application/x- www-form-urlencoded"格式編碼完成,不再轉換。 processData選項可以控制是否進行轉換。該選項預設為true。 |
dataType | String |
预期服务器返回的数据类型。设定HttpHeader中“Accept”域的内容,告诉服务器浏览器可以想要返回的数据格式类型,同时JQuery也会根据该类型对返回的数据进行处理。如果不指定,jQuery 将自动根据 HTTP 包 MIME 信息返回 responseXML 或 responseText,并作为回调函数参数传递,可用值: "xml": 返回 XML 文档,可用 jQuery 处理。 "html": 返回纯文本 HTML 信息;包含 script 元素。 "script": 返回纯文本 JavaScript 代码。不会自动缓存结果。 "json": 返回 JSON 数据 。JQuery将返回的字符串格式数据自动转化为Javascript对象,便于直接使用obj.property格式访问。若没有指定该选项,即使返回的是JSON格式的字符串,JQuery也不会自动转换。 "jsonp": JSONP 格式。使用 JSONP 形式调用函数时,如 "myurl?callback=?" jQuery 将自动替换 ? 为正确的函数名,以执行回调函数。 |
error | Function | (默认: 自动判断 (xml 或 html)) 请求失败时将调用此方法。这个方法有三个参数:XMLHttpRequest 对象,错误信息,(可能)捕获的错误对象。function (XMLHttpRequest, textStatus, errorThrown) { // 通常情况下textStatus和errorThown只有其中一个有值 this; // the options for this ajax request } |
global | Boolean | (默认: true) 是否触发全局 AJAX 事件。设置为 false 将不会触发全局 AJAX 事件,如 ajaxStart 或 ajaxStop 。可用于控制不同的Ajax事件 |
ifModified | Boolean | (默认: false) 仅在服务器数据改变时获取新数据。使用 HTTP 包 Last-Modified 头信息判断。 |
processData | Boolean | (默认: true) 默认情况下,发送的数据将被转换为对象(技术上讲并非字符串) 以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息,请设置为 false。 |
success | Function | 请求成功后回调函数。这个方法有两个参数:服务器返回数据,返回状态function (data, textStatus) { // data could be xmlDoc, jsonObj, html, text, etc... this; // the options for this ajax request } |
2. jQuery.get(url, [data], [callback], [type]):使用GET方式来进行异步请求.
参数:
url (String) : 发送请求的URL地址.
data (Map) : (可选) 要发送给服务器的数据,以 Key/value 的键值对形式表示。
callback (Function) : (可选) 载入成功时回调函数(只有当Response的返回状态是success才是调用该方法)。
type (String) : (可选)官方的说明是:Type of data to be sent。其实应该为客户端请求的类型(JSON,XML,等等)
3. jQuery.post( url, [data], [callback], [type] ) :使用POST方式来进行异步请求
参数:
url (String) : 发送请求的URL地址.
data (Map) : (可选) 要发送给服务器的数据,以 Key/value 的键值对形式表示。
callback (Function) : (可选) 载入成功时回调函数(只有当Response的返回状态是success才是调用该方法)。
type (String) : (可选)官方的说明是:Type of data to be sent。其实应该为客户端请求的类型(JSON,XML,等等)
以上是使用jquery ajax方法及各參數詳細介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章!