DIV CSS 佈局教程網

jQuery Ajax 請求方法整理(值得收藏)
編輯:AJAX基礎知識     

jQuery 確實是一個相當優秀的輕量級 JS 框架,能幫助我們快速開發 JS 應用,並在一定程度上改變了我們撰寫 JavaScript 程式碼的習慣。

廢話少說,直接進入正題。先看一些簡單的方法,它們都是對 jQuery.ajax() 進行封裝以便使用的方法;當然,若要處理複雜邏輯,仍需使用 jQuery.ajax()(後面會談到)。

1. load( url, [data], [callback] ):載入遠端 HTML 文件程式碼並插入至 DOM 中。

url(String):請求的 HTML 頁的 URL 位址。

data(Map):(可選參數)發送至伺服器的 key/value 資料。

callback(Callback):(可選參數)請求完成時(不需是 success 的)的回呼函式。

這個方法預設使用 GET 方式傳遞,若有傳入 [data] 參數,則會自動轉換為 POST 方式。jQuery 1.2 中,可以指定選擇器來篩選載入的 HTML 文件,DOM 中將僅插入篩選出的 HTML 程式碼,語法形如 "url #some > selector"。這個方法可以很方便地動態載入一些 HTML 文件,例如表單。

示例程式碼:

$(".ajax.load").load("https://www.cnblogs.com/QLeelulu/archive/2008/03/30/1130270.html .post", function (responseText, textStatus, XMLHttpRequest) {
    this; // 在此處 this 指向的是當前的 DOM 物件,即 $(".ajax.load")[0]
    // alert(responseText); // 請求返回的內容
    // alert(textStatus); // 請求狀態:success,error
    // alert(XMLHttpRequest); // XMLHttpRequest 物件
});

 

注:不知為何 URL 寫絕對路徑在 Firefox 下會出錯。下面的 get() 和 post() 示例使用的是絕對路徑,所以在 Firefox 下將會出錯並看不到返回結果;且 get() 和 post() 示例都是跨域呼叫,發現傳上來後沒辦法取得結果,所以把運行按鈕去掉了。

2. jQuery.get( url, [data], [callback] ):使用 GET 方式進行非同步請求

參數:

url(String):發送請求的 URL 位址。

data(Map):(可選)要發送給伺服器的資料,以 Key/value 的鍵值對形式表示,會作為 QueryString 附加到請求 URL 中。

callback(Function):(可選)載入成功時回呼函式(只有當 Response 的返回狀態是 success 才會呼叫該方法)。

這是一個簡單的 GET 請求功能,以取代複雜的 $.ajax。請求成功時可呼叫回呼函式;若需在出錯時執行函式,請使用 $.ajax。

示例程式碼:

$.get("./Ajax.aspx", { Action: "get", Name: "lulu" }, function (data, textStatus) {
    // 返回的 data 可以是 xmlDoc, jsonObj, html, text 等等
    this; // 在此處 this 指向的是 Ajax 請求的選項配置資訊
    alert(data);
    // alert(textStatus); // 請求狀態:success,error 等等(此處捕捉不到 error)
});

jQuery.get() 回呼函式裡面的 this,指向的是 Ajax 請求的選項配置資訊:

 

3. jQuery.post( url, [data], [callback], [type] ):使用 POST 方式進行非同步請求

參數:

url(String):發送請求的 URL 位址。

data(Map):(可選)要發送給伺服器的資料,以 Key/value 的鍵值對形式表示。

callback(Function):(可選)載入成功時回呼函式(只有當 Response 的返回狀態是 success 才會呼叫該方法)。

type(String):(可選)客戶端請求的型別(JSON、XML 等等)。

這是一個簡單的 POST 請求功能,以取代複雜的 $.ajax。請求成功時可呼叫回呼函式;若需在出錯時執行函式,請使用 $.ajax。

示例程式碼:

Ajax.aspx:

Response.ContentType = "application/json";
Response.Write("{result: ''" + Request["Name"] + ",你好!(這消息來自伺服器)''}");

jQuery 程式碼:

$.post("Ajax.aspx", { Action: "post", Name: "lulu" }, function (data, textStatus) {
    // data 可以是 xmlDoc, jsonObj, html, text 等等
    // this; // 這個 Ajax 請求的選項配置資訊
    alert(data.result);
}, "json");

