先介紹一下 Ajax 概念
AJAX 即「Asynchronous Javascript And XML」(非同步 JavaScript 和 XML),是一門打造互動式網頁應用的開發技術。
AJAX = 非同步 JavaScript 和 XML(標準通用標記語言的子集)。
AJAX 是能打造快速動態網頁的技術。
透過在後台與伺服器進行少量資料交換,AJAX 能讓網頁實現非同步更新,也就是說,不必重新載入整頁就能更新其中一部分。
傳統網頁(不使用 AJAX)若需要更新內容,就必須重載整頁。
Ajax 方法
$.ajax() 是 jQuery 最底層的 Ajax 實作。其結構為:
$.ajax(options)
這個方法只有一個參數,但這個物件裡包含了 $.ajax() 所需的請求設定與回呼函式等資訊,參數以 key/value 形式存在,且所有參數都是選填的。常用參數如下:
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 請求中會附加在網址後。防止這種自動轉換可查看 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:JSON 格式。使用 JSONP 形式呼叫函式時,例如 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.global
要求為 Boolean 型別的參數,預設為 true,表示是否觸發全域 Ajax 事件。設為 false 將不觸發全域 Ajax 事件,ajaxStart 與 ajaxStop 可用於控制各種 Ajax 事件。
15.ifModified
要求為 Boolean 型別的參數,預設為 false,僅在伺服器資料改變時取得新資料。伺服器資料是否改變的依據是 Last-Modified 標頭資訊。預設為 false,即忽略標頭資訊。
16.jsonp
要求為 String 型別的參數,在一個 jsonp 請求中重寫回呼函式的名字。該值用來替代在 "callback=?" 這種 GET 或 POST 請求的網址參數裡的 "callback" 部分,例如 {jsonp:'onJsonPLoad'} 會導致將 "onJsonPLoad=?" 傳給伺服器。
17.username
要求為 String 型別的參數,用於響應 HTTP 存取認證請求的使用者。
18.password
要求為 String 型別的參數,用於響應 HTTP 存取認證請求的密碼。
19.processData
要求為 Boolean 型別的參數,預設為 true。預設情況下,發送的資料會被轉為物件(技術上而非字串)以配合預設內容型別 "application/x-www-form-urlencoded"。若要發送 DOM 樹資訊或其他不希望轉換的資訊,請設為 false。
20.scriptCharset
要求為 String 型別的參數,只有在請求時 dataType 為 "jsonp" 或 "script" 且 type 是 GET 時,才會用於強制修改字元集(charset)。通常在本地與遠端的內容編碼不同時使用。
案例程式碼:
$(function(){ $('#send').click(function(){ $.ajax({ type: "GET", url: "test.json", data: {username:$("#username").val(), content:$("#content").val()}, dataType: "json", success: function(data){ $('#resText').empty(); //清空resText裡面的所有內容 var html = ''; $.each(data, function(commentIndex, comment){ html += '<div class="comment"><h6>' + comment['username'] + ':</h6><p class="para"' + comment['content'] + '</p></div>'; }); $('#resText').html(html); } }); }); });
知識連結:
1、$.each() 函式:不同於 jQuery 物件的 each() 方法,它是一個全域函式,不操作 jQuery 物件。該函式接收兩個參數,第 1 個是陣列或物件,第 2 個是回呼函式。回呼函式有兩個參數:第 1 個為陣列索引或物件成員,第 2 個為對應的變數或內容。
$.each(data,function(commentIndex,comment){ //doSomething; })
2、ajaxStart() 與 ajaxStop():當 Ajax 請求開始時,會觸發 ajaxStart() 的回呼函式;當 Ajax 請求結束時,會觸發 ajaxStop() 的回呼函式。這些都是全域方法,因此無論建立它們的程式碼位於何處,只要有 Ajax 請求發生就會觸發。
有時頁面需要載入一些圖片,速度可能較慢,若在載入過程中不給使用者提示與回饋,很容易讓使用者誤以為按鈕無效,從而對網站失去信心。
此時我們需要為網頁加上提示資訊,常見的是「載入中…」,程式碼如下:
<div id="loading">加載中...</div>
當 Ajax 請求開始時顯示此元素,用來提示使用者請求正在進行;請求結束後再將它隱藏。程式碼如下:
$("#loading").ajaxStart(function(){ $(this).show(); }).ajaxStop(function(){ $(this).hide(); })
好了,再分享一個案例程式碼:
$(function(){ $('#send').click(function(){ $.ajax({ type: "GET", url: "test.json", data: {username:$("#username").val(), content:$("#content").val()}, dataType: "json", success: function(data){ $('#resText').empty(); //清空resText裡面的所有內容 var html = ''; $.each(data, function(commentIndex, comment){ html += '<div class="comment"><h6>' + comment['username'] + ':</h6><p class="para"' + comment['content'] + '</p></div>'; }); $('#resText').html(html); } }); }); });
end,程式碼到此結束。
以上就是 $.ajax() 方法參數的全面解析,希望對大家有幫助。若有疑問歡迎留言,我會盡快回覆,也感謝大家的支持!