Jquery jqXHR对象的属性和方法

在 jQuery 1.4 之前(包括1.4),$.ajax() 方法返回的是浏览器原生的 XMLHttpRequest 对象。

 

从 jQuery 1.5 开始,$.ajax() 方法返回 jQuery 自己的 XMLHttpRequest 对象(一般简称jqXHR)。之所以这样做,是因为 jQuery 1.5 引入了延迟对象 jQuery.Deferred,以便于更好地处理和执行回调函数。

 

你可以简单地理解为 jqXHR 对象是 jQuery 自己伪造的一个 XMLHttpRequest 对象和 $.Deferred 对象的结合体。

 

jqXHR是浏览器原生 XMLHttpRequest 对象的超集。例如,它也包含 responseText 和 responseXML 属性,以及 getResponseHeader() 方法。

当传输机制与 XMLHttpRequest 对象不同时(例如,用一个 <script> 标签来完成 JSONP 请求),jqXHR对象会尽可能地模拟本地 XMLHttpRequest 对象的功能。

 

从jQuery 1.5.1开始,jqXHR对象也支持 overrideMimeType() 方法(它在 1.4.x 中也可用,但在 1.5 中被临时移除)。overrideMimeType() 方法可用于 beforeSend() 的回调函数中,比如用来修改 Content-Type 响应头。

 

从jQuery 1.5开始,$.ajax() 返回的 jqXHR 对象实现了 Promise 接口,包括其所有的属性、方法和行为。因此,我们通过 jqXHR 可以非常简单地为本次 $.ajax() 绑定 AJAX 请求对应状态执行的回调函数。

我们通过解剖一个完整的 jqXHR 对象,来了解 jqXHR 对象的属性和方法:

var jqXHR = {
    abort: function (statusText){
        // 取消请求,关闭连接                
    },
    always: function (){
        // 设置请求完成(无论成功或失败)时需要执行的一个或多个回调函数
    },
    complete: function (){
        // always()函数的别名,设置请求完成(无论成功或失败)时需要执行的一个或多个回调函数
    },
    done: function (){
        // 设置请求成功时需要执行的一个或多个回调函数
    },
    error: function (){
        // fail()函数的别名,设置请求失败时需要执行的一个或多个回调函数
    },
    fail: function (){
        // 设置请求失败时需要执行的一个或多个回调函数                
    },
    getAllResponseHeaders: function (){
        // 获取响应头信息的原始字符串        
    },
    getResponseHeader: function (key){
        // 获取响应头中指定名称的值     
    },
    overrideMimeType: function (type){
        // 重写 Content-Type 响应头       
    },
    pipe: function (){
        // then() 函数的别名,分别设置请求成功、失败、正在进行时需要执行的回调函数           
    },
    progress: function (){
        // 设置 Deferred 对象生成进度通知时需要执行的回调函数
    },
    promise: function (obj){
        // 为指定对象追加 Promise 对象的成员,以充当 Promise 对象 
    },
    readyState: 4, // 请求的状态
    responseText: "<!DOCTYPE html><html>......</html>", // 响应的文本内容
    setRequestHeader: function (name, value){
        // 设置请求头
    },
    state: function (){
        // 确定一个 Deferred 对象的当前状态,例如:"pending"、"resolved"、"rejected"               
    },
    status: 200,
    statusCode: function (map){     
        // 设置响应指定状态码需要执行的回调函数
        // map形如:{ 301:function(){}, 404:function(){} }     
    },
    statusText: "OK", // 状态响应头中的描述文本
    success: function (){
        // done()函数的别名,设置请求成功时需要执行的一个或多个回调函数
    },
    then: function (){
        // 分别设置请求成功、失败、正在进行时需要执行的回调函数               
    }
};

 

前面已经说了,我们通过 jqXHR 可以非常简单地为本次 $.ajax() 绑定 AJAX 请求对应状态执行的回调函数。

而 $.ajax() 方法执行完后会返回一个 jqXHR 对象。因为,我们其实大可以不在 $.ajax() 方法的参数中指定回调,转而使用链式写法,通过 jqXHR 对象的各个方法来指定回调。

像 $.get(),$.post() 这一类对 $.ajax() 进行了再封装的方法,方法本身的参数不支持设置 error 等回调,那么我们就可以用上面所说的方法来达到此目的。

//例1
$.ajax({
  url: ‘/some.js‘,
  type: ‘get‘,
dataType: ‘script‘
}).success(function () { //... }).error(function () { //... })
//例2
$.get(‘/some.js‘, function () {
  //...
}, ‘script‘).error(function () {
  //...
})

 

郑重声明:本站内容如果来自互联网及其他传播媒体,其版权均属原媒体及文章作者所有。转载目的在于传递更多信息及用于网络分享,并不代表本站赞同其观点和对其真实性负责,也不构成任何其他建议。