jQuery.ajaxSetup()

標籤：

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!");        
    }
});

jQuery.ajaxSetup()