一般在前端html和服務器交互,又要異步提交表單時,我們通常會用到$.ajax(){}函數,這是封裝到ajax里的一個函數,相比於XMLHTTPRequest做頁面局部刷新更方便,但最終還是使用的XMLHTTPRequest,下面記錄下$.ajax()函數,以備日后回顧。
$.ajax(){}函數格式如下:
$.ajax({
url: "test.aspx?r=" + Math.random(),
type: "GET",
data: {},
dataType: "json",
async: false,
success: function (result) {
var coin = result["coin"];
var stage = result["stage"];
document.write("金幣:" + coin + "個,身份:" + stage);
}
});
參數具體意思:
url:請求的服務器地址,默認是當前頁面,數據類型是String
type:請求的方式,有POST和GET兩種,默認是GET,數據類型是String
data:發送到服務器的數據,數據類型是Object或者String,大括號里的對象必須為key/value格式,比如:data:{boy:"LiLei",girl:"HanMeimei",boyage:18,girlage:16}
dataType:預期服務器返回的數據類型,數據類型是String,參數值有:
xml:返回XML文檔,可用JQuery處理。
html:返回純文本HTML信息;包含的script標簽會在插入DOM時執行。
script:返回純文本JavaScript代碼。不會自動緩存結果。除非設置了cache參數。注意在遠程請求時(不在同一個域下),所有post請求都將轉為get請求。
json:返回JSON數據。
jsonp:JSONP格式。使用SONP形式調用函數時,例如myurl?callback=?,JQuery將自動替換后一個“?”為正確的函數名,以執行回調函數。
text:返回純文本字符串。
async:所有請求是同步還是異步,當值是true時是異步請求,為false時是同步請求。同步請求會鎖住瀏覽器,即進入頁面假死狀態,用戶其他操作必須等待請求完成才可以執行,請求完成以后頁面假死狀態解除。我們看一個例子:
$.ajax({
url: "test.aspx?r=" + Math.random(),
type: "GET",
data: {},
dataType: "json",
async: true,
success: function (result) {
function1();
function2();
}
});
function1(){alert("function1");}
function2(){alert("function2");}
在上例中,當ajax塊發出請求后,他將停留function1(),等待server端的返回,但同時(在這個等待過程中),前台會去執行function2(),也就是說,在這個時候出現兩個線程,我們這里暫且說為function1() 和function2()。當把asyn設為false時,這時ajax的請求時同步的,也就是說,這個時候ajax塊發出請求后,他會等待在function1()這個地方,不會去執行function2(),直到function1()部分執行完畢。
success:請求成功后調用的回調函數。這里必須是Function類型的參數,它有兩個參數:
(1)由服務器返回,並根據dataType參數進行處理后的數據。
(2)描述狀態的字符串。
function(data, textStatus){
//data可能是xmlDoc、jsonObj、html、text等等
this; //調用本次ajax請求時傳遞的options參數
}
常用的參數就是上面的幾個,還有其它參數,如下
timeout:請求超時時間,以毫秒為單位,數據類型是Number
cache:是否從瀏覽器緩存中加載請求信息,默認為true,即從緩存中加載請求信息。
error:Function類型的參數,請求失敗時被調用的函數。該函數有3個參數,即XMLHttpRequest對象、錯誤信息、捕獲的錯誤對象(可選)。ajax事件函數如下:
function(XMLHttpRequest, textStatus, errorThrown){
//通常情況下textStatus和errorThrown只有其中一個包含信息
this; //調用本次ajax請求時傳遞的options參數
}
jsonp:數據類型是String,在一個jsonp請求中重寫回調函數的名字。該值用來替代在"callback=?"這種GET或POST請求中URL參數里的"callback"部分,例如{jsonp:'onJsonPLoad'}會導致將"onJsonPLoad=?"傳給服務器。
beforeSend:Function類型的參數,發送請求前可以修改XMLHttpRequest對象的函數,例如添加自定義HTTP頭。在beforeSend中如果返回false可以取消本次ajax請求。XMLHttpRequest對象是惟一的參數。
function(XMLHttpRequest){
this; //調用本次ajax請求時傳遞的options參數
}
complete:Function類型的參數,請求完成后調用的回調函數(請求成功或失敗時均調用)。參數:XMLHttpRequest對象和一個描述成功請求類型的字符串。
function(XMLHttpRequest, textStatus){
this; //調用本次ajax請求時傳遞的options參數
}
contentType:String類型的參數,當發送信息至服務器時,內容編碼類型默認為"application/x-www-form-urlencoded"。該默認值適合大多數應用場合。
dataFilter:Function類型的參數,給Ajax返回的原始數據進行預處理的函數。提供data和type兩個參數。data是Ajax返回的原始數據,type是調用jQuery.ajax時提供的dataType參數。函數返回的值將由jQuery進一步處理。
function(data, type){
//返回處理后的數據
return data;
}
dataFilter:Function類型的參數,給Ajax返回的原始數據進行預處理的函數。提供data和type兩個參數。data是Ajax返回的原始數據,type是調用jQuery.ajax時提供的dataType參數。函數返回的值將由jQuery進一步處理。
function(data, type){
//返回處理后的數據
return data;
}
global:Boolean類型的參數,默認為true。表示是否觸發全局ajax事件。設置為false將不會觸發全局ajax事件,ajaxStart或ajaxStop可用於控制各種ajax事件。
ifModified:Boolean類型的參數,默認為false。僅在服務器數據改變時獲取新數據。服務器數據改變判斷的依據是Last-Modified頭信息。默認值是false,即忽略頭信息。
username:String類型的參數,用於響應HTTP訪問認證請求的用戶名。
password:String類型的參數,用於響應HTTP訪問認證請求的密碼。
processData:Boolean類型的參數,默認為true。默認情況下,發送的數據將被轉換為對象(從技術角度來講並非字符串)以配合默認內容類型"application/x-www-form-urlencoded"。如果要發送DOM樹信息或者其他不希望轉換的信息,請設置為false。
scriptCharset:String類型的參數,只有當請求時dataType為"jsonp"或者"script",並且type是GET時才會用於強制修改字符集(charset)。通常在本地和遠程的內容編碼不同時使用。
跨域訪問:
$.ajax({
url:'', //url地址
type:'GET', //jsonp 類型下只能使用GET,不能用POST,這里不寫默認為GET
dataType:'jsonp', //指定為jsonp類型
data:{}, //數據參數
jsonp:'callback', //服務器端獲取回調函數名的key;callback是默認值
jsonpCallback:'jsonpName', //回調函數名
success:function(result){ //成功執行處理,對應后台返回的jsonpName(data)方法
},
error:function(XMLHttpRequest, textStatus, errorThrown){
//通常情況下textStatus和errorThrown只有其中一個包含信息
}
});