這裡設定了請求的格式為 "json":

 

如果你設定了請求的格式為 "json",此時卻沒有設定 Response 回來的 ContentType 為 Response.ContentType = "application/json"; 那麼你將無法捕捉到返回的資料。另外,alert(data.result); 由於設定了 Accept 報頭為「json」,這裡返回的 data 就是一個物件,並不需要用 eval() 來轉換為物件。

4. jQuery.getScript( url, [callback] ):透過 GET 方式請求載入並執行一個 JavaScript 文件。

參數

url(String):待載入 JS 文件位址。

callback(Function):(可選)成功載入後回呼函式。

jQuery 1.2 版本之前,getScript 只能呼叫同域 JS 文件;1.2 中,您可以跨域呼叫 JavaScript 文件。注意:Safari 2 或更早的版本不能在全域作用域中同步執行腳本,若透過 getScript 加入腳本,請加入延時函式。這個方法可用於例如當編輯器 focus() 時才去載入編輯器需要的 JS 文件。

載入並執行 test.js:

$.getScript("test.js");

載入並執行 AjaxEvent.js,成功後顯示資訊:

$.getScript("AjaxEvent.js", function () {
    alert("AjaxEvent.js 載入完成並執行完成。你再點擊上面的 Get 或 Post 按鈕看看有什麼不同?");
});

jQuery Ajax 事件

Ajax 請求會產生若干不同的事件,我們可以訂閱這些事件並在其中處理邏輯。jQuery 有兩種 Ajax 事件:局部事件和全域事件。

局部事件是在每次 Ajax 請求時在方法內定義的,例如:

$.ajax({
    beforeSend: function () {
        // Handle the beforeSend event
    },
    complete: function () {
        // Handle the complete event
    }
    // ...
});

全域事件是每次 Ajax 請求都會觸發的,它會向 DOM 中的所有元素廣播。全域事件可以如下定義:

