Ajax各參數介紹及使用
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)。通常在本地和遠程的內容編碼不同時使用。
$.ajax({
url: "",//要請求的伺服器url
//這是一個對象,表示請求的參數,兩個參數:method=ajax&val=xxx,伺服器可以通過request.getParameter()來獲取
//data:{method:"ajaxTest",val:value},
data: {
name: $("#name").val(),
studentId: $("#studentId").val(),
},
async: true, //是否為非同步請求
cache: false, //是否快取結果
type: "POST", //請求方式為POST
dataType: "json", //伺服器返回的數據是什麼類型
success: function(result){ //這個方法會在伺服器執行成功是被調用 ,參數result就是伺服器返回的值(現在是json類型)
if(result){
alert("true");
}else{
alert("false");
}
}
//例子
$.ajax({
url: "//localhost:8081/updateMsg",
type: "POST", //請求方式為POST
data: JSON.stringify(param),
dataType : 'json',
headers: {
"content-type": "application/json" // 默認值
},
contentType: "application/x-www-form-urlencoded; charset=utf-8",
async: true, //是否為非同步請求
cache: false, //是否快取結果
success: function (result) {
}
});