jQuery学习笔记：jQuery Ajax 06：$.ajax()方法

jQuery Ajax：$.ajax()方法

 

主要参考：

《锋利的jQuery》单东林、张晓菲、魏然

www.3cschool.com.cn之《jQuery 参考手册 - Ajax》

 

搜集整理：sagahu@163.com

 

简单示例： 通过 AJAX 加载一段文本

 

HTML 代码：

 

<div id="myDiv"><h2>Let AJAX change this text</h2></div>

<button id="b01" type="button">Change Content</button>

 

jQuery 代码：

 

$(document).ready(function(){

       $("#b01").click(function(){

              htmlobj=$.ajax({url:"/jquery/test1.txt",async:false});

              $("#myDiv").html(htmlobj.responseText);

       });

});

 

定义

 

ajax() 方法通过 HTTP 请求加载远程数据。

 

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

 

最简单的情况下，$.ajax() 可以不带任何参数直接使用。

 

注意：所有的选项都可以通过 $.ajaxSetup() 函数来全局设置。

 

语法

 

$.ajax(settings)

 

参数	说明
settings	可选。用于配置 Ajax 请求的键值对集合。 可以通过 $.ajaxSetup() 设置任何选项的默认值。
返回值	XMLHttpRequest

 

详细说明

 

该方法只有1个参数，但是就这个唯一的参数包含了$.ajax()方法所需要的请求设置以及回调函数等信息，参数以key/value的形式存在，所有参数都是可选的。

 

