ajax 方法的使用以及方法中各参数的含义

由于近来经常在项目中使用 ajax 这个函数，在工作之余自己查找了相关的资料，并总结了 ajax 方法的使用，以及方法中各个参数的含义，供大家学习参考使用

 

type: 要求为String类型的参数，请求方式（post或get）默认为get。注意其他http请求方法，例如put和

      delete也可以使用，但仅部分浏览器支持。

timeout: 要求为Number类型的参数，设置请求超时时间（毫秒）。此设置将覆盖$.ajaxSetup()方法的全局设

         置。

async：要求为Boolean类型的参数，默认设置为true，所有请求均为异步请求。

       如果需要发送同步请求，请将此选项设置为false。注意，同步请求将锁住浏览器，用户其他操作必须等

       待请求完成才可以执行。

cache：要求为Boolean类型的参数，默认为true（当dataType为script时，默认为false）。

       设置为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

          信息返回responseXML或responseText，并作为回调函数参数传递。

          可用的类型如下：

          xml：返回XML文档，可用JQuery处理。

          html：返回纯文本HTML信息；包含的script标签会在插入DOM时执行。

          script：返回纯文本JavaScript代码。不会自动缓存结果。除非设置了cache参数。注意在远程请求

                  时（不在同一个域下），所有post请求都将转为get请求。

          json：返回JSON数据。

          jsonp：JSONP格式。使用SONP形式调用函数时，例如myurl?callback=?，JQuery将自动替换后一个

                “?”为正确的函数名，以执行回调函数。

          text：返回纯文本字符串。

beforeSend：要求为Function类型的参数，发送请求前可以修改XMLHttpRequest对象的函数，例如添加自定义

            HTTP头。在beforeSend中如果返回false可以取消本次ajax请求。XMLHttpRequest对象是惟一的参

            数。

            function(XMLHttpRequest){

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

            }

complete：要求为Function类型的参数，请求完成后调用的回调函数（请求成功或失败时均调用）。

          参数：XMLHttpRequest对象和一个描述成功请求类型的字符串。

          function(XMLHttpRequest, textStatus){

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

          }

success：要求为Function类型的参数，请求成功后调用的回调函数，有两个参数。

         (1)由服务器返回，并根据dataType参数进行处理后的数据。

         (2)描述状态的字符串。

         function(data, textStatus){

            //data可能是xmlDoc、jsonObj、html、text等等

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

error：要求为Function类型的参数，请求失败时被调用的函数。该函数有3个参数，即XMLHttpRequest对象、错

       误信息、捕获的错误对象(可选)。

       ajax事件函数如下：

       function(XMLHttpRequest, textStatus, errorThrown){

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

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

       }

contentType：要求为String类型的参数，当发送信息至服务器时，内容编码类型默认

             为"application/x-www-form-urlencoded"。该默认值适合大多数应用场合。

dataFilter：要求为Function类型的参数，给Ajax返回的原始数据进行预处理的函数。

            提供data和type两个参数。data是Ajax返回的原始数据，type是调用jQuery.ajax时提供的

            dataType参数。函数返回的值将由jQuery进一步处理。

            function(data, type){

                //返回处理后的数据

                return data;

            }

global：要求为Boolean类型的参数，默认为true。表示是否触发全局ajax事件。设置为false将不会触发全局

        ajax事件，ajaxStart或ajaxStop可用于控制各种ajax事件。

ifModified：要求为Boolean类型的参数，默认为false。仅在服务器数据改变时获取新数据。

            服务器数据改变判断的依据是Last-Modified头信息。默认值是false，即忽略头信息。

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)。通常在本地和远程的内容编码不同时使用。

 

示例代码：

 $.ajax({
           type: "get", // 发送的请求类型 GET ， POST ， 默认 get

           url: "/help/index?prtid=" + obj, // 发送请求的地址

           timeout: "", // 请求超时时间  毫秒

           async: true, //  请求是异步还是同步 ，  默认异步 true 

           cache: true, // 默认 true, 当dataType为script时，默认为false 设置为false将不会从浏览器缓存中加载请求信息

           dataType: "", // 返回类型：  xml ， html , script ， json,， text 、

            complete:  function() {},  // 请求完成后调用此函数

            data: obj, // 参数  get 请求: Response.Querystring[""]   post 请求： Response.QueryForm[""]
           // 要求为Object或String类型的参数，发送到服务器的数据。如果已经不是字符串，将自动转换为字符串 式。get请求中将附加在url
	   后。防止这种自动转换，可以查看processData选项。对象必须为key/value格式，例如{foo1:"bar1",foo2:"bar2"}转换为
	   &foo1=bar1&foo2=bar2。如果是数组，JQuery将自动为不同 值对应同一个名称。例如{foo:["bar1","bar2"]}转换为
	   &foo=bar1&foo=bar2。


            success: function () {
                alert("success ");
            }, // 请求成功后，调用的函数

            error: function(){
                alert("error");
            },  // 请求失败时，调用的函数


            contentType: "",// 信息发送至服务器时， 内容编码类型， 默认 "application/x-www-form-urlencoded"，该默认适合大多数应用
	    场合

           global: true, // 是否触发全局ajax 事件 默认 true
           
           ifModified: false, // 仅在服务器数据改变时， 获取数据

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

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

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

           processData: true , //默认true ， 发送的数据将会被转换成对象，并非字符串， 以配合默认编码类
	   型"application/x-www-form-urlencoded" ，"。如果要发送DOM  树信息或者其他不希望转换的信息，请设置为false。

           scriptCharset: ""  //只有当请求时dataType为"jsonp"或者"script"，并且type是GET时  才会用于强制修改字符集(charset)。通常
	   在本地和远程的内容编码不同时使用


        });

另外：   $.get(
	    url, 
	    data, 
	    success,
	    dataType
   ) 

   等价于
  $.ajax({
	  url: url,
	  data: data,
	  success: success,
	  dataType: dataType
});

 

 

 

另附： $.each()函数:

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