文章目錄
jQuery ajax的使用樣本
jQuery確實是一個挺好的輕量級的JS架構,能協助我們快速的開發JS應用,並在一定程度上改變了我們寫JavaScript代碼的習慣。
廢話少說,直接進入正題,我們先來看一些簡單的方法,這些方法都是對jQuery.ajax()進行封裝以方便我們使用的方法,當然,如果要處理複雜的邏輯,還是需要用到jQuery.ajax()的(這個後面會說到).
1. load( url, [data], [callback] ) :載入遠程 HTML 檔案代碼並插入至 DOM 中。
定義和用法
load() 方法通過 AJAX 請求從伺服器載入資料,並把返回的資料放置到指定的元素中。
注釋:還存在一個名為
load 的 jQuery
事件方法。調用哪個,取決於參數。
文法
load(url,data,function(response,status,xhr))
參數 |
描述 |
url |
規定要將請求發送到哪個 URL。 |
data |
可選。規定連同請求發送到伺服器的資料。 |
function(response,status,xhr) |
可選。規定當請求完成時啟動並執行函數。 額外的參數:
- response - 包含來自請求的結果資料
- status - 包含請求的狀態("success", "notmodified", "error", "timeout" 或 "parsererror")
- xhr - 包含 XMLHttpRequest 對象
|
使用 AJAX 請求來改變 div 元素的文本:
$("button").click(function(){ $("div").load('demo_ajax_load.txt');});
載入頁面片段
.load() 方法,與 $.get() 不同,允許我們規定要插入的遠程文檔的某個部分。這一點是通過 url 參數的特殊文法實現的。如果該字串中包含一個或多個空格,緊接第一個空格的字串則是決定所載入內容的 jQuery 選取器。
我們可以修改上面的例子,這樣就可以使用所獲得文檔的某部分:
$("#result").load("ajax/test.html #container");
如果執行該方法,則會取回 ajax/test.html 的內容,不過然後,jQuery 會解析被返回的文檔,來尋找帶有容器 ID 的元素。該元素,連同其內容,會被插入帶有結果 ID 的元素中,所取迴文檔的其餘部分會被丟棄。
jQuery 使用瀏覽器的 .innerHTML 屬性來解析被取回的文檔,並把它插入當前文檔。在此過程中,瀏覽器常會從文檔中過濾掉元素,比如 <html>, <title> 或 <head> 元素。結果是,由 .load() 取回的元素可能與由瀏覽器直接取回的文檔不完全相同。
注釋:由於瀏覽器安全方面的限制,大多數 "Ajax" 請求遵守同源策略;請求無法從不同的域、子域或協議成功地取回資料。
註:不知道為什麼URL寫絕對路徑在FF下會出錯,知道的麻煩告訴下。下面的get()和post()樣本使用的是絕對路徑,所以在FF下你將會出錯並不會看到返回結果。還有get()和post()樣本都是跨域調用的,發現傳上來後沒辦法擷取結果,所以把運行按鈕去掉了。
2. jQuery.get( url, [data], [callback] ):使用GET方式來進行非同步請求
定義和用法
get() 方法通過遠程 HTTP GET 請求載入資訊。
這是一個簡單的 GET 請求功能以取代複雜 $.ajax 。請求成功時可調用回呼函數。如果需要在出錯時執行函數,請使用 $.ajax。
文法
$(selector).get(url,data,success(response,status,xhr),dataType)
參數 |
描述 |
url |
必需。規定將請求發送的哪個 URL。 |
data |
可選。規定連同請求發送到伺服器的資料。 |
success(response,status,xhr) |
可選。規定當請求成功時啟動並執行函數。 額外的參數:
- response - 包含來自請求的結果資料
- status - 包含請求的狀態
- xhr - 包含 XMLHttpRequest 對象
|
dataType |
可選。規定預計的伺服器響應的資料類型。 預設地,jQuery 將智能判斷。 可能的類型:
- "xml"
- "html"
- "text"
- "script"
- "json"
- "jsonp"
|
使用 AJAX 的 GET 請求來改變 div 元素的文本:
$("button").click(function(){ $.get("demo_ajax_load.txt", function(result){ $("div").html(result); });});
顯示 test.cgi 傳回值(HTML 或 XML,取決於傳回值),添加一組請求參數:
$.get("test.cgi", { name: "John", time: "2pm" }, function(data){ alert("Data Loaded: " + data); });
點擊發送請求:
jQuery.get()回呼函數裡面的 this ,指向的是Ajax請求的選項配置資訊:
3. jQuery.post( url, [data], [callback], [type] ) :使用POST方式來進行非同步請求
定義和用法
post() 方法通過 HTTP POST 請求從伺服器載入資料。
文法
jQuery.post(url,data,success(data, textStatus, jqXHR),dataType)
參數 |
描述 |
url |
必需。規定把請求發送到哪個 URL。 |
data |
可選。映射或字串值。規定連同請求發送到伺服器的資料。 |
success(data, textStatus, jqXHR) |
可選。請求成功時執行的回呼函數。 |
dataType |
可選。規定預期的伺服器響應的資料類型。 預設執行智能判斷(xml、json、script 或 html)。 |
獲得 test.php 頁面的內容,並儲存為 XMLHttpResponse 對象,並通過 process() 這個 JavaScript 函數進行處理:
$.post("test.php", { name: "John", time: "2pm" }, function(data){ process(data); }, "xml");
獲得 test.php 頁面返回的 json 格式的內容:
$.post("test.php", { "func": "getNameAndTime" }, function(data){ alert(data.name); // John console.log(data.time); // 2pm }, "json");
這裡設定了請求的格式為"json":
如果你設定了請求的格式為"json",此時你沒有設定Response回來的ContentType 為:Response.ContentType = "application/json"; 那麼你將無法捕捉到返回的資料。
注意一下,alert(data.result); 由於設定了Accept前序為“json”,這裡返回的data就是一個對象,並不需要用eval()來轉換為對象。
4. jQuery.getScript( url, [callback] ) : 通過 GET 方式請求載入並執行一個 JavaScript 檔案。
定義和用法
getScript() 方法通過 HTTP GET 請求載入並執行 JavaScript 檔案。
文法
jQuery.getScript(url,success(response,status))
參數 |
描述 |
url |
將要請求的 URL 字串。 |
success(response,status) |
可選。規定請求成功後執行的回呼函數。 額外的參數:
- response - 包含來自請求的結果資料
- status - 包含請求的狀態("success", "notmodified", "error", "timeout" 或 "parsererror")
|
載入並執行 test.js ,成功後顯示資訊:
$.getScript
("test.js", function(){ alert("Script loaded and executed.");});
jQuery Ajax 事件
Ajax請求會產生若干不同的事件,我們可以訂閱這些事件並在其中處理我們的邏輯。在jQuery這裡有兩種Ajax事件:局部事件 和 全域事件。
局部事件就是在每次的Ajax請求時在方法內定義的,例如:
$.ajax({
beforeSend: function(){
// Handle the beforeSend event
},
complete: function(){
// Handle the complete event
}
// ...
});
全域事件是每次的Ajax請求都會觸發的,它會向DOM中的所有元素廣播,在上面 getScript() 樣本中載入的指令碼就是全域Ajax事件。全域事件可以如下定義:
$("#loading").bind("ajaxSend", function(){
$(this).show();
}).bind("ajaxComplete", function(){
$(this).hide();
});
或者:
$("#loading").ajaxStart(function(){
$(this).show();
});
我們可以在特定的請求將全域事件禁用,只要設定下 global 選項就可以了:
$.ajax({
url: "test.html",
global: false,// 禁用全域Ajax事件.
// ...
});
下面是jQuery官方給出的完整的Ajax事件列表:
· ajaxStart (Global Event)
This event is broadcast if an Ajax request is started and no other Ajax requests are currently running.
· beforeSend (Local Event)
This event, which is triggered before an Ajax request is started, allows you to modify the XMLHttpRequest object (setting additional headers, if need be.)
· ajaxSend (Global Event)
This global event is also triggered before the request is run.
· success (Local Event)
This event is only called if the request was successful (no errors from the server, no errors with the data).
· ajaxSuccess (Global Event)
This event is also only called if the request was successful.
· error (Local Event)
This event is only called if an error occurred with the request (you can never have both an error and a success callback with a request).
· ajaxError (Global Event)
This global event behaves the same as the local error event.
· complete (Local Event)
This event is called regardless of if the request was successful, or not. You will always receive a complete callback, even for synchronous requests.
· ajaxComplete (Global Event)
This event behaves the same as the complete event and will be triggered every time an Ajax request finishes.
· ajaxStop (Global Event)
This global event is triggered if there are no more Ajax requests being processed.
具體的全域事件請參考API文檔。
好了,下面開始說jQuery裡面功能最強的Ajax要求方法 $.ajax();
jQuery.ajax( options ) : 通過 HTTP 要求載入遠端資料
這個是jQuery 的底層 AJAX 實現。簡單易用的高層實現見 $.get, $.post 等。
$.ajax() 返回其建立的 XMLHttpRequest 對象。大多數情況下你無需直接操作該對象,但特殊情況下可用於手動終止請求。
注意: 如果你指定了 dataType 選項,請確保伺服器返回正確的 MIME 資訊,(如 xml 返回 "text/xml")。錯誤的 MIME 類型可能導致不可預知的錯誤。見Specifying the Data Type for AJAX Requests 。
當設定 datatype 類型為 'script' 的時候,所有的遠程(不在同一個域中)POST請求都迴轉換為GET方式。
$.ajax() 只有一個參數:參數 key/value 對象,包含各配置及回呼函數資訊。詳細參數選項見下。
jQuery 1.2 中,您可以跨域載入 JSON 資料,使用時需將資料類型設定為
JSONP。使用
JSONP 形式調用函數時,如 "myurl?callback=?" jQuery 將自動替換 ? 為正確的函數名,以執行回呼函數。資料類型設定為 "jsonp" 時,jQuery 將自動調用回呼函數。(這個我不是很懂)
參數列表:
參數名 |
類型 |
描述 |
url |
String |
(預設: 當前頁地址) 發送請求的地址。 |
type |
String |
(預設: "GET") 請求方式 ("POST" 或 "GET"), 預設為 "GET"。注意:其它 HTTP 要求方法,如 PUT 和 DELETE 也可以使用,但僅部分瀏覽器支援。 |
timeout |
Number |
佈建要求逾時時間(毫秒)。此設定將覆蓋全域設定。 |
async |
Boolean |
(預設: true) 預設設定下,所有請求均為非同步請求。如果需要發送同步請求,請將此選項設定為 false。注意,同步請求將鎖住瀏覽器,使用者其它操作必須等待請求完成才可以執行。 |
beforeSend |
Function |
發送請求前可修改 XMLHttpRequest 對象的函數,如添加自訂 HTTP 頭。XMLHttpRequest 對象是唯一的參數。 function (XMLHttpRequest) { this; // the options for this ajax request } |
cache |
Boolean |
(預設: true) jQuery 1.2 新功能,設定為 false 將不會從瀏覽器緩衝中載入請求資訊。 |
complete |
Function |
請求完成後回呼函數 (請求成功或失敗時均調用)。參數: XMLHttpRequest 對象,成功資訊字串。 function (XMLHttpRequest, textStatus) { this; // the options for this ajax request } |
contentType |
String |
(預設: "application/x-www-form-urlencoded") 發送資訊至伺服器時內容編碼類別型。預設值適合大多數應用場合。 |
data |
Object, String |
發送到伺服器的資料。將自動轉換為請求字串格式。GET 請求中將附加在 URL 後。查看 processData 選項說明以禁止此自動轉換。必須為 Key/Value 格式。如果為數組,jQuery 將自動為不同值對應同一個名稱。如 {foo:["bar1", "bar2"]} 轉換為 '&foo=bar1&foo=bar2'。 |
dataType |
String |
預期伺服器返回的資料類型。如果不指定,jQuery 將自動根據 HTTP 包 MIME 資訊返回 responseXML 或 responseText,並作為回呼函數參數傳遞,可用值: "xml": 返回 XML 文檔,可用 jQuery 處理。 "html": 返回純文字 HTML 資訊;包含 script 元素。 "script": 返回純文字 JavaScript 代碼。不會自動緩衝結果。 "json": 返回 JSON 資料 。 "jsonp": JSONP 格式。使用 JSONP 形式調用函數時,如 "myurl?callback=?" jQuery 將自動替換 ? 為正確的函數名,以執行回呼函數。 |
error |
Function |
(預設: 自動判斷 (xml 或 html)) 請求失敗時將調用此方法。這個方法有三個參數:XMLHttpRequest 對象,錯誤資訊,(可能)捕獲的錯誤對象。 function (XMLHttpRequest, textStatus, errorThrown) { // 通常情況下textStatus和errorThown只有其中一個有值 this; // the options for this ajax request } |
global |
Boolean |
(預設: true) 是否觸發全域 AJAX 事件。設定為 false 將不會觸發全域 AJAX 事件,如 ajaxStart 或 ajaxStop 。可用於控制不同的Ajax事件 |
ifModified |
Boolean |
(預設: false) 僅在伺服器資料改變時擷取新資料。使用 HTTP 包 Last-Modified 頭資訊判斷。 |
processData |
Boolean |
(預設: true) 預設情況下,發送的資料將被轉換為對象(技術上講並非字串) 以配合預設內容類型 "application/x-www-form-urlencoded"。如果要發送 DOM 樹資訊或其它不希望轉換的資訊,請設定為 false。 |
success |
Function |
請求成功後回呼函數。這個方法有兩個參數:伺服器返回資料,返回狀態 function (data, textStatus) { // data could be xmlDoc, jsonObj, html, text, etc... this; // the options for this ajax request } |
這裡有幾個Ajax事件參數:beforeSend ,success
,complete ,error 。我們可以定義這些事件來很好的處理我們的每一次的Ajax請求。注意一下,這些Ajax事件裡面的 this 都是指向Ajax請求的選項資訊的(請參考說 get() 方法時的this的圖片)。
請認真閱讀上面的參數列表,如果你要用jQuery來進行Ajax開發,那麼這些參數你都必需熟知的。
範例程式碼,擷取部落格園首頁的文章題目:
$.ajax({
type: "get",
url: "http://www.cnblogs.com/rss",
beforeSend: function(XMLHttpRequest){
//ShowLoading();
},
success: function(data, textStatus){
$(".ajax.ajaxResult").html("");
$("item",data).each(function(i, domEle){
$(".ajax.ajaxResult").append("<li>"+$(domEle).children("title").text()+"</li>");
});
},
complete: function(XMLHttpRequest, textStatus){
//HideLoading();
},
error: function(){
//請求出錯處理
}
});
· 其他
jQuery.ajaxSetup( options ) : 設定全域 AJAX 預設選項。
設定 AJAX 請求預設地址為 "/xmlhttp/",禁止觸發全域 AJAX 事件,用 POST 代替預設 GET 方法。其後的 AJAX 請求不再設定任何選項參數。
jQuery 代碼:
$.ajaxSetup({
url: "/xmlhttp/",
global: false,
type: "POST"
});
$.ajax({ data: myData });
serialize() 與 serializeArray()
serialize() : 序列表表格內容為字串。
serializeArray() : 序列化表格元素 (類似 '.serialize()' 方法) 返回 JSON 資料結構資料。
樣本:
HTML代碼:
<p id="results"><b>Results: </b> </p>
<form>
<select name="single">
<option>Single</option>
<option>Single2</option>
</select>
<select name="multiple" multiple="multiple">
<option selected="selected">Multiple</option>
<option>Multiple2</option>
<option selected="selected">Multiple3</option>
</select><br/>
<input type="checkbox" name="check" value="check1"/> check1
<input type="checkbox" name="check" value="check2"
checked="checked"/> check2
<input type="radio" name="radio" value="radio1"
checked="checked"/> radio1
<input type="radio" name="radio" value="radio2"/> radio2
</form>
更詳細的資訊請參考:
http://www.w3school.com.cn/jquery/jquery_ref_ajax.asp