描述: 在每个请求之前被发送和$.ajax()
处理它们前处理,设置自定义Ajax选项或修改现有选项。
-
添加的版本: 1.5jQuery.ajaxPrefilter( [dataTypes ], handler(options, originalOptions, jqXHR) )
注册一个典型使用$.ajaxPrefilter()
的预过滤器,看起来像这样:
1
2
3
|
$.ajaxPrefilter( function( options, originalOptions, jqXHR ) {
// Modify options, control originalOptions, store jqXHR, etc
});
|
以下的情况下:
-
options
是请求的选项 -
originalOptions
值作为提供给Ajax方法未经修改的选项,因此,没有ajaxSettings
设置中的默认值 -
jqXHR
是请求的jqXHR对象
当自定义选项,需要提前处理,预过滤器(Prefilters)是一个完美的选择。给定下面的代码, 例如,如果自定义abortOnRetry
选项被设置为true
,那么调用$.ajax()
会自动中止请求相同的URL:
1
2
3
4
5
6
7
8
9
10
|
var currentRequests = {};
$.ajaxPrefilter(function( options, originalOptions, jqXHR ) {
if ( options.abortOnRetry ) {
if ( currentRequests[ options.url ] ) {
currentRequests[ options.url ].abort();
}
currentRequests[ options.url ] = jqXHR;
}
});
|
预过滤器(Prefilters)也可以被用来修改已经存在的选项。例如,下面的代理服务器跨域请求http://mydomain.net/proxy/:
1
2
3
4
5
6
|
$.ajaxPrefilter( function( options ) {
if ( options.crossDomain ) {
options.url = "http://mydomain.net/proxy/" + encodeURIComponent( options.url );
options.crossDomain = false;
}
});
|
如果提供可选的dataTypes
参数,那么预滤器(prefilter)将只会对满足指定 dataTypes 的请求有效。例如, 以下仅适用于JSON和 script 请求给定的预过滤器:
1
2
3
|
$.ajaxPrefilter( "json script", function( options, originalOptions, jqXHR ) {
// Modify options, control originalOptions, store jqXHR, etc
});
|
$.ajaxPrefilter()
方法也可以将请求重定向到另一个数据类型,并且返回该数据类型。 例如,如果 URL 中含有在 isActuallyScript() 函数中设定的指定属性,那么设置成一个“script”的请求:
1
2
3
4
5
|
$.ajaxPrefilter(function( options ) {
if ( isActuallyScript( options.url ) ) {
return "script";
}
});
|
这将确保请求被认为是“script”类型的,而且也保证了所有对 script 数据类型有效的预前过滤器,也将被应用到它。
备注实例代码:
jQuery.ajaxPrefilter(function(settings) {
if (settings.type != "GET") {
var data = settings.data;
if (!data)
data = "";
if (data.length > 0)
data += "&";
data += "csrf_token=" + $("meta[name=csrf_token]").attr("content");
settings.data = data;
}
});