您的浏览器过于古老 & 陈旧。为了更好的访问体验, 请 升级你的浏览器
Ready 发布于2014年09月09日 09:27

原创 jQuery.ajaxSuccess() 函数详解

154 次浏览 读完需要≈ 10 分钟

内容目录

ajaxSuccess()函数用于设置当AJAX请求成功完成时执行的回调函数

这是一个全局AJAX事件函数,用于为任何AJAX请求的ajaxSuccess事件绑定事件处理函数。当AJAX请求成功完成时(不包括失败的情况,例如:找不到页面、服务器内部错误等),将触发ajaxSuccess事件,并执行绑定的事件处理函数。

该函数必须在jQuery对象实例上调用,ajaxSuccess()将为每个匹配元素的ajaxSuccess事件绑定处理函数。当AJAX请求成功完成后,所有匹配元素上的处理函数都将被触发执行。事件处理函数内的this将指向当前DOM元素。

你可以在同一元素多次调用该函数,从而绑定多个事件处理函数。触发ajaxSuccess事件时,jQuery会按照绑定的先后顺序依次执行绑定的事件处理函数。

jQuery 1.8开始,该函数只能document对象的ajaxSuccess事件绑定处理函数,为其他元素绑定的事件处理函数不会起作用。

如果在jQuery.ajax()jQuery.ajaxSetup()中将选项参数global设为false,可以禁止该AJAX请求触发全局的AJAX事件。

该函数属于jQuery对象(实例)。

语法

jQuery 1.0 新增该函数。

jQueryObject.ajaxSuccess( handler )

参数

参数 描述
handler Function类型触发该事件时,需要执行的事件处理函数。

回调函数handler有4个参数:其一是表示当前事件的Event对象,其二是发送当前AJAX请求的jqXHR对象,其三是包含为本次AJAX请求设置的所有参数选项(包括无需指定的默认参数选项)的Object对象,其四是当前AJAX请求返回的数据。

jqXHR对象就是经过jQuery封装的类似XMLHttpRequest的对象。

返回值

ajaxSuccess()函数的返回值为jQuery类型,返回当前jQuery对象本身。

示例&说明

请参考以下HTML示例代码:

<div id="content1">CodePlayer</div>
<div id="content2">专注于编程开发技术分享</div>
<div id="content3">https://codeplayer.vip</div>

以下是与ajaxSuccess()函数相关的jQuery示例代码,以演示ajaxSuccess()函数的具体用法:

以下代码请基于1.8之前版本的jQuery来运行(请注意,通过ajaxSuccess()设置的全局事件处理函数与通过$.ajax()success选项设置的局部事件处理函数,它们的参数是不同的)。

//当前 jQuery版本:1.7.2 (必须是1.8之前的版本)

$("div").ajaxSuccess( function(event, jqXHR, options, data){
	alert("处理函数1: 当前元素的id为" + this.id + ",请求的url为" + options.url);
} );

$("div").ajaxSuccess( function(event, jqXHR, options, data){
	alert("处理函数2:请求方式为" + options.type + ",返回的数据是" + data);
} );


// 执行该AJAX请求,会弹出6次对话框
// 因为当前页面有3个div元素,我们为每个div元素绑定了2个事件处理函数
$.ajax( {
	url: "index.html"
} );


// 执行该AJAX请求,会弹出7次对话框
// 因为$.ajax()自己通过success选项绑定了一个局部的ajaxSuccess事件处理函数,它会执行一次
// 当前页面还有3个div元素,我们为每个div元素绑定了2个事件处理函数
// 因此总共弹出7次对话框
$.ajax( {
	url: "myurl" ,
	success: function(data, textStatus, jqXHR){
		// data 是返回的数据
		// textStatus 可能为"success"、"notmodified"等
		// jqXHR 是经过jQuery封装的XMLHttpRequest对象
        
		alert( "success!" );
	}
} );

如果当前jQuery为1.8及以上版本,上述jQuery代码总共只会弹出一次对话框。因为从jQuery 1.8开始,ajaxSuccess事件的处理函数必须绑定到document对象上才能生效。

因此,不论当前jQuery为何版本,如果不是特殊需求,我们都应该将ajaxSuccess事件的处理函数绑定到document对象上。

$(document).ajaxSuccess( function(event, jqXHR, options, data){
	alert("处理函数1:请求的url为" + options.url);
} );

$(document).ajaxSuccess( function(event, jqXHR, options, data){
	alert("处理函数2:请求方式为" + options.type);
} );


// 执行该AJAX请求,会弹出2次对话框
// 因为document对象上绑定了2个事件处理函数
$.ajax( {
	url: "index.html"
// 	, global: false // 可以禁止触发全局的Ajax事件
} );


// 执行该AJAX请求,会弹出3次对话框
// 因为$.ajax()自己通过success选项绑定了一个局部的ajaxSuccess事件处理函数,它会执行一次
// 我们还通过ajaxSuccess()额外绑定了两个事件处理函数,会再弹出2次
$.ajax( {
	url: "myurl" ,
	success: function(data, jqXHR, textStatus){
		// data 是返回的数据
		// textStatus 可能为"success"、"notmodified"等
		// jqXHR 是经过jQuery封装的XMLHttpRequest对象

		alert( "success" );
	}
	//, global: false // 可以禁止触发全局的Ajax事件
} );
  • CodePlayer技术交流群1
  • CodePlayer技术交流群2

0 条评论

撰写评论

打开导航菜单