返回值:XMLHttpRequestjQuery.ajax(url,[settings])

概述

通过 HTTP 请求加载远程数据。

jQuery 底层 AJAX 实现。简单易用的高层实现见 $.get, $.post 等。$.ajax() 返回其创建的 XMLHttpRequest 对象。大多数情况下你无需直接操作该函数,除非你需要操作不常用的选项,以获得更多的灵活性。

最簡單的情況下,$.ajax()可以不帶任何參數直接使用。

注意,所有的選項都可以通過$.ajaxSetup()函數來全局設置。

回調函數

如果要处理$.ajax()得到的数据,则需要使用回調函數。beforeSend、error、dataFilter、success、complete。

  • beforeSend 在发送请求之前调用,并且传入一个XMLHttpRequest作为參數。
  • error 在请求出错时调用。传入XMLHttpRequest对象,描述错误类型的字符串以及一个异常对象(如果有的话)
  • dataFilter 在请求成功之后调用。传入返回的数据以及"dataType"參數的值。并且必须返回新的数据(可能是处理过的)传递给success回調函數。
  • success 当请求之后调用。传入返回后的数据,以及包含成功代码的字符串。
  • complete 当请求完成之后调用这个函数,无论成功或失败。传入XMLHttpRequest对象,以及一个包含成功或错误代码的字符串。

數據類型

$.ajax()函數依賴服務器提供的信息來處理返回的數據。如果服務器報告說返回的數據是XML,那麽返回的結果就可以用普通的XML方法或者jQuery的選擇器來遍曆。如果見得到其他類型,比如HTML,則數據就以文本形式來對待。

通过dataType选项还可以指定其他不同数据处理方式。除了单纯的XML,还可以指定 html、json、jsonp、script或者text。

其中,text和xml类型返回的数据不会经过处理。数据仅仅简单的将XMLHttpRequest的responseText或responseHTML属性传递给success回調函數,

'''注意''',我们必须确保网页服务器报告的MIME类型与我们选择的dataType所匹配。比如说,XML的话,服务器端就必须声明 text/xml 或者 application/xml 来获得一致的结果。

如果指定爲html類型,任何內嵌的JavaScript都會在HTML作爲一個字符串返回之前執行。類似的,指定script類型的話,也會先執行服務器端生成JavaScript,然後再把腳本作爲一個文本數據返回。

如果指定为json类型,则会把获取到的数据作为一个JavaScript对象来解析,并且把构建好的对象作为结果返回。为了实现这个目的,他首先尝试使用JSON.parse()。如果浏览器不支持,则使用一个函数来构建。JSON数据是一种能很方便通过JavaScript解析的结构化数据。如果获取的数据文件存放在远程服务器上(域名不同,也就是跨域获取数据),则需要使用jsonp类型。使用这种类型的话,会创建一个查询字符串參數 callback=? ,这个參數会加在请求的URL后面。服务器端应当在JSON数据前加上回調函數名,以便完成一个有效的JSONP请求。如果要指定回調函數的參數名来取代默认的callback,可以通过设置$.ajax()的jsonp參數。

注意,JSONP是JSON格式的擴展。他要求一些服務器端的代碼來檢測並處理查詢字符串參數。更多信息可以參閱 最初的文章

如果指定了script或者jsonp類型,那麽當從服務器接收到數據時,實際上是用了<script>標簽而不是XMLHttpRequest對象。這種情況下,$.ajax()不再返回一個XMLHttpRequest對象,並且也不會傳遞事件處理函數,比如beforeSend。

發送數據到服務器

默認情況下,Ajax請求使用GET方法。如果要使用POST方法,可以設定type參數值。這個選項也會影響data選項中的內容如何發送到服務器。

data选项既可以包含一个查询字符串,比如 key1=value1&key2=value2 ,也可以是一个映射,比如 {key1: 'value1', key2: 'value2'} 。如果使用了后者的形式,则数据再发送器会被转换成查询字符串。这个处理过程也可以通过设置processData选项为false来回避。如果我们希望发送一个XML对象给服务器时,这种处理可能并不合适。并且在这种情况下,我们也应当改变contentType选项的值,用其他合适的MIME类型来取代默认的 application/x-www-form-urlencoded 。

高級選項

global选项用于阻止响应注册的回調函數,比如.ajaxSend,或者ajaxError,以及类似的方法。这在有些时候很有用,比如发送的请求非常频繁且简短的时候,就可以在ajaxSend里禁用这个。更多关于这些方法的详细信息,请参阅下面的内容。

如果服務器需要HTTP認證,可以使用用戶名和密碼可以通過username和password選項來設置。

Ajax請求是限時的,所以錯誤警告被捕獲並處理後,可以用來提升用戶體驗。請求超時這個參數通常就保留其默認值,要不就通過jQuery.ajaxSetup來全局設定,很少爲特定的請求重新設置timeout選項。

默認情況下,請求總會被發出去,但浏覽器有可能從他的緩存中調取數據。要禁止使用緩存的結果,可以設置cache參數爲false。如果希望判斷數據自從上次請求後沒有更改過就報告出錯的話,可以設置ifModified爲true。

