$.ajax()方法详解

本文介绍: jquery中的ajax 方法参数总是记不住，这里记录一下。要求为Str in g 类型的参数，（默认为当前页地址）发送请求的地址。

jquery中的ajax 方法参数总是记不住，这里记录一下。

1.url

要求为Str in g 类型的参数，（默认为当前页地址）发送请求的地址。

2.type

要求为Str in g 类型的参数，请求方式（post或get）默认为g e t。注意其他http 请求方法，例如 put和delete也可以使用，但仅部分浏览器支持。

3.timeout

要求为Numb e r 类型的参数，设置请求超时时间（毫秒）。此设置将覆盖$.ajaxSe t up()方法的全局设置。

4.async

要求为Bo ol e a n 类型的参数，默认设置为true，所有请求均为异步请求。如果需要发送同步请求，请将此选项设置为false。注意，同步请求将锁住浏览器，用户其他操作必须等待请求完成才可以执行。

5.cache

要求为Boole a n 类型的参数，默认为true（当dataTy pe为script时，默认为false），设置为false将不会从浏览器缓存中加载请求信息。

6.data

要求为Obje ct或Str in g 类型的参数，发送到服务器的数据。如果已经不是字符串，将自动转换为字符串格式。get请求中将附加在url后。防止这种自动转换，可以查看　　 processData选项。对象必须为key/value 格式，例如{foo1:”b ar1″,foo2:”b ar2″}转换为&foo1=b ar1&foo2=b ar2。如果是数组，JQue ry将自动为不同值对应同一个名称。例如{foo:[“b ar1″,”b ar2″]}转换为&foo=b ar1&foo=b ar2。

7.dataTy pe

要求为Str ing类型的参数，预期服务器返回的数据类型。

如果不指定，JQue ry将自动根据http包m i m e 信息返回 responseXML或responseText，并作为回调函数参数传递。可用的类型如下：xml：返回XML文档，可用JQue ry 处理。html：返回纯文本HTML信息；包含的script 标签会在插入DOM时执行。script：返回纯文本JavaScri pt代码。不会自动缓存结果。除非设置了cache参数。注意在远程请求时（不在同一个域下），所有post请求都将转为get请求。json：返回JSON数据。jsonp：JSONP格式。使用SONP形式调用函数时，例如my url?callback=?，JQue ry将自动替换后一个“?”为正确的函数名，以执行回调函数。text：返回纯文本字符串。

8.beforeSend

要求为Function类型的参数，发送请求前可以修改XMLHttpReque st对象的函数，例如添加自定义HTTP头。在beforeSend中如果返回false 可以取消本次ajax请求。XMLHttpReque st对象是惟一的参数。

function(XMLHttpRequest){ 
           this; //调用本次ajax请求时传递的options参数 
         }

9.complete

要求为Function类型的参数，请求完成后调用的回调函数（请求成功或失败时均调用）。参数：XMLHttpReque st对象和一个描述成功请求类型的字符串。

function(XMLHttpReque st, textStatus){ th i s; //调用本次ajax请求时传递的options参数 }

10.success

要求为Function类型的参数，请求成功后调用的回调函数，有两个参数。 (1)由服务器返回，并根据dataTy pe参数进行处理后的数据。 (2)描述状态的字符串。

function(data, textStatus){ 
                            //data可能是xmlDoc、jsonObj、html、text等等 this;

                         //调用本次ajax请求时传递的options参数

             }

11.error

要求为Function类型的参数，请求失败时被调用的函数。该函数有3个参数，即XMLHttpRequest对象、错误信息、捕获的错误对象(可选)。ajax 事件函数如下：

function(XMLHttpRequest, textStatus, errorThrown){

             //通常情况下textStatus和errorThrown只有其中一个包含信息 this; 

            //调用本次ajax请求时传递的options参数 

                            }

12.contentTy pe

要求为String类型的参数，当发送信息至服务器时，内容编码类型默认为”application/x–www–form–urlencode d“。该默认值适合大多数应用场合。

13.dataFilte r

要求为Fun ct ion类型的参数，给Aja x返回的原始数据进行预处理的函数。提供data和type 两个参数。data是Ajax返回的原始数据，type是调用jQuery.ajax时提供的dataTy pe参数。函数返回的值将由jQuery进一步处理。

function(data, type){ 

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

14.dataFilte r

要求为Fun c ti on类型的参数，给Ajax返回的原始数据进行预处理的函数。提供data和type 两个参数。data是Ajax返回的原始数据，type是调用jQuery.ajax时提供的dataType参数。函数返回的值将由jQuery进一步处理。

     function(data, type){
                //返回处理后的数据
                return data;
            }

15.global

要求为Boolean类型的参数，默认为true。表示是否触发全局 ajax 事件。设置为false将不会触发全局 ajax 事件，ajaxStart或ajaxStop可用于控制各种ajax 事件。

16.ifModified

要求为Boolean类型的参数，默认为false。仅在服务器数据改变时获取新数据。服务器数据改变判断的依据是Last-Modified头信息。默认值是false，即忽略头信息。

17.jsonp

要求为String类型的参数，在一个jsonp请求中重写回调函数的名字。该值用来替代在”callback=?”这种GET或POST请求中URL参数里的”callback“部分，例如{jsonp:’onJsonPLoad‘}会导致将”onJsonPLoad=?”传给服务器。

18.username

要求为String类型的参数，用于响应HTTP访问认证请求的用户名。

19.password

要求为String类型的参数，用于响应HTTP访问认证请求的密码。

20.processData

要求为Boolean类型的参数，默认为true。默认情况下，发送的数据将被转换为对象（从技术角度来讲并非字符串）以配合默认内容类型”ap pli cation/x-www–form–urlencoded”。如果要发送DOM树信息或者其他不希望转换的信息，请设置为fa lse。

21.scriptCharset

要求为String类型的参数，只有当请求时dataType为”js onp”或者”script“，并且type是GET时才会用于强制修改字符集(charset)。通常在本地和远程的内容编码不同时使用。

案例代码：

$(function(){
    $('#send').click(function(){
         $.ajax({
             type: "GET",
             url: "test.json",
             data: {username:$("#username").val(), content:$("#content").val()},
             dataType: "json",
             success: function(data){
                         $('#resText').empty();   //清空resText里面的所有内容
                         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);
                      }
         });
    });
});

顺便说一下$.each()函数

$.each()函数不同于JQuery对象的each()方法，它是一个全局函数，不操作JQuery对象，而是以一个数组或者对象作为第1个参数，以一个回调函数作为第2个参数。回调函数拥有两个参数：第1个为对象的成员或数组的索引，第2个为对应变量或内容。

附上 ajax() 模板

//ajax模板

    $.ajax({
        url: '',
        type: 'post',
        data: JSON.stringify(),
        contentType:"application/json;charset=utf-8",
        success: function (data) {
            if (data) {
                //请求成功
            } else {
                alert(data.msg);
            }
        },
        error: function () {
            //alert("");
        }
    });