標籤:javascrip 附加 資料來源 功能 pac arc sda call foo
首先請看一個Jquery.ajax的例子
$.ajax({
type: "GET",
url: "/api/SearchApi/GetResults",
dataType: "json",
data:{
filter: "test",
pageNumber: 1,
pageSize: 5
},
success: function(data){
// do something
},
complete: function(XMLHttpRequest, textStatus){
},
error: function(){
//請求出錯處理
}
});
還有很多參數,這裡主要列出了一些常用的參數
特別注意裡面有兩個地方:
一個是 data {}
另一個是 success: function(data){ //do something }
注意,這兩個地方的data是有本質區別的:
data{} 是傳入到這個jquery ajax的url中處理的資料來源,它採用的格式必須為 Key/Value 格式. 如果為數組,jQuery將自動為不同值對應同一個名稱。 如 {foo:["bar1","bar2"]} 將轉換為 ‘&foo=bar1&foo=bar2‘
而success: function(data){ //do something }中的data為伺服器處理完這個ajax請求後,返回的結果資料。
具體ajax請求還有很多參數,請參看如下:
參數列表:
| 參數名 |
類型 |
描述 |
| 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() 返回其建立的 XMLHttpRequest 對象。大多數情況下你無需直接操作該對象,但特殊情況下可用於手動終止請求。
注意: 如果你指定了 dataType 選項,請確保伺服器返回正確的 MIME 資訊,(如 xml 返回 "text/xml")。錯誤的 MIME 類型可能導致不可預知的錯誤。
當設定 datatype 類型為 ‘script‘ 的時候,所有的遠程(不在同一個域中)POST請求都迴轉換為GET方式。
$.ajax() 只有一個參數:參數 key/value 對象,包含各配置及回呼函數資訊。詳細參數選項見下。
jQuery 1.2 中,您可以跨域載入 JSON 資料,使用時需將資料類型設定為 JSONP。使用 JSONP 形式調用函數時,如 "myurl?callback=?" jQuery 將自動替換 ? 為正確的函數名,以執行回呼函數。資料類型設定為 "jsonp" 時,jQuery 將自動調用回呼函數
Jquery.ajax 詳細解釋 通過Http請求載入遠端資料