ajax的20个参数 | AJAX的原理,使用,深入了解

时间:2021-04-28 17:31:52

AJAX = Asynchronous JavaScript and XML(异步的 JavaScript 和 XML)

 

 

一,ajax参数

 

1.url
要求为String类型的参数,(默认为当前页地址)发送请求的地址。

2.type
要求为String类型的参数,请求方式(post或get)默认为get。注意其他http请求方法,例如put和delete也可以使用,但仅部分浏览器支持。

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

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

5.cache
要求为Boolean类型的参数,默认为true(当dataType为script时,默认为false),设置为false将不会从浏览器缓存中加载请求信息。

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

7.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:返回纯文本字符串。

8.beforeSend
要求为Function类型的参数,发送请求前可以修改XMLHttpRequest对象的函数,例如添加自定义HTTP头。在beforeSend中如果返回false可以取消本次ajax请求。XMLHttpRequest对象是惟一的参数。
            function(XMLHttpRequest){
               this;   //调用本次ajax请求时传递的options参数
            }
9.complete
要求为Function类型的参数,请求完成后调用的回调函数(请求成功或失败时均调用)。参数:XMLHttpRequest对象和一个描述成功请求类型的字符串。
          function(XMLHttpRequest, textStatus){
             this;    //调用本次ajax请求时传递的options参数
          }

10.success:要求为Function类型的参数,请求成功后调用的回调函数,有两个参数。
         (1)由服务器返回,并根据dataType参数进行处理后的数据。
         (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.contentType
要求为String类型的参数,当发送信息至服务器时,内容编码类型默认为"application/x-www-form-urlencoded"。该默认值适合大多数应用场合。

13.dataFilter
要求为Function类型的参数,给Ajax返回的原始数据进行预处理的函数。提供data和type两个参数。data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataType参数。函数返回的值将由jQuery进一步处理。
            function(data, type){
                //返回处理后的数据
                return data;
            }

14.global

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

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

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

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

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

19.processData
要求为Boolean类型的参数,默认为true。默认情况下,发送的数据将被转换为对象(从技术角度来讲并非字符串)以配合默认内容类型"application/x-www-form-urlencoded"。如果要发送DOM树信息或者其他不希望转换的信息,请设置为false。

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

案例代码:

ajax的20个参数 | AJAX的原理,使用,深入了解
$(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);
                      }
         });
    });
});
ajax的20个参数 | AJAX的原理,使用,深入了解

 

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

 

 

 

二,全局ajax事件

 

必须当页面上存在任何ajax请求的时候都将触发这些特定的全局ajax处理函数。

如果在jQuery.ajaxSetup()中的global属性设置成true,那么这些全局函数将会在每一个ajax上面都触发,这正是默认值。

注意:

1.全局事件永远不会再跨域的脚本中运行,也不会再JSONP请求中运行。

2.在jQuery1.9以上,所有的全局ajax函数必须绑定扫到document上,也就是$(document).事件

 3.只有在$.ajax()亦或$.ajaxSetup()中的globle设置成true才能使用ajax全局函数,false将不能使用。

 

针对每一个请求(per request) 

$.ajaxComplete()

例子:

HTML代码:

<div class="trigger">Trigger</div>
<div class="result"></div>
<div class="log"></div>

jquery代码:

$( document ).ajaxComplete(function() {
    $( ".log" ).text( "Triggered ajaxComplete handler." );
});
$( ".trigger" ).click(function() {
  $( ".result" ).load( "ajax/test.html" );
});

当用户点击class=trigger的元素的时候,加载html文件,请求完成之后class=log元素上显示信息。

 

无论什么Ajax请求完成,都将触发ajaxComplete事件,所以,你可以如下进行判断

$( document ).ajaxComplete(function( event, xhr, settings ) {
  if ( settings.url === "ajax/test.html" ) {
    $( ".log" ).text( "Triggered ajaxComplete handler. The result is " +
      xhr.responseText );
  }
});

语法形式

$(document).ajaxComplete(function(event,xhr,options))
Parameter Description
function(event,xhr,options) 必须,指定当请求完成之后执行的函数
Additional parameters:
  • event - 事件对象event
  • xhr - XMLHttpRequest对象
  • options - 在AJAX request中使用的参数

 所以上面进行指定ajax判断的时候使用的setting,也就是ajax request传递的对象,其中含有url属性,如果传递的url和需要判断的指定的url一样,则进行处理。

$.ajaxError()

$(document).ajaxError(function(event,xhr,options,exc))
Parameter Description
function(event,xhr,options,exc) 必须,指定请求失败后运行的函数 
Additional parameters:
  • event - 事件对象event
  • xhr - XMLHttpRequest对象
  • options - 在ajax 请求时使用过得参数
  • exc - 错误对象

当ajaxError事件被触发的时候,不管ajax请求是否完成。

每次执行ajaxerror事件的时候,传递了event对象,jqXHR对象(jQuery1.5之前是XHR对象),和用于请求的settings对象。

当HTTP error发生,第四个参数(thownError)接受了HTTP的状态的文本部分,例如“Not Found”亦或“Internal Server Error”

to restrict the error callback to only handling events dealing with a particular URL:

ajaxSend()  

send()发送的时候发触发

ajaxSuccess()是请求成功时触发,注意和ajaxComplete不同的是,ajaxComplete是不管请求失败还是成功,只要完成了就执行。

 

针对一批请求

 

ajaxStart(),ajaxStop()

是针对文本中所有的ajax请求的,当第一个ajax请求发送时触发ajaxStart()事件,当最后一个ajax请求完成时,触发ajaxStop()事件,不同的是,ajaxSend()和ajaxComplete是针对文本中每一次的ajax请求的。

所以如果你在文本中一次使用了3个请求,ajaxStart()会在第一个请求发起时触发,ajaxStop()会在最后一个请求结束时触发,所以它们常常组合用于显示loading等待框等。因为他们处理的是一群ajax请求,所以它们的回调函数中没有任何参数

.ajaxStart( handler() )
.ajaxStop( handler() )

 

 

 

 

三,跨域请求JSONP

ajax请求不允许跨域

跨域请求数据的时候,

可以使用JSONP的形式

 

形似于请求一段script

 

<script>

事先在本页面定义的回调函数(

XX数据

)

</script>

 

只能用get方法发送jsonp请求,因为jsonp请求和请求img,请求script的过程是一样的