欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  web前端

jQuery.ajaxPrefilter() 函数使用详解

程序员文章站 2022-06-06 10:21:15
...
jQuery.ajaxPrefilter()函数用于指定预先处理Ajax参数选项的回调函数

在所有参数选项被jQuery.ajax()函数处理之前,你可以使用该函数设置的回调函数来预先更改任何参数选项。

你还可以指定数据类型(dataType),从而只预先处理指定数据类型的参数选项。

该函数可以调用多次,以便于为不同数据类型的AJAX请求指定不同的回调函数。

该函数属于全局jQuery对象。

语法

jQuery 1.5 新增该静态函数。

jQuery.ajaxPrefilter( [ dataType ,] handler )

参数

dataType可选/String类型

一个或多个用空格隔开的数据类型所组成的字符串。如果未指定该参数,则表示所有数据类型。可用的数据类型为"xml"、 "html"、 "text"、 "json"、 "jsonp"、 "script"。该字符串为它们之间的任意组合(多种类型用空格隔开),例如:"xml"、 "text html"、 "script json jsonp"。

handlerFunction类型

用于预处理参数选项的回调函数。它有以下3个参数:

options:(Object对象)当前AJAX请求的所有参数选项。

originalOptions:(Object对象)传递给$.ajax()方法的未经修改的参数选项。

jqXHR:当前请求的jqXHR对象(经过jQuery封装的XMLHttpRequest对象)。

返回值

jQuery.ajaxPrefilter()函数没有返回值,或者说其返回值为undefined。

示例&说明

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

//设置AJAX的全局默认选项
$.ajaxSetup( {
    url: "/index.html" , // 默认URL
    aysnc: false , // 默认同步加载
    type: "POST" , // 默认使用POST方式
    headers: { // 默认添加请求头
        "Author": "CodePlayer" ,
        "Powered-By": "CodePlayer"
    } ,
    error: function(jqXHR, textStatus, errorMsg){ // 出错时默认的处理函数
        // 提示形如:发送AJAX请求到"/index.html"时出错[404]:Not Found
        alert( '发送AJAX请求到"' + this.url + '"时出错[' + jqXHR.status + ']:' + errorMsg );        
    }
} );
// 指定预处理参数选项的函数
$.ajaxPrefilter( function(options, originalOptions, jqXHR){
    // options对象 包括accepts、crossDomain、contentType、url、async、type、headers、error、dataType等许多参数选项
    // originalOptions对象 就是你为$.ajax()方法传递的参数对象,也就是 { url: "/index.php" }
    // jqXHR对象 就是经过jQuery封装的XMLHttpRequest对象(保留了其本身的属性和方法)
    options.type = "GET"; // 将请求方式改为GET
    options.headers = { }; // 清空自定义的请求头
});
// 执行AJAX请求
$.ajax( {
    url: "/index.php"
} );

jQuery.ajaxPrefilter()函数还可以只预处理指定数据类型(dataType)的AJAX请求的参数选项。jQuery代码如下所示:

//设置AJAX的全局默认选项
$.ajaxSetup( {
    url: "/index.html" , // 默认URL
    aysnc: false , // 默认同步加载
    type: "POST" , // 默认使用POST方式
    headers: { // 默认添加请求头
        "Author": "CodePlayer" ,
        "Powered-By": "CodePlayer"
    } ,
    error: function(jqXHR, textStatus, errorMsg){ // 出错时默认的处理函数
        // 提示形如:发送AJAX请求到"/index.html"时出错[404]:Not Found
        alert( '发送AJAX请求到"' + this.url + '"时出错[' + jqXHR.status + ']:' + errorMsg );        
    }
} );
// 指定预处理参数选项的函数,只预处理dataType为json或html类型的AJAX请求
$.ajaxPrefilter( "json html", function(options, originalOptions, jqXHR){
    // options对象 包括accepts、crossDomain、contentType、url、async、type、headers、error、dataType等许多参数选项
    // originalOptions对象 就是你为$.ajax()方法传递的参数对象,也就是 { url: "/index.php" }
    // jqXHR对象 就是经过jQuery封装的XMLHttpRequest对象(保留了其本身的属性和方法)
    if( options.data == null && options.type == "POST"){
        options.type = "GET"; // 将请求方式改为GET
        options.headers = { }; // 清空自定义的请求头             
    }
    
});
// 执行AJAX请求
$.ajax( {
    url: "/index.php"
} );
// 执行AJAX请求(该请求会被预处理)
$.ajax( {
    url: "action.php?type=json",
    dataType: "json"
} );

以上就是jQuery.ajaxPrefilter() 函数使用详解的详细内容,更多请关注其它相关文章!