选项名称	类型	说明
url	String	发送请求的地址。默认为当前页地址。
type	String	请求方式 ("POST" 或 "GET")， 默认为 "GET"。注意：其它 HTTP 请求方法，如 PUT 和 DELETE 也可以使用，但仅部分浏览器支持。
timeout	Number	设置请求超时时间（毫秒）。此设置将覆盖全局设置。
async	Boolean	默认设置下，所有请求均为异步请求。如果需要发送同步请求，请将此选项设置为 false。默认值：true。 注意，同步请求将锁住浏览器，用户其它操作必须等待请求完成才可以执行。
cache	Boolean	设置为 false 将不缓存此页面。jQuery 1.2 新功能。默认为true，当dataType 为 script 和 jsonp 时默认为 false。
data	Object或String	发送到服务器的数据。如果不是字符串，将自动转换为请求字符串格式。GET 请求中将附加在 URL 后。想要防止这种自动转换，可以查看 processData 选项。 对象必须为 Key/Value 格式，例如{foo1:"bar1",foo2:"bar2"}转换为'&foo1=bar1&foo2=bar2'。如果为数组，jQuery 将自动为不同值对应同一个名称。例如 {foo:["bar1", "bar2"]} 转换为 '&foo=bar1&foo=bar2'。
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"：返回纯文本字符串
beforeSend(XHR)	Function	发送请求前可修改 XMLHttpRequest 对象的函数，例如添加自定义 HTTP 头。这是一个 Ajax 事件。 XMLHttpRequest 对象是唯一的参数。 如果返回 false 可以取消本次 ajax 请求。 function(XMLHttpRequest){        this; // 调用本次Ajax请求时传递的settings参数 }
complete	Function	请求完成后回调函数 (请求成功或失败之后均调用)。这是一个 Ajax 事件。 参数：XMLHttpRequest 对象和一个描述请求类型的字符串。 function(XMLHttpRequest, textStatus){        this; // 调用本次Ajax请求时传递的settings参数 }
success	Function	请求成功后的回调函数，有2个参数：（1）data：由服务器返回，并根据 dataType 参数进行处理后的数据；（2）testStatus：描述状态的字符串。这是一个 Ajax 事件。 function(data, textStatus){        //data可能是xmlDoc,jsonObj,html,text等        this; // 调用本次Ajax请求时传递的settings参数 }
error	Function	请求失败时调用的函数。 有以下三个参数：XMLHttpRequest 对象、错误信息、（可选）捕获的异常对象。 如果发生了错误，错误信息（第二个参数）除了得到 null 之外，还可能是 "timeout", "error", "notmodified" 和 "parsererror"。 这是一个 Ajax 事件。 function(XMLHttpRequest, textStatus, errorThrown){        //通常情况下textStatus和errorThrown只有其中一个包含信息        this; // 调用本次Ajax请求时传递的settings参数 }
contentType	String	发送信息至服务器时内容编码类型。内容编码类型默认为 "application/x-www-form-urlencoded"。该默认值适合大多数情况。如果你明确地传递了一个 content-type 给 $.ajax() 那么它必定会发送给服务器（即使没有数据要发送）。
dataFilter	Function	给 Ajax 返回的原始数据的进行预处理的函数。提供 data 和 type 两个参数：data 是 Ajax 返回的原始数据，type 是调用 jQuery.ajax 时提供的 dataType 参数。函数返回的值将由 jQuery 进一步处理。 function(data, type){        // 返回处理后的数据        return data; }
global	Boolean	是否触发全局 AJAX 事件。默认值为true。设置为 false 将不会触发全局 AJAX 事件，例如 ajaxStart 或 ajaxStop 可用于控制各种 Ajax 事件。
ifModified	Boolean	仅在服务器数据改变时获取新数据。使用 HTTP 包 Last-Modified 头信息判断。默认值为false，即忽略头信息。在 jQuery 1.4 中，它也会检查服务器指定的 'etag' 来确定数据没有被修改过。
jsonp	String	在一个 jsonp 请求中重写回调函数的名字。这个值用来替代在 "callback=?" 这种 GET 或 POST 请求中 URL 参数里的 "callback" 部分，比如 {jsonp:'onJsonPLoad'} 会导致将 "onJsonPLoad=?" 传给服务器。
username	String	用于响应 HTTP 访问认证请求的用户名。
password	String	用于响应 HTTP 访问认证请求的密码。
processData	Boolean	默认为true。默认情况下，发送的数据将被转换为对象（从技术角度来讲并非字符串），以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息，请设置为 false。
scriptCharset	String	只有当请求时 dataType 为 "jsonp" 或 "script"，并且 type 是 "GET" 才会用于强制修改 charset。通常只在本地和远程的内容编码不同时使用。
context	Object	这个对象用于设置 Ajax 相关回调函数的上下文。也就是说，让回调函数内 this 指向这个对象（如果不设定这个参数，那么 this 就指向调用本次 AJAX 请求时传递的 settings 参数）。比如指定一个 DOM 元素作为 context 参数，这样就设置了 success 回调函数的上下文为这个 DOM 元素。 就像这样： $.ajax({ url: "test.html", context: document.body, success: function(){        $(this).addClass("done"); }});
jsonpCallback	String	为 jsonp 请求指定一个回调函数名。这个值将用来取代 jQuery 自动生成的随机函数名。这主要用来让 jQuery 生成独特的函数名，这样管理请求更容易，也能方便地提供回调函数和错误处理。你也可以在想让浏览器缓存 GET 请求的时候，指定这个回调函数名。
traditional	Boolean	如果你想要用传统的方式来序列化数据，那么就设置为 true。请参考工具分类下面的 jQuery.param 方法。
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 对象，以及一个包含成功或错误代码的字符串。

 

关于服务器端返回数据类型

 

$.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() 可以在请求完成前挂起请求。

 

示例：$.ajax()代替$.getScript()方法

 

$(function(){

       $('#send').click(function(){

              $.ajax({

                     type: "GET",

                     url: "test.js",

                     dataType: "script"

              });

       });

});

 

示例：$.ajax()代替$.getJSON()方法

 

$(function(){

       $('#send').click(function(){

              $.ajax({

                     type: "GET",

                     url: "test.js",

                     dataType: "json",

                     success: function(data){

                            $('#resText').empty();

                            var html='';

                            $.each(data, function(commentIndex, comment){

                                   html+='<div class="comment"><h6>'

                                   +comment['username']+':</h6><p class="para">'

                                   +comment['content']+'</p></div>';

                            });

                            $('#resText').html(html);

                     }

              });

       });

});