$.ajax()方法詳解

轉載至：博客園

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將不會從瀏覽器緩存中加載請求信息。
cache的作用就是第一次請求完畢之後，如果再次去請求，可以直接從緩存裏面讀取而不是再到服務器端讀取。

如果使用jquery，可以使用 cache參數來控制

$.ajax({
url: “test.html”,
cache: false, //或者設置true
success: function(html){
$("#results").append(html);
}
});

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)。通常在本地和遠程的內容編碼不同時使用。

案例代碼：

複製代碼
$(function(){
$(’#send’).click(function(){
KaTeX parse error: Expected '}', got 'EOF' at end of input: …ata: {username:("#username").val(), content:$("#content").val()},
dataType: “json”,
success: function(data){
$(’#resText’).empty(); //清空resText裏面的所有內容
var html = ‘’;
$.each(data, function(commentIndex, comment){
html += ‘

’ + comment[‘username’]
+ ‘:

<p class=“para”’ + comment[‘content’]
+ ‘

’;
});
$(’#resText’).html(html);
}
});
});
});
複製代碼

22.順便說一下$.each()函數:
$.each()函數不同於JQuery對象的each()方法，它是一個全局函數，不操作JQuery對象，而是以一個數組或者對象作爲第1個參數，以一個回調函數作爲第2個參數。回調函數擁有兩個參數：第1個爲對象的成員或數組的索引，第2個爲對應變量或內容。

23 $.post與$.ajax的轉換

/* $.post('${webContext}/basic/dictionary/getByCode.json', {code: 'agreement'}, function (data) {
        var list = data.data.list;
        for (var i = 0; i < list.length; i++) {
            $("#agreement").append("<option value='" + list[i].name + "'>" + list[i].name + "</option>");
        }
        form.render();
    }); *///這裏爲了實現異步把$.post()轉換成$.ajax()的形式
$.ajax({
	   type: "POST",
	   url: '${webContext}/basic/dictionary/getByCode.json',
	   data: {code: 'agreement'},
	   async : false,
	   success: function (data) {
	        var list = data.data.list;
	        for (var i = 0; i < list.length; i++) {
	            $("#agreement").append("<option value='" + list[i].name + "'>" + list[i].name + "</option>");
	        }
	        form.render();
	    }
	});