DIV CSS 佈局教程網

jQuery ajax() 完整指南:從語法到所有設定參數
編輯:JQuery常見問題     

先認識 AJAX

AJAX 是 Asynchronous JavaScript and XML 的縮寫。它不是新的程式語言,而是用既有標準組裝出來的新做法:在不重載整頁的前提下,與伺服器交換資料並更新頁面的局部。jQuery 把這套流程包裝得非常省事。

ajax() 的定位

ajax() 透過 HTTP 請求載入遠端資料,是 jQuery 的底層 AJAX 實作。日常開發多半用更高階的 $.get、$.post 就好;只有需要更細粒度控制時,才直接操作 $.ajax()。它會回傳自己建立的 XMLHttpRequest 物件。

語法:jQuery.ajax([settings]),其中 settings 可選,是設定 Ajax 請求的鍵值對集合。所有選項都能透過 $.ajaxSetup() 設定全域預設值。

一個最小示例

<div><input id="get_keleyi_com" type="button" value="從服務器獲取內容更新下面的內容" /></div>
<div id="ajax_keleyi_com">這是一開始的內容。點擊按鈕後將顯示為ajax從服務器獲取的內容。</div>
<script type="text/javascript">
$("#get_kel" + "eyi_com").bind("click", function () {
  htmlobj = $.ajax({ url: "index/ajax.htm", async: false });
  $("#ajax_k" + "eleyi_com").html(htmlobj.responseText);
})
</script>

示例效果:https:///keleyi/phtml/ajax/index.htm

常用參數速查

  • async(Boolean,預設 true):設為 false 會變成同步請求,會鎖住瀏覽器,不建議使用。
  • beforeSend(XHR)(Function):送出前可修改 XMLHttpRequest,例如加自訂標頭;回傳 false 可取消本次請求。
  • cache(Boolean,預設 true;dataType 為 script、jsonp 時預設 false):設為 false 則不使用快取。
  • complete(XHR, TS)(Function):請求完成後呼叫,不論成功或失敗。
  • contentType(String,預設 "application/x-www-form-urlencoded"):送出資料的編碼類型。
  • context(Object):指定回呼函數中 this 的指向。例如傳入 document.body,success 裡的 $(this) 就指向 body。
  • data(String):要送到伺服器的資料,會自動轉成查詢字串;GET 時附加在 URL 後。若為陣列且名稱相同,jQuery 會自動展開成 &foo=bar1&foo=bar2。
  • dataFilter(Function):對回傳的原始資料做前處理,接收 data 與 type 兩個參數,返回值會再交給 jQuery 處理。
  • error(Function):請求失敗時呼叫,參數為 XHR、錯誤訊息、以及可能的例外物件。錯誤訊息可能是 timeout、error、notmodified 或 parsererror。
  • global(Boolean,預設 true):是否觸發全域 Ajax 事件,如 ajaxStart、ajaxStop。
  • ifModified(Boolean,預設 false):僅在資料有變動時才取新資料,依賴 Last-Modified,jQuery 1.4 起也會檢查 etag。
  • jsonp / jsonpCallback:自訂 JSONP 請求中的回呼參數名稱與回呼函數名。
  • password / username:回應 HTTP 驗證時使用的帳密。
  • processData(Boolean,預設 true):是否把 data 物件轉成查詢字串;要傳 DOM 樹或其他不需轉換的資料時設為 false。
  • scriptCharset:dataType 為 jsonp 或 script 且 method 為 GET 時,強制指定 charset。
  • success(Function):請求成功後呼叫,參數為處理後的資料與狀態字串。
  • traditional(Boolean):使用傳統方式序列化資料。
  • timeout(Number):請求逾時的毫秒數,會覆寫全域設定。
  • type(String,預設 "GET"):請求方式,POST 或 GET;PUT、DELETE 也可,但僅部分瀏覽器支援。
  • url(String,預設當前頁位址):請求位址。
  • xhr(Function):回傳自訂的 XMLHttpRequest 物件,jQuery 1.3 以前不可用。

回呼函數的執行時機

要處理 $.ajax() 的結果,可用的回呼有 beforeSend、error、dataFilter、success、complete,順序大致如下:

  1. beforeSend:送出前,傳入 XMLHttpRequest。
  2. dataFilter:請求成功後、交給 success 之前,可改寫資料,必須回傳新資料。
  3. success:請求完成且成功,傳入資料與成功狀態字串。
  4. error:出錯時呼叫,傳入 XHR、錯誤類型字串與例外物件。
  5. complete:不論成敗最後都會呼叫。

dataType 決定資料怎麼被處理

jQuery 會依伺服器回報的內容來決定如何處理結果,也可以用 dataType 明確指定:

  • "xml":回傳 XML 文件,可用 jQuery 選擇器遍歷。
  • "html":回傳純文字 HTML,內嵌的 script 標籤會在插入 DOM 時執行。
  • "script":回傳 JavaScript 程式碼並執行,預設不快取;跨網域時 POST 會被轉為 GET。
  • "json":回傳 JSON,解析成 JavaScript 物件;優先使用 JSON.parse(),不支援時退回自行建構。
  • "jsonp":以 JSONP 形式呼叫,jQuery 會把 "callback=?" 中的 ? 換成正確的函數名。跨網域取資料時必須用它。
  • "text":回傳純文字字串。

要注意:伺服器回報的 MIME 類型必須與你選的 dataType 相符。例如取 XML 時,伺服器端就該宣告 text/xml 或 application/xml。指定 html 時,內嵌 JavaScript 會在字串返回前執行;指定 json 時,資料會被解析成物件後才交給回呼。若指定 script 或 jsonp,實際上使用的是 <script> 標籤而非 XMLHttpRequest,此時 $.ajax() 不回傳 XHR,也不觸發 beforeSend。

資料怎麼送到伺服器

預設用 GET,可透過 type 改為 POST,這個選項同時影響 data 的傳送方式。data 可以是查詢字串(key1=value1&key2=value2),也可以是對應物件({key1: 'value1', key2: 'value2'}),後者會被轉成查詢字串。若要送出 XML 物件,就該把 processData 設為 false,並把 contentType 改成合適的 MIME 類型。

幾個進階觀念

global 可關閉全域事件回呼,適合請求又頻繁又短暫的場合。timeout 讓請求有期限,錯誤被捕捉後能轉為友善提示;多數情況保留預設或用 $.ajaxSetup 全域設定即可。cache 設為 false 可避免瀏覽器改用快取結果,ifModified 設為 true 則能在資料未變動時主動報錯。scriptCharset 在腳本與頁面編碼不同時特別有用。

最後別忘了:Ajax 的 A 就是 asynchronous,所有請求本質上是並行的,完成順序沒有先後保證。$.ajax() 回傳的 XHR 物件通常被丟棄,但它提供了底層操作入口,例如呼叫 .abort() 可以在請求完成前中止它。

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