jQuery 底层 AJAX 实现。简单易用的高层实现见 $.get, $.post 等。$.ajax() 返回其创建的 XMLHttpRequest 对象。大多数情况下你无需直接操作该函式,除非你需要操作不常用的选项,以获得更多的灵活性。
基本介绍
- 中文名jQuery.ajax()
- 回调函式如果要处理$.ajax()得到的数
- 数据类型$.ajax()函式依赖伺服器提供的
- 高级选项global选项用于阻止回响
概述
通过 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()可以在请求完成前挂起请求。
参数
options(可选)ObjectAJAX 请求设定。所有选项都是可选的。
选项
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参数}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");}});
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 事件。
ifModifiedBoolean
(默认: false) 仅在伺服器数据改变时获取新数据。使用 HTTP 包 Last-Modified 头信息判断。在jQuery 1.4中,他也会检查伺服器指定的'etag'来确定数据没有被修改过。
jsonpString在一个jsonp请求中重写回调函式的名字。这个值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分,比如{jsonp:'onJsonPLoad'}会导致将"onJsonPLoad=?"传给伺服器。
jsonpCallbackString为jsonp请求指定一个回调函式名。这个值将用来取代jQuery自动生成的随机函式名。这主要用来让jQuery生成度独特的函式名,这样管理请求更容易,也能方便地提供回调函式和错误处理。你也可以在想让浏览器快取GET请求的时候,指定这个回调函式名。
passwordString
用于回响HTTP访问认证请求的密码
processDataBoolean
(默认: true) 默认情况下,通过data选项传递进来的数据,如果是一个对象(技术上讲只要不是字元串),都会处理转化成一个查询字元串,以配合默认内容类型 "application/x-www-form-urlencoded"。如果要传送 DOM 树信息或其它不希望转换的信息,请设定为 false。
scriptCharsetString
只有当请求时dataType为"jsonp"或"script",并且type是"GET"才会用于强制修改charset。通常只在本地和远程的内容编码不使用。
successFunction
请求成功后的回调函式。参数由伺服器返回,并根据dataType参数进行处理后的数据;描述状态的字元串。 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以前不可用。
示例
描述:载入并执行一个 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 });
jQuery post实例代码
$.post("test.php",{name:name,pwd:pwd},function(msg){
alert(msg);
})
test.php 里面用$_POST["name"] 和$_POST["pwd"]接收参数.
$.post第一个参数是url,{}这里里面的是参数名称和值之间用:非开,多个值用,分开,一个是返回的函式msg就是返回的结果。根据自己的需要返回不用的数据。
$.get和post一样,php接收的话改成$_GET["name"]和$_GET["pwd"]