jQuery ajax - ajax() 方法
參數
- options
-
類型：Object
可選。AJAX 請求設置。所有選項都是可選的。
- async
-
類型：Boolean
默認值: true。默認設置下，所有請求均爲異步請求。如果需要發送同步請求，請將此選項設置爲 false。
注意，同步請求將鎖住瀏覽器，用戶其它操作必須等待請求完成纔可以執行。
- beforeSend(XHR)
-
類型：Function
發送請求前可修改 XMLHttpRequest 對象的函數，如添加自定義 HTTP 頭。
XMLHttpRequest 對象是唯一的參數。
這是一個 Ajax 事件。如果返回 false 可以取消本次 ajax 請求。
- cache
-
類型：Boolean
默認值: true，dataType 爲 script 和 jsonp 時默認爲 false。設置爲 false 將不緩存此頁面。
jQuery 1.2 新功能。
- complete(XHR, TS)
-
類型：Function
請求完成後回調函數 (請求成功或失敗之後均調用)。
參數： XMLHttpRequest 對象和一個描述請求類型的字符串。
這是一個 Ajax 事件。
- contentType
-
類型：String
默認值: "application/x-www-form-urlencoded"。發送信息至服務器時內容編碼類型。
默認值適合大多數情況。如果你明確地傳遞了一個 content-type 給 $.ajax() 那麼它必定會發送給服務器（即使沒有數據要發送）。
- context
-
類型：Object
這個對象用於設置 Ajax 相關回調函數的上下文。也就是說，讓回調函數內 this 指向這個對象（如果不設定這個參數，那麼 this 就指向調用本次 AJAX 請求時傳遞的 options 參數）。比如指定一個 DOM 元素作爲 context 參數，這樣就設置了 success 回調函數的上下文爲這個 DOM 元素。
就像這樣：
$.ajax({ url: "test.html", context: document.body, success: function(){ $(this).addClass("done"); }}); - data
-
類型：String
發送到服務器的數據。將自動轉換爲請求字符串格式。GET 請求中將附加在 URL 後。查看 processData 選項說明以禁止此自動轉換。必須爲 Key/Value 格式。如果爲數組，jQuery 將自動爲不同值對應同一個名稱。如 {foo:["bar1", "bar2"]} 轉換爲 '&foo=bar1&foo=bar2'。
- dataFilter
-
類型：Function
給 Ajax 返回的原始數據的進行預處理的函數。提供 data 和 type 兩個參數：data 是 Ajax 返回的原始數據，type 是調用 jQuery.ajax 時提供的 dataType 參數。函數返回的值將由 jQuery 進一步處理。
- dataType
-
類型：String
預期服務器返回的數據類型。如果不指定，jQuery 將自動根據 HTTP 包 MIME 信息來智能判斷，比如 XML MIME 類型就被識別爲 XML。在 1.4 中，JSON 就會生成一個 JavaScript 對象，而 script 則會執行這個腳本。隨後服務器端返回的數據會根據這個值解析後，傳遞給回調函數。可用值:
- "xml": 返回 XML 文檔，可用 jQuery 處理。
- "html": 返回純文本 HTML 信息；包含的 script 標籤會在插入 dom 時執行。
- "script": 返回純文本 JavaScript 代碼。不會自動緩存結果。除非設置了 "cache" 參數。注意：在遠程請求時(不在同一個域下)，所有 POST 請求都將轉爲 GET 請求。（因爲將使用 DOM 的 script標籤來加載）
- "json": 返回 JSON 數據 。
- "jsonp": JSONP 格式。使用 JSONP 形式調用函數時，如 "myurl?callback=?" jQuery 將自動替換 ? 爲正確的函數名，以執行回調函數。
- "text": 返回純文本字符串
- error
-
類型：Function
默認值: 自動判斷 (xml 或 html)。請求失敗時調用此函數。
有以下三個參數：XMLHttpRequest 對象、錯誤信息、（可選）捕獲的異常對象。
如果發生了錯誤，錯誤信息（第二個參數）除了得到 null 之外，還可能是 "timeout", "error", "notmodified" 和 "parsererror"。
這是一個 Ajax 事件。
- global
-
類型：Boolean
是否觸發全局 AJAX 事件。默認值: true。設置爲 false 將不會觸發全局 AJAX 事件，如 ajaxStart 或 ajaxStop 可用於控制不同的 Ajax 事件。
- ifModified
-
類型：Boolean
僅在服務器數據改變時獲取新數據。默認值: false。使用 HTTP 包 Last-Modified 頭信息判斷。在 jQuery 1.4 中，它也會檢查服務器指定的 'etag' 來確定數據沒有被修改過。
- jsonp
-
類型：String
在一個 jsonp 請求中重寫回調函數的名字。這個值用來替代在 "callback=?" 這種 GET 或 POST 請求中 URL 參數裏的 "callback" 部分，比如 {jsonp:'onJsonPLoad'} 會導致將 "onJsonPLoad=?" 傳給服務器。
- jsonpCallback
-
類型：String
爲 jsonp 請求指定一個回調函數名。這個值將用來取代 jQuery 自動生成的隨機函數名。這主要用來讓 jQuery 生成度獨特的函數名，這樣管理請求更容易，也能方便地提供回調函數和錯誤處理。你也可以在想讓瀏覽器緩存 GET 請求的時候，指定這個回調函數名。
- password
-
類型：String
用於響應 HTTP 訪問認證請求的密碼
- processData
-
類型：Boolean
默認值: true。默認情況下，通過data選項傳遞進來的數據，如果是一個對象(技術上講只要不是字符串)，都會處理轉化成一個查詢字符串，以配合默認內容類型 "application/x-www-form-urlencoded"。如果要發送 DOM 樹信息或其它不希望轉換的信息，請設置爲 false。
- scriptCharset
-
類型：String
只有當請求時 dataType 爲 "jsonp" 或 "script"，並且 type 是 "GET" 纔會用於強制修改 charset。通常只在本地和遠程的內容編碼不同時使用。
- success
-
類型：Function
請求成功後的回調函數。
參數：由服務器返回，並根據 dataType 參數進行處理後的數據；描述狀態的字符串。
這是一個 Ajax 事件。
- traditional
-
類型：Boolean
如果你想要用傳統的方式來序列化數據，那麼就設置爲 true。請參考工具分類下面的 jQuery.param 方法。
- timeout
-
類型：Number
設置請求超時時間（毫秒）。此設置將覆蓋全局設置。
- type
-
類型：String
默認值: "GET")。請求方式 ("POST" 或 "GET")， 默認爲 "GET"。注意：其它 HTTP 請求方法，如 PUT 和 DELETE 也可以使用，但僅部分瀏覽器支持。
- url
-
類型：String
默認值: 當前頁地址。發送請求的地址。
- username
-
類型：String
用於響應 HTTP 訪問認證請求的用戶名。
- xhr
-
類型：Function
需要返回一個 XMLHttpRequest 對象。默認在 IE 下是 ActiveXObject 而其他情況下是 XMLHttpRequest 。用於重寫或者提供一個增強的 XMLHttpRequest 對象。這個參數在 jQuery 1.3 以前不可用。
回調函數
如果要處理 $.ajax() 得到的數據，則需要使用回調函數：beforeSend、error、dataFilter、success、complete。
beforeSend
在發送請求之前調用，並且傳入一個 XMLHttpRequest 作爲參數。
error
在請求出錯時調用。傳入 XMLHttpRequest 對象，描述錯誤類型的字符串以及一個異常對象（如果有的話）
dataFilter
在請求成功之後調用。傳入返回的數據以及 "dataType" 參數的值。並且必須返回新的數據（可能是處理過的）傳遞給 success 回調函數。
success
當請求之後調用。傳入返回後的數據，以及包含成功代碼的字符串。
complete
當請求完成之後調用這個函數，無論成功或失敗。傳入 XMLHttpRequest 對象，以及一個包含成功或錯誤代碼的字符串。
以上來自：http://www.w3school.com.cn/jquery/ajax_ajax.asp
樣例：
$("#searchCompany").click(function(){//點擊事件觸發
$.ajax({
url:"${contextPath}/load/ajax/searchCompany.do", //請求地址
async:false,
type:'post',
dataType:'json',
data:{ //多個請求數據參數
name:"",
size:"",
b:"",
url:""
},
success: function (data) { //請求成功，對返回結果data進行操作
}
});
});$("#searchCompany").click(function(){
//清空ul子節點
$("#searchResult").empty();
var h3=document.getElementById("h3");
var company=document.getElementById("companyName");
var ul=document.getElementById("searchResult");
//companyName爲空 彈出警告
if(company.value=="")
{
openDialogHelper.getOpenPageDialog().error("污染源不能爲空");
return;
}
$.ajax({
url:"${contextPath}/load/ajax/searchCompany.do",
async:false,
type:'post',
dataType:'json',
data:{
name:company.value,
size:"0",
b:"13181393.38,3375169.77;13419217.38,3566145.77",//百度地圖搜索範圍（全杭州）
url:"${arcgis}/arcgis/rest/services/fpi/hangzhouThemeFind/MapServer/find?contains=true&searchFields=Name&sr=4326&layers=1%2C2%2C3%2C4%2C5%2C6%2C7%2C8%2C9%2C10%2C11%2C12%2C13%2C14%2C15&returnGeometry=false&f=json"
},
success: function (data) {
data = setFlashDatas(data);
h3.innerHTML='地圖搜索"'+company.value+'",共有'+data.length+"個符合條件的結果：";
for(var i=0;i<data.length;i++)
{
var $li=$('<li id="li_'+i+'" style="background: url(../images/mapSearch/icon_'+(i+1)+'.png) no-repeat 0;">'+
'<a href="#" οnclick="passValue('+i+');"><div class="class1">'+data[i].name+'</div><div class="class2">發生地點：'+data[i].address+"</div></a></li>");
$("#searchResult").append($li);
//alert(data[i]);
$("li").data("data"+i,data[i]);
//resetLocate(data);
//background-color:rgb(238, 245, 255);
}
}
});
});
