ajaxComplete()函数用于设置当AJAX请求完成(无论成功或失败)时执行的回调函数。
这是一个全局AJAX事件函数,用于为所有AJAX请求的ajaxComplete事件绑定事件处理函数。当AJAX请求完成(无论成功或失败)时,将触发ajaxComplete事件,并执行绑定的事件处理函数。
该函数必须在jQuery对象实例上调用,ajaxComplete()将为每个匹配元素的ajaxComplete事件绑定处理函数。当AJAX请求完成后,所有匹配元素上的处理函数都将被触发执行。事件处理函数内的this将指向当前DOM元素。
你可以在同一元素多次调用该函数,从而绑定多个事件处理函数。触发ajaxComplete事件时,jQuery会按照绑定的先后顺序依次执行绑定的事件处理函数。
从jQuery 1.8开始,该函数只能为document对象的ajaxComplete事件绑定处理函数,为其他元素绑定的事件处理函数不会起作用。
如果在jQuery.ajax()或jQuery.ajaxSetup()中将选项参数global设为false,可以禁止该AJAX请求触发全局的AJAX事件。
该函数属于jQuery对象(实例)。
语法
jQuery 1.0 新增该函数。
jQueryObject.ajaxComplete( handler )
参数
参数 描述
handler Function类型触发该事件时,需要执行的事件处理函数。
回调函数handler有3个参数:其一是表示当前事件的Event对象,其二是发送当前AJAX请求的jqXHR对象,其三是包含为本次AJAX请求设置的所有参数选项(包括无需指定的默认参数选项)的Object对象。
jqXHR对象是经过jQuery封装的类似XMLHttpRequest的对象。
返回值
ajaxComplete()函数的返回值为jQuery类型,返回当前jQuery对象本身。
示例&说明
请参考以下HTML示例代码:
<div id="content1">CodePlayer</div> <div id="content2">专注于编程开发技术分享</div> <div id="content3">http://www.365mini.com</div>
以下是与ajaxComplete()函数相关的jQuery示例代码,以演示ajaxComplete()函数的具体用法:
以下代码请基于1.8之前版本的jQuery来运行(请注意,通过ajaxComplete()设置的事件处理函数与通过$.ajax()的complete选项设置的回调函数,它们的参数是不同的)。
// 当前 jQuery版本:1.7.2 (必须是1.8之前的版本) $("div").ajaxComplete( function(event, jqXHR, options){ alert("处理函数1: 当前元素的id为" + this.id + ",请求的url为" + options.url); } ); $("div").ajaxComplete( function(event, jqXHR, options){ alert("处理函数2:请求方式为" + options.type); } ); // 执行该AJAX请求,会弹出6次对话框 // 因为当前页面有3个div元素,我们为每个div元素绑定了2个事件处理函数 $.ajax( { url: "index.html" } ); // 执行该AJAX请求,会弹出7次对话框 // 因为$.ajax()自己通过complete选项绑定了一个ajaxComplete事件处理函数,这个事件处理函数是绑定在document上的,document只有一个,因此只执行一次 // 当前页面还有3个div元素,我们为每个div元素绑定了2个事件处理函数 // 因此总共弹出7次对话框 $.ajax( { url: "myurl" , complete: function(jqXHR, textStatus){ // jqXHR 是经过jQuery封装的XMLHttpRequest对象 // textStatus 可能为:null、'success'、 'notmodified'、 'error'、 'timeout'、 'abort'或'parsererror'等 alert( "ajax()" ); } } );
如果当前jQuery为1.8及以上版本,上述jQuery代码总共只会弹出一次对话框。因为从jQuery 1.8开始,ajaxComplete事件的处理函数必须绑定到document对象上才能生效。
因此,不论当前jQuery为何版本,如果不是特殊需求,我们都应该将ajaxComplete事件的处理函数绑定到document对象上。
$(document).ajaxComplete( function(event, jqXHR, options){ alert("处理函数1:请求的url为" + options.url); } ); $(document).ajaxComplete( function(event, jqXHR, options){ alert("处理函数2:请求方式为" + options.type); } ); // 执行该AJAX请求,会弹出2次对话框 // 因为document对象上绑定了2个事件处理函数 $.ajax( { url: "index.html" // , global: false // 可以禁止触发全局的Ajax事件 } ); // 执行该AJAX请求,会弹出3次对话框 // 因为$.ajax()自己通过complete选项绑定了一个局部的ajaxComplete事件处理函数,它也在document对象上,会执行一次 // 我们还通过ajaxComplete()额外绑定了两个事件处理函数,会再弹出2次 $.ajax( { url: "myurl" , complete: function(jqXHR, textStatus){ // jqXHR 是经过jQuery封装的XMLHttpRequest对象 // textStatus 可能为:null、'success'、 'notmodified'、 'error'、 'timeout'、 'abort'或'parsererror'等 alert( "ajax()" ); } // , global: false // 可以禁止触发全局的Ajax事件 } );
以上是jQuery.ajaxComplete() 函数使用详解的详细内容。更多信息请关注PHP中文网其他相关文章!