$("#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):如果有 Ajax 請求開始且沒有其他 Ajax 請求正在運行,則廣播此事件。

beforeSend(Local Event):在 Ajax 請求開始前觸發,允許修改 XMLHttpRequest 物件(如設定額外的標頭)。

ajaxSend(Global Event):在請求運行前觸發的這個全域事件。

success(Local Event):只有請求成功(無伺服器錯誤、無資料錯誤)時才會呼叫。

ajaxSuccess(Global Event):也只有請求成功時才會呼叫。

error(Local Event):只有請求發生錯誤時才會呼叫(一次請求不會同時有 error 和 success 回呼)。

ajaxError(Global Event):行為與局部 error 事件相同。

complete(Local Event):無論請求成功與否都會呼叫,即使是同步請求也會收到 complete 回呼。

ajaxComplete(Global Event):行為與 complete 事件相同,每次 Ajax 請求完成時都會觸發。

ajaxStop(Global Event):如果沒有更多正在處理的 Ajax 請求,則觸發此全域事件。

好了,下面開始說明 jQuery 裡面功能最強的 Ajax 請求方法 $.ajax()。

jQuery.ajax( options ):透過 HTTP 請求載入遠端資料

這是 jQuery 的底層 AJAX 實作。簡單易用的高層實作見 $.get、$.post 等。

$.ajax() 返回其建立的 XMLHttpRequest 物件。大多數情況下你無需直接操作該物件,但特殊情況下可用於手動終止請求。

注意:如果你指定了 dataType 選項,請確保伺服器返回正確的 MIME 資訊(如 xml 返回 "text/xml"),錯誤的 MIME 型別可能導致不可預知的錯誤。

當設定 datatype 型別為 'script' 時,所有遠端(不在同一個域中)POST 請求都會回轉換為 GET 方式。

$.ajax() 只有一個參數:參數 key/value 物件,包含各配置及回呼函式資訊。jQuery 1.2 中,您可以跨域載入 JSON 資料,使用時需將資料型別設為 JSONP。資料型別設為 "jsonp" 時,jQuery 會自動呼叫回呼函式。

參數列表:

url(String,預設:當前頁位址)發送請求的位址。

type(String,預設:"GET")請求方式("POST" 或 "GET")。注意:其他 HTTP 請求方法如 PUT 和 DELETE 也可使用,但僅部分瀏覽器支援。

timeout(Number)設定請求逾時時間(毫秒),此設定將覆蓋全域設定。

async(Boolean,預設:true)預設所有請求皆為非同步請求;若需發送同步請求,請設為 false。注意同步請求將鎖住瀏覽器。

beforeSend(Function)發送請求前可修改 XMLHttpRequest 物件的函式,如添加自訂 HTTP 標頭,XMLHttpRequest 物件是唯一參數。

cache(Boolean,預設:true)設為 false 將不會從瀏覽器緩存中載入請求資訊。

complete(Function)請求完成後回呼函式(請求成功或失敗時皆呼叫),參數:XMLHttpRequest 物件、成功資訊字串。

contentType(String,預設:"application/x-www-form-urlencoded")發送資訊至伺服器時的內容編碼型別,預設值適合大多數應用場合。

data(Object 或 String)發送到伺服器的資料,將自動轉換為請求字串格式,GET 請求中將附加在 URL 後。必須為 Key/Value 格式;若為陣列,jQuery 會自動為不同值對應同一個名稱,如 {foo:["bar1","bar2"]} 轉換為 '&foo=bar1&foo=bar2'。

dataType(String)預期伺服器返回的資料型別。若不指定,jQuery 會自動根據 HTTP 包 MIME 資訊返回 responseXML 或 responseText。可用值:xml(返回 XML 文件)、html(返回純文字 HTML)、script(返回純文字 JavaScript 程式碼,不會自動緩存結果)、json(返回 JSON 資料)、jsonp(JSONP 格式,如 "myurl?callback=?" jQuery 會自動替換 ? 為正確的函數名)。

error(Function)請求失敗時呼叫,有三個參數:XMLHttpRequest 物件、錯誤資訊、捕獲的錯誤物件(通常 textStatus 和 errorThrown 只有其中一個有值)。

global(Boolean,預設:true)是否觸發全域 AJAX 事件,設為 false 將不觸發全域 AJAX 事件,如 ajaxStart 或 ajaxStop。

ifModified(Boolean,預設:false)僅在伺服器資料改變時取得新資料,使用 HTTP 包 Last-Modified 標頭判斷。

processData(Boolean,預設:true)預設會將發送的資料轉換為物件以配合預設內容型別 "application/x-www-form-urlencoded";若要發送 DOM 樹資訊或不希望轉換的資訊,請設為 false。

success(Function)請求成功後回呼函式,有兩個參數:伺服器返回資料、返回狀態。

這裡有幾個 Ajax 事件參數:beforeSend、success、complete、error。我們可以定義這些事件來完善處理每一次 Ajax 請求。注意這些 Ajax 事件裡面的 this 都指向 Ajax 請求的選項資訊。

示例程式碼,取得博客園首頁的文章題目:

$.ajax({
    type: "get",
    url: "https://www.cnblogs.com/rss",
    beforeSend: function (XMLHttpRequest) {
        // ShowLoading();
    },
    success: function (data, textStatus) {
        $(".ajax.ajaxResult").html("");
        $("item", data).each(function (i, domEle) {
            $(".ajax.ajaxResult").append(" " + $(domEle).children("title").text() + "");
        });
    },
    complete: function (XMLHttpRequest, textStatus) {
        // HideLoading();
    },
    error: function () {
        // 請求出錯處理
    }
});

其他

jQuery.ajaxSetup( options ):設定全域 AJAX 預設選項。

設定 AJAX 請求預設位址為 "/xmlhttp/",停用觸發全域 AJAX 事件,用 POST 代替預設 GET 方法,其後的 AJAX 請求不再設定任何選項參數。

$.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>

 

serializeArray() 結果為:

最後說明為什麼一般請求可以下載文件,而 Ajax 請求卻不能:那是因為 response 的緣故。一般請求瀏覽器會處理伺服器輸出的 response,例如生成 png、文件下載等;而 Ajax 請求只是個「字元型」的請求,可以讀取到返回的 response,但只是讀取而已,無法執行,說白點就是 JS 無法呼叫到瀏覽器的下載處理機制和程式。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved