jQuery.ajaxSetup()函數用於設置AJAX的全局默認設置。
該函數用於更改jQuery中AJAX請求的默認設置選項。之后執行的所有AJAX請求,如果對應的選項參數沒有設置,將使用更改后的默認設置。
該函數屬於全局jQuery對象。
語法
jQuery 1.1 新增該靜態函數。
jQuery.ajaxSetup( settings )
參數
| 參數 | 描述 |
|---|---|
| settings | Object類型一個對象,其中的每個屬性表示需要更改默認設置的選項,屬性值表示更改后的默認值。 |
關於settings參數可以識別的屬性,請參考jQuery.ajax()中的settings參數說明。其中的所有選項參數都是可選設置的。
下面的表格中列出了可能的名稱/值:
| 名稱 | 值/描述 |
|---|---|
| async | 布爾值,表示請求是否異步處理。默認是 true。 |
| beforeSend(xhr) | 發送請求前運行的函數。 |
| cache | 布爾值,表示瀏覽器是否緩存被請求頁面。默認是 true。 |
| complete(xhr,status) | 請求完成時運行的函數(在請求成功或失敗之后均調用,即在 success 和 error 函數之后)。 |
| contentType | 發送數據到服務器時所使用的內容類型。默認是:"application/x-www-form-urlencoded"。 |
| context | 為所有 AJAX 相關的回調函數規定 "this" 值。 |
| data | 規定要發送到服務器的數據。 |
| dataFilter(data,type) | 用於處理 XMLHttpRequest 原始響應數據的函數。 |
| dataType | 預期的服務器響應的數據類型。 |
| error(xhr,status,error) | 如果請求失敗要運行的函數。 |
| global | 布爾值,規定是否為請求觸發全局 AJAX 事件處理程序。默認是 true。 |
| ifModified | 布爾值,規定是否僅在最后一次請求以來響應發生改變時才請求成功。默認是 false。 |
| jsonp | 在一個 jsonp 中重寫回調函數的字符串。 |
| jsonpCallback | 在一個 jsonp 中規定回調函數的名稱。 |
| password | 規定在 HTTP 訪問認證請求中使用的密碼。 |
| processData | 布爾值,規定通過請求發送的數據是否轉換為查詢字符串。默認是 true。 |
| scriptCharset | 規定請求的字符集。 |
| success(result,status,xhr) | 當請求成功時運行的函數。 |
| timeout | 設置本地的請求超時時間(以毫秒計)。 |
| traditional | 布爾值,規定是否使用參數序列化的傳統樣式。 |
| type | 規定請求的類型(GET 或 POST)。 |
| url | 規定發送請求的 URL。默認是當前頁面。 |
| username | 規定在 HTTP 訪問認證請求中使用的用戶名。 |
| xhr | 用於創建 XMLHttpRequest 對象的函數。 |
返回值
jQuery.ajaxSetup()函數沒有返回值,或者說其返回值為undefined。
示例&說明
//設置AJAX的全局默認選項
$.ajaxSetup( {
url: "/index.html" , // 默認URL
aysnc: false , // 默認同步加載
type: "POST" , // 默認使用POST方式
headers: { // 默認添加請求頭
"Author": "CodePlayer" ,
"Powered-By": "CodePlayer"
} ,
error: function(jqXHR, textStatus, errorMsg){ // 出錯時默認的處理函數
// jqXHR 是經過jQuery封裝的XMLHttpRequest對象
// textStatus 可能為: null、"timeout"、"error"、"abort"或"parsererror"
// errorMsg 可能為: "Not Found"、"Internal Server Error"等
// 提示形如:發送AJAX請求到"/index.html"時出錯[404]:Not Found
alert( '發送AJAX請求到"' + this.url + '"時出錯[' + jqXHR.status + ']:' + errorMsg );
}
} );
$.ajax( {
url: "myurl.php?action=list" ,
type: "GET" ,
success: function( data, textStatus, jqXHR ){
alert("返回數據:" + data);
} ,
error: function(jqXHR, textStatus, errorMsg){
alert("自己的error!");
}
});
