jQuery中Ajax(三)
1. jQuery.ajaxSetup([options]), 设置全局 AJAX 默认选项。
参数见 'jQuery.ajax(url,[settings])' 说明。
2. jQuery.ajax(url,[settings]), 通过 HTTP 请求加载远程数据。
jQuery 底层 AJAX 实现。$.ajax() 返回其创建的 XMLHttpRequest 对象。大多数情况下你无需直接操作该函数,除非你需要操作不常用的选项,以获得更多的灵活性。
最简单的情况下,$.ajax()可以不带任何参数直接使用。
所有的选项都可以通过$.ajaxSetup()函数来全局设置。
参数说明:
- url:一个用来包含发送请求的URL字符串。
- settings:AJAX 请求设置。所有选项都是可选的。
(1) settings选项
- async:Boolean,默认设置下(true),所有请求均为异步请求。如果需要发送同步请求,请将此选项设置为 false。注意,同步请求将锁住浏览器,用户其它操作必须等待请求完成才可以执行。
- beforeSend(XHR):Function,发送请求前可修改 XMLHttpRequest 对象的函数,如添加自定义 HTTP 头。XMLHttpRequest 对象是唯一的参数。这是一个 Ajax 事件。如果返回false可以取消本次ajax请求。
function (XMLHttpRequest) { this; // 调用本次AJAX请求时传递的options参数 }
- cache:Boolean,(默认: true,dataType为script和jsonp时默认为false) jQuery 1.2 新功能,设置为 false 将不缓存此页面。
- complete(XHR, TS):Function,请求完成后回调函数 (请求成功或失败之后均调用)。参数: XMLHttpRequest 对象和一个描述成功请求类型的字符串。
function (XMLHttpRequest, textStatus) { this; // 调用本次AJAX请求时传递的options参数 }
- contents:一个以"{字符串:正则表达式}"配对的对象,用来确定jQuery将如何解析响应,给定其内容类型。一般不用设置。
- 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"); }});
- crossDomain:默认是false(同域请求),跨域请求为true如果你想强制跨域请求(如JSONP形式)同一域,设置crossDomain为true。这使得例如,服务器端重定向到另一个域。
- data:Object或String,发送到服务器的数据。将自动转换为请求字符串格式。GET 请求中将附加在 URL 后。必须为 Key/Value 格式。如果为数组,jQuery 将自动为不同值对应同一个名称。如 {foo:["bar1", "bar2"]} 转换为 "&foo=bar1&foo=bar2"。
- dataFilter:Function,给Ajax返回的原始数据的进行预处理的函数。提供data和type两个参数:data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataType参数。函数返回的值将由jQuery进一步处理。
function (data, type) { // 对Ajax返回的原始数据进行预处理 return data // 返回处理后的数据 }
- 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"。
function (XMLHttpRequest, textStatus, errorThrown) { // 通常 textStatus 和 errorThrown 之中 // 只有一个会包含信息 this; // 调用本次AJAX请求时传递的options参数 }
- global:Boolean,(默认: true) 是否触发全局 AJAX 事件。设置为 false 将不会触发全局 AJAX 事件。
- headers:默认是{},一个额外的"{键:值}"对映射到请求一起发送。此设置被设置之前beforeSend函数被调用;因此,消息头中的值设置可以在覆盖beforeSend函数范围内的任何设置。
- ifModified:Boolean,(默认: false) 仅在服务器数据改变时获取新数据。使用 HTTP 包 Last-Modified 头信息判断。在jQuery 1.4中,他也会检查服务器指定的'etag'来确定数据没有被修改过。
- jsonp:String,在一个jsonp请求中重写回调函数的名字。这个值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分,比如{jsonp:'onJsonPLoad'}会导致将"onJsonPLoad=?"传给服务器。
- mimeType:String,一个mime类型用来覆盖XHR的 MIME类型。
- password:String,用于响应HTTP访问认证请求的密码。
- processData:(默认: true) 默认情况下,通过data选项传递进来的数据,如果是一个对象(技术上讲只要不是字符串),都会处理转化成一个查询字符串,以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息,请设置为 false。
- scriptCharset:String,只有当请求时dataType为"jsonp"或"script",并且type是"GET"才会用于强制修改charset。通常只在本地和远程的内容编码不同时使用。
- statusCode:默认是{},一组数值的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, 成功设置可以接受一个函数数组。每个函数将被依次调用。
function (data, textStatus) { // data 可能是 xmlDoc, jsonObj, html, text, 等等... this; // 调用本次AJAX请求时传递的options参数 }
- traditional:如果你想要用传统的方式来序列化数据,那么就设置为true。
- timeout:Number,设置请求超时时间(毫秒)。此设置将覆盖全局设置。
- type:String,(默认: "GET") 请求方式 ("POST" 或 "GET"), 默认为 "GET"。注意:其它 HTTP 请求方法,如 PUT 和 DELETE 也可以使用,但仅部分浏览器支持。
- url:(默认: 当前页地址) 发送请求的地址。
- username:String,用于响应HTTP访问认证请求的用户名
- xhr:Function,需要返回一个XMLHttpRequest 对象。默认在IE下是ActiveXObject 而其他情况下是XMLHttpRequest 。用于重写或者提供一个增强的XMLHttpRequest 对象。这个参数在jQuery 1.3以前不可用。
- xhrFields:一对“文件名-文件值”在本机设置XHR对象。例如,如果需要的话,你可以用它来设置withCredentials为true的跨域请求。
3. jQuery.get(url, [data], [callback], [type]), 通过远程 HTTP GET 请求载入信息
用以取代复杂 $.ajax 。请求成功时可调用回调函数。如果需要在出错时执行函数,请使用 $.ajax。
参数说明:
- url:待载入页面的URL地址
- data:待发送 Key/value 参数。
- callback:载入成功时回调函数。
- type:返回内容格式,xml, html, script, json, text, _default。
$.get("test.php", function(data){ alert("Data Loaded: " + data); });
jQuery 1.12 中 jQuery.post 和 jQuery.get 支持对象参数,这样一来,可以更加灵活地控制。
jQuery.get({
url: “/example”
});
4. jQuery.getJSON(url, [data], [callback]), 通过 HTTP GET 请求载入 JSON 数据
参数说明:
- url:发送请求地址。
- data:待发送 Key/value 参数。
- callback:载入成功时回调函数。
在 jQuery 1.2 中,您可以通过使用JSONP形式的回调函数来加载其他网域的JSON数据,如 "myurl?callback=?"。jQuery 将自动替换 ? 为正确的函数名,以执行回调函数。 注意:此行以后的代码将在这个回调函数执行前执行。
$.getJSON("test.js", function(json){ alert("JSON Data: " + json.users[3].name); });
5. jQuery.getScript(url, [callback]), 通过 HTTP GET 请求载入并执行一个 JavaScript 文件
通过 HTTP GET 请求载入并执行一个 JavaScript 文件。
jQuery 1.2 版本之前,getScript 只能调用同域 JS 文件。 1.2中,您可以跨域调用 JavaScript 文件。注意:Safari 2 或更早的版本不能在全局作用域中同步执行脚本。如果通过 getScript 加入脚本,请加入延时函数。
参数说明:
- url:待载入 JS 文件地址。
- callback:成功载入后回调函数。
jQuery.getScript("http://dev.jquery.com/view/trunk/plugins/color/jquery.color.js", function(){ $("#go").click(function(){ $(".block").animate( { backgroundColor: 'pink' }, 1000) .animate( { backgroundColor: 'blue' }, 1000); }); });
6. jQuery.post(url, [data], [callback], [type]), 通过远程 HTTP POST 请求载入信息
通过远程 HTTP POST 请求载入信息。
参数说明:
- url:发送请求地址。
- data:待发送 Key/value 参数。
- callback:发送成功时回调函数。
- type:返回内容格式,xml, html, script, json, text, _default。
$.post("test.php", function(data){ alert("Data Loaded: " + data); });
jQuery 1.12 中 jQuery.post 和 jQuery.get 支持对象参数
jQuery.post({
url: “/example”
});
7. ajaxComplete(callback), AJAX 请求完成时执行函数。
$("#msg").ajaxComplete(function(event,XMLHttpRequest, settings){
$(this).append("<li>请求完成.</li>");
});
8. ajaxError(callback), AJAX 请求发生错误时执行函数。
XMLHttpRequest 对象和设置作为参数传递给回调函数。捕捉到的错误可作为最后一个参数传递。
function (event, XMLHttpRequest, ajaxOptions, thrownError) { // thrownError 只有当异常发生时才会被传递 this; // 监听的 dom 元素 }
9. ajaxSend(callback), AJAX 请求发送前执行函数。
XMLHttpRequest 对象和设置作为参数传递给回调函数。
$("#msg").ajaxSend(function(evt, request, settings){ $(this).append("<li>开始请求: " + settings.url + "</li>"); });
10. ajaxStart(callback), AJAX 请求开始时执行函数。
$("#loading").ajaxStart(function(){ $(this).show(); });
11. ajaxStop(callback), AJAX 请求结束时执行函数
$("#loading").ajaxStop(function(){ $(this).hide(); });
12. ajaxSuccess(callback), AJAX 请求成功时执行函数
XMLHttpRequest 对象和设置作为参数传递给回调函数。
$("#msg").ajaxSuccess(function(evt, request, settings){ $(this).append("<li>请求成功!</li>"); });
13. load(url, [data], [callback]), 载入远程 HTML 文件代码并插入至 DOM 中
默认使用 GET 方式 - 传递附加参数时自动转换为 POST 方式。jQuery 1.2 中,可以指定选择符,来筛选载入的 HTML 文档,DOM 中将仅插入筛选出的 HTML 代码。语法形如 "url #some > selector"。
参数说明:
- url:待装入 HTML 网页网址。
- data:发送至服务器的 key/value 数据。在jQuery 1.3中也可以接受一个字符串了。
- callback:载入成功时回调函数。
$("#feeds").load("feeds.html");
14. serialize(), 序列表格内容为字符串。
$("#results").append( "<tt>" + $("form").serialize() + "</tt>" );
15. serializeArray(), 序列化表格元素, 返回 JSON 数据结构数据。
此方法返回的是JSON对象而非JSON字符串。需要使用插件或者第三方库进行字符串化操作。
[ {name: 'firstname', value: 'Hello'}, {name: 'lastname', value: 'World'}, {name: 'alias'}, // this one was empty ]
var fields = $("select, :radio").serializeArray(); jQuery.each( fields, function(i, field){ $("#results").append(field.value + " "); });