jquery里的 $.ajax 方法的作用是通过 HTTP 请求加载远程数据。该方法是 jQuery 底层 AJAX 实现。在该方法的基础上简化出来的一些方法还有 $.get, $.post, $.getJSON 等。由于工作中经常会用到 $.ajax 这个方法,现在特意将这个方法的一些常见用法做一些记录。
下面是一段比较常用到的 $.ajax 方法:
$.ajax({ type:'GET', url:'http://www.phpernote.com/jquery.php', data:{username:'phpernote',password:'123456'}, dataType:'json', timeout:3000, cache:false, async:true, beforeSend:function(){ alert('请求之前'); }, success:function(data){ alert('请求成功'); }, error:function(msg){ alert('请求发生错误'); } });
以上代码只使用到了比较常见的一些参数和处理函数,下面将 $.ajax 方法中所有的参数和函数异议列举下:
参数:
url 类型:String,默认值: 当前页地址。发送请求的地址。
type 类型:String,取值有 "POST" 或 "GET" 两种,默认为 "GET"。注意:其它 HTTP 请求方法,如 PUT 和 DELETE 也可以使用,但仅部分浏览器支持。
async 类型:Boolean,默认值为 true。默认设置下,所有请求均为异步请求(即在执行该ajax请求之时,不管该请求是否执行完毕,将继续执行下面的代码)。如果需要发送同步请求,请将此选项设置为 false。如果在需求中遇到一些处理代码在ajax请求之后,并且这些处理依赖于ajax的请求结果时,则在这个地方最好设置值为 false。注意,同步请求将锁住浏览器,用户其它操作必须等待请求完成才可以执行。
cache 类型:Boolean,默认值为 true,当参数 dataType 设置为 script 或 jsonp 时默认为 false。设置为 false 的情况下在多次请求时将不缓存上一次的请求数据。jQuery 1.2 新增加的功能。
contentType 类型:String,默认值: "application/x-www-form-urlencoded"。发送信息至服务器时内容编码类型,也可设置为 "application/json; charset=utf-8"。默认值适合大多数情况。如果你明确地传递了一个 content-type 给 $.ajax() 那么它必定会发送给服务器(即使没有数据要发送)。
data 类型:String,发送到服务器的数据。一般格式为{key1:value1,key2,value2},如果为数组,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": 返回纯文本字符串
ifModified 类型:Boolean,仅在服务器数据改变时获取新数据。默认值: false。使用 HTTP 包 Last-Modified 头信息判断。在 jQuery 1.4 中,它也会检查服务器指定的 'etag' 来确定数据没有被修改过。
timeout 类型:Number,设置请求超时时间(单位:毫秒)。此设置将覆盖全局设置。
global 类型:Boolean,是否触发全局 AJAX 事件。默认值: true。设置为 false 将不会触发全局 AJAX 事件,如 ajaxStart 或 ajaxStop 可用于控制不同的 Ajax 事件。
processData 类型:Boolean,默认值: true。默认情况下,通过data选项传递进来的数据,如果是一个对象(技术上讲只要不是字符串),都会处理转化成一个查询字符串,以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息,请设置为 false。
jsonpCallback 为 jsonp 请求指定一个回调函数名。这个值将用来取代 jQuery 自动生成的随机函数名。这主要用来让 jQuery 生成度独特的函数名,这样管理请求更容易,也能方便地提供回调函数和错误处理。你也可以在想让浏览器缓存 GET 请求的时候,指定这个回调函数名。
处理函数:
beforeSend(XMLHttpRequest) 发送请求前可修改 XMLHttpRequest 对象的函数,如添加自定义 HTTP 头。XMLHttpRequest 对象是唯一的参数。这是一个 Ajax 事件。如果返回 false 可以取消本次 ajax 请求。
complete(XHR,TS) 请求完成(不管是否成功)后回调函数。参数: XMLHttpRequest 对象和一个描述请求类型的字符串。
dataFilter 给 Ajax 返回的原始数据的进行预处理的函数。提供 data 和 type 两个参数:data 是 Ajax 返回的原始数据,type 是调用 jQuery.ajax 时提供的 dataType 参数。函数返回的值将由 jQuery 进一步处理。
error 默认值: 自动判断 (xml 或 html)。请求失败时将调用此函数。有以下三个参数:XMLHttpRequest 对象、错误信息、(可选)捕获的异常对象。如果发生了错误,错误信息(第二个参数)除了得到 null 之外,还可能是 "timeout", "error", "notmodified" 和 "parsererror"。
success 请求成功后的回调函数。参数:由服务器返回,并根据 dataType 参数进行处理后的数据;描述状态的字符串。
xhr 需要返回一个 XMLHttpRequest 对象。默认在 IE 下是 ActiveXObject 而其他情况下是 XMLHttpRequest 。用于重写或者提供一个增强的 XMLHttpRequest 对象。这个参数在 jQuery 1.3 以前不可用。
上面所介绍的一些参数并不是全部的参数,还有一些不常用的,由于工作中用到的不多就没有写进去。