scriptCharset允許給<script>標簽的請求設定一個特定的字符集,用于script或者jsonp類似的數據。當腳本和頁面字符集不同時,這特別好用。

Ajax的第一個字母是asynchronous的開頭字母,這意味著所有的操作都是並行的,完成的順序沒有前後關系。$.ajax()的async參數總是設置成true,這標志著在請求開始後,其他代碼依然能夠執行。強烈不建議把這個選項設置成false,這意味著所有的請求都不再是異步的了,這也會導致浏覽器被鎖死。

$.ajax函數返回他創建的XMLHttpRequest對象。通常jQuery只在內部處理並創建這個對象,但用戶也可以通過xhr選項來傳遞一個自己創建的xhr對象。返回的對象通常已經被丟棄了,但依然提供一個底層接口來觀察和操控請求。比如說,調用對象上的.abort()可以在請求完成前挂起請求。

參數

url,[settings]ObjectV1.5

url:一個用來包含發送請求的URL字符串。

settings:AJAX 请求设置。所有选项都是可选的。

V1.0settings:選項

acceptsMap

默认: 取决于數據類型。

內容類型發送請求頭,告訴服務器什麽樣的響應會接受返回。如果accepts設置需要修改,推薦在$.ajaxSetup()方法中做一次。

asyncBoolean

(默认: true) 默认设置下,所有请求均为异步请求。如果需要发送同步请求,请将此选项设置为 false。注意,同步请求将锁住浏览器,用户其它操作必须等待请求完成才可以执行。

beforeSend(XHR)Function

发送请求前可修改 XMLHttpRequest 对象的函数,如添加自定义 HTTP 头。XMLHttpRequest 对象是唯一的參數。这是一个 Ajax 事件。如果返回false可以取消本次ajax請求。

function (XMLHttpRequest) {

    this; // 调用本次AJAX请求时传递的options參數

}

cacheBoolean

(默认: true,dataType为script和jsonp时默认为false) jQuery 1.2 新功能,设置为 false 将不缓存此页面。

complete(XHR, TS)Function

请求完成后回調函數 (请求成功或失败之后均调用)。參數: XMLHttpRequest 对象和一个描述成功请求类型的字符串。 Ajax 事件

function (XMLHttpRequest, textStatus) {

    this; // 调用本次AJAX请求时传递的options參數

}

contentsMapV1.5

一個以"{字符串:正則表達式}"配對的對象,用來確定jQuery將如何解析響應,給定其內容類型。

contentTypeString

(默认: "application/x-www-form-urlencoded") 发送信息至服务器时内容编码类型。默认值适合大多数情况。如果你明确地传递了一个content-type给 $.ajax() 那么他必定会发送给服务器(即使没有数据要发送)

contextObject

这个对象用于设置Ajax相关回調函數的上下文。也就是说,让回調函數内this指向这个对象(如果不设定这个參數,那么this就指向调用本次AJAX请求时传递的options參數)。比如指定一个DOM元素作为context參數,这样就设置了success回調函數的上下文为这个DOM元素。就像这样:

$.ajax({ url: "test.html", context: document.body, success: function(){

    $(this).addClass("done");

}});

convertersmapV1.5

默认: {"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML}

一个數據類型对數據類型转换器的对象。每个转换器的值是一个函数,返回响应的转化值

crossDomainmapV1.5

默认: 同域请求为false

跨域請求爲true如果你想強制跨域請求(如JSONP形式)同一域,設置crossDomain爲true。這使得例如,服務器端重定向到另一個域

dataObject,String

发送到服务器的数据。将自动转换为请求字符串格式。GET 请求中将附加在 URL 后。查看 processData 选项说明以禁止此自动转换。必须为 Key/Value 格式。如果为数组,jQuery 将自动为不同值对应同一个名称。如 {foo:["bar1", "bar2"]} 转换为 "&foo=bar1&foo=bar2"。

dataFilterFunction

给Ajax返回的原始数据的进行预处理的函数。提供data和type两个參數:data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataType參數。函数返回的值将由jQuery进一步处理。

function (data, type) {

    // 对Ajax返回的原始数据进行预处理

    return data  // 返回处理后的数据

}

dataTypeString

预期服务器返回的數據類型。如果不指定,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": 返回纯文本字符串

errorFunction

(默认: 自动判断 (xml 或 html)) 请求失败时调用此函数。有以下三个參數:XMLHttpRequest 对象、错误信息、(可选)捕获的异常对象。如果发生了错误,错误信息(第二个參數)除了得到null之外,还可能是"timeout", "error", "notmodified" 和 "parsererror"。Ajax 事件

function (XMLHttpRequest, textStatus, errorThrown) {

    // 通常 textStatus 和 errorThrown 之中

    // 只有一个会包含信息

    this; // 调用本次AJAX请求时传递的options參數

}

globalBoolean

(默认: true) 是否触发全局 AJAX 事件。设置为 false 将不会触发全局 AJAX 事件,如 ajaxStart 或 ajaxStop 可用于控制不同的 Ajax 事件

headersmapV1.5

Default: {}

一個額外的"{鍵:值}"對映射到請求一起發送。此設置被設置之前beforeSend函數被調用;因此,消息頭中的值設置可以在覆蓋beforeSend函數範圍內的任何設置。

ifModifiedBoolean

(默认: false) 仅在服务器数据改变时获取新数据。使用 HTTP 包 Last-Modified 头信息判断。在jQuery 1.4中,他也会检查服务器指定的'etag'来确定数据没有被修改过。

isLocalmapV1.5.1

默认: 取决于当前的位置协议

允许当前环境被认定为“本地”,(如文件系统),即使jQuery默认情况下不会承认它。以下协议目前公认为本地:file, *-extension, and widget。如果isLocal设置需要修改,建议在$.ajaxSetup()方法中这样做一次。

jsonpString

在一个jsonp请求中重写回調函數的名字。这个值用来替代在"callback=?"这种GET或POST请求中URL參數里的"callback"部分,比如{jsonp:'onJsonPLoad'}会导致将"onJsonPLoad=?"传给服务器。

jsonpCallbackString

为jsonp请求指定一个回調函數名。这个值将用来取代jQuery自动生成的随机函数名。这主要用来让jQuery生成度独特的函数名,这样管理请求更容易,也能方便地提供回調函數和错误处理。你也可以在想让浏览器缓存GET请求的时候,指定这个回調函數名。

mimeTypeStringV1.5.1

一个mime类型用来覆盖XHR的 MIME类型。

passwordString

用于響應HTTP訪問認證請求的密碼

processDataBoolean

(默认: true) 默认情况下,通过data选项传递进来的数据,如果是一个对象(技术上讲只要不是字符串),都会处理转化成一个查询字符串,以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息,请设置为 false。

scriptCharsetString

只有當請求時dataType爲"jsonp"或"script",並且type是"GET"才會用于強制修改charset。通常只在本地和遠程的內容編碼不同時使用。

statusCodemapV1.5

默认: {}

一組數值的HTTP代碼和函數對象,當響應時調用了相應的代碼。例如,如果響應狀態是404,將觸發以下警報:

$.ajax({

  statusCode: {404: function() {

    alert('page not found');

  }

});

success(data, textStatus, jqXHR)Function,Array

请求成功后的回調函數。參數:由服务器返回,并根据dataType參數进行处理后的数据;描述状态的字符串。还有 jqXHR(在jQuery 1.4.x的中,XMLHttpRequest) 对象 。在jQuery 1.5, 成功设置可以接受一个函数数组。每个函数将被依次调用。 Ajax 事件

function (data, textStatus) {

    // data 可能是 xmlDoc, jsonObj, html, text, 等等...

    this; // 调用本次AJAX请求时传递的options參數

}

traditionalBoolean

如果你想要用传统的方式来序列化数据,那么就设置为true。请参考工具分类下面的jQuery.param 方法。

timeoutNumber

設置請求超時時間(毫秒)。此設置將覆蓋全局設置。

typeString

(默认: "GET") 请求方式 ("POST" 或 "GET"), 默认为 "GET"。注意:其它 HTTP 请求方法,如 PUT 和 DELETE 也可以使用,但仅部分浏览器支持。

urlString

(默认: 当前页地址) 发送请求的地址。

usernameString

用于響應HTTP訪問認證請求的用戶名

xhrFunction

需要返回一个XMLHttpRequest 对象。默认在IE下是ActiveXObject 而其他情况下是XMLHttpRequest 。用于重写或者提供一个增强的XMLHttpRequest 对象。这个參數在jQuery 1.3以前不可用。

xhrFieldsmapV1.5

一對“文件名-文件值”在本機設置XHR對象。例如,如果需要的話,你可以用它來設置withCredentials爲true的跨域請求。

示例

描述:

加载并执行一个 JS 文件。

jQuery 代码:
$.ajax({

  type: "GET",

  url: "test.js",

  dataType: "script"

});

描述:

保存數據到服務器,成功時顯示信息。

jQuery 代码:
$.ajax({

   type: "POST",

   url: "some.php",

   data: "name=John&location=Boston",

   success: function(msg){

     alert( "Data Saved: " + msg );

   }

});

描述:

装入一个 HTML 网页最新版本。

jQuery 代码:
$.ajax({

  url: "test.html",

  cache: false,

  success: function(html){

    $("#results").append(html);

  }

});

描述:

同步加載數據。發送請求時鎖住浏覽器。需要鎖定用戶交互操作時使用同步方式。

jQuery 代码:
 var html = $.ajax({

  url: "some.php",

  async: false

 }).responseText;

描述:

发送 XML 数据至服务器。设置 processData 选项为 false,防止自动转换数据格式。

jQuery 代码:
 var xmlDocument = [create xml document];

 $.ajax({

   url: "page.php",

   processData: false,

   data: xmlDocument,

   success: handleResponse

 });