jqXHR对象

最新推荐文章于 2025-08-10 09:05:22 发布

转载最新推荐文章于 2025-08-10 09:05:22 发布 · 2.6k 阅读

----------JavaScript---------- 同时被 3 个专栏收录

58 篇文章

订阅专栏

jQuery

21 篇文章

订阅专栏

Ajax

7 篇文章

订阅专栏

原文链接：http://www.css88.com/jqapi-1.9/jQuery.ajax/

jqXHR 对象

从jQuery 1.5开始，$.ajax() 返回XMLHttpRequest（jqXHR）对象，该对象是浏览器的原生的XMLHttpRequest对象的一个超集。例如，它包含responseText和responseXML属性，以及一个getResponseHeader()方法。当传输机制不是是XMLHttpRequest时（例如，一个JSONP请求脚本，返回一个脚本 tag 时），jqXHR对象尽可能的模拟原生的XHR功能。

从jQuery 1.5.1开始， jqXHR对象还包含了overrideMimeType方法 (它在jQuery 1.4.x中是有效的，但是在jQuery 1.5中暂时的被移除)。.overrideMimeType() 方法可能用在beforeSend()的回调函数中，例如，修改响应的Content-Type信息头：

 
        $.ajax({
       
          url: "http://fiddle.jshell.net/favicon.png",
       
          beforeSend: function ( xhr ) {
       
            xhr.overrideMimeType("text/plain; charset=x-user-defined");
       
          }
       
        }).done(function ( data ) {
       
          if( console && console.log ) {
       
            console.log("Sample of data:", data.slice(0, 100));
       
          }
       
        });

从 jQuery 1.5 开始，$.ajax()返回的jqXHR对象实现了 Promise 接口, 使它拥有了 Promise 的所有属性，方法和行为。（见Deferred object获取更多信息）。为了让回调函数的名字统一，便于在$.ajax()中使用。jqXHR也提供.error() .success()和.complete()方法。这些方法都带有一个参数，该参数是一个函数，此函数在 $.ajax()请求结束时被调用,并且这个函数接收的参数，与调用 $.ajax()函数时的参数是一致。这将允许你在一次请求时，对多个回调函数进行赋值，甚至允许你在请求已经完成后，对回调函数进行赋值(如果该请求已经完成，则回调函数会被立刻调用)。

jqXHR.done(function(data, textStatus, jqXHR) {});
一个可供选择的 success 回调选项的构造函数，.done()方法取代了的过时的jqXHR.success()方法。请参阅deferred.done()的实现细节。
jqXHR.fail(function(jqXHR, textStatus, errorThrown) {});
一种可供选择的 error 回调选项的构造函数，.fail()方法取代了的过时的.error()方法。请参阅deferred.fail()的实现细节。
jqXHR.always(function(data|jqXHR, textStatus, jqXHR|errorThrown) { });
一种可供选择的 complete 回调选项的构造函数，.always()方法取代了的过时的.complete()方法。

在响应一个成功的请求后，该函数的参数和.done()的参数是相同的：data, textStatus, 和 jqXHR 对象.对于失败的请求，参数和.fail()的参数是相同的：jqXHR 对象, textStatus, 和 errorThrown。请参阅deferred.always()的实现细节。
jqXHR.then(function(data, textStatus, jqXHR) {}, function(jqXHR, textStatus, errorThrown) {});
包含了 .done() 和 .fail()方法的功能，（从 jQuery 1.8 开始）允许底层被操纵。请参阅deferred.then()的实现细节。

推荐使用的注意事项: jqXHR.success(), jqXHR.error(), 和 jqXHR.complete()回调从 jQuery 1.8开始被弃用。他们将最终被取消，您的代码应做好准备，使用jqXHR.done(), jqXHR.fail(), 和 jqXHR.always()代替。

 
        // Assign handlers immediately after making the request,
       
        // and remember the jqxhr object for this request
       
        var jqxhr = $.ajax( "example.php" )
       
            .done(function() { alert("success"); })
       
            .fail(function() { alert("error"); })
       
            .always(function() { alert("complete"); });
       
        // perform other work here ...
       
        // Set another completion function for the request above
       
        jqxhr.always(function() { alert("second complete"); });

this在所有的回调中的引用，是这个对象在传递给$.ajax的设置中上下文；如果没有指定context（上下文），this 引用的是Ajax设置的本身。

为了向后兼容XMLHttpRequest ，一jqXHR对象将公开下列属性和方法：

readyState
status
statusText
responseXML and/or responseText 当底层的请求分别作出XML和/或文本响应
setRequestHeader(name, value) 从标准出发，通过替换旧的值为新的值，而不是替换的新值到旧值
getAllResponseHeaders()
getResponseHeader()
abort()

假如没有onreadystatechange属性，因为不同的状态可以分别在 success ， error ， complete和statusCode 方法中进行处理。

Callback Function Queues（回调函数）

beforeSend, error, dataFilter, success 和 complete接受的回调函数是在合适的时间调用。

从jQuery 1.5开始， fail ， done ，和从jQuery 1.6开始的always回调钩子（hooks）采用先入先出队列管理。这意味着你可以为每个挂钩分配多个回调。见Deferred object methods ，这是实现内部的$.ajax()回调钩子（hooks）。

这里有$.ajax()提供的回调钩子（hooks），如下：

beforeSend 在发送请求之前调用，它接收jqXHR对象和settings作为参数对象。
error 在请求出错时调用。如果请求失败，在它们的顺序依次登记。他们接受jqXHR ，字符串表示的错误类型，以及异常对象（如果有的话）。一些内置的错误会将 "abort", "timeout", "No Transport" 等字符串作为异常对象。
dataFilter 在请求成功之后调用。传入返回的数据以及dataType参数的值。并且必须返回新的数据（可能是处理过的）传递给success回调函数。
success 当请求成功并接收到返回数据之后调用。传入返回后的数据，以及包含成功代码的字符串和jqXHR对象。
Promise callbacks — .done(), .fail(), .always(), and .then() — 根据他们注册的顺序被调用。
complete 请求完成时，无论是在失败或成功，它们按顺序依次执行回调。他们收到jqXHR对象，以及一个包含成功或错误代码。