使用jQuery在失败时重试AJAX请求的最佳方法是什么?


107

伪代码:

$(document).ajaxError(function(e, xhr, options, error) {
  xhr.retry()
})

更好的是某种指数补偿


1
我不确定这是否是最好的方法,所以只是一个注释,但是如果您从tries函数中调用ajax,则可以为其指定一个参数,如果失败,则可以使用调用函数tries+1。停止执行tries==3或任何其他编号。
Nanne 2012年


Answers:


238

像这样:


$.ajax({
    url : 'someurl',
    type : 'POST',
    data :  ....,   
    tryCount : 0,
    retryLimit : 3,
    success : function(json) {
        //do something
    },
    error : function(xhr, textStatus, errorThrown ) {
        if (textStatus == 'timeout') {
            this.tryCount++;
            if (this.tryCount <= this.retryLimit) {
                //try again
                $.ajax(this);
                return;
            }            
            return;
        }
        if (xhr.status == 500) {
            //handle error
        } else {
            //handle error
        }
    }
});

12
我已经采用@Sudhir的解决方案,并在以下github上创建了$ .retryAjax插件:github.com/mberkom/jQuery.retryAjax
Michael Berkompas 2012年

2
这对我不起作用。this.tryCount在有条件的始终是1
user304602

2
@MichaelBerkompas-您的插件仍然有效吗?它在2年内未收到承诺。
Hendrik 2014年

2
如果将另一个回调处理程序.success附加到调用返回此ajax请求的函数上,将可以正常工作吗?
ProblemsSuSumit

17
tryCountretryLimit过多。考虑只使用1个变量:this.retryLimit--; if (this.retryLimit) { ... $.ajax(this) ... }
vladkras

15

一种方法是使用包装函数:

(function runAjax(retries, delay){
  delay = delay || 1000;
  $.ajax({
    type        : 'GET',
    url         : '',
    dataType    : 'json',
    contentType : 'application/json'
  })
  .fail(function(){
    console.log(retries); // prrint retry count
    retries > 0 && setTimeout(function(){
        runAjax(--retries);
    },delay);
  })
})(3, 100);

另一种方法是retries$.ajax

// define ajax settings
var ajaxSettings = {
  type        : 'GET',
  url         : '',
  dataType    : 'json',
  contentType : 'application/json',
  retries     : 3  //                 <-----------------------
};

// run initial ajax
$.ajax(ajaxSettings).fail(onFail)

// on fail, retry by creating a new Ajax deferred
function onFail(){
  if( ajaxSettings.retries-- > 0 )
    setTimeout(function(){
        $.ajax(ajaxSettings).fail(onFail);
    }, 1000);
}

另一种方法(GIST)-覆盖原始$.ajax格式(对DRY更好)

// enhance the original "$.ajax" with a retry mechanism 
$.ajax = (($oldAjax) => {
  // on fail, retry by creating a new Ajax deferred
  function check(a,b,c){
    var shouldRetry = b != 'success' && b != 'parsererror';
    if( shouldRetry && --this.retries > 0 )
      setTimeout(() => { $.ajax(this) }, this.retryInterval || 100);
  }

  return settings => $oldAjax(settings).always(check)
})($.ajax);



// now we can use the "retries" property if we need to retry on fail
$.ajax({
    type          : 'GET',
    url           : 'http://www.whatever123.gov',
    timeout       : 2000,
    retries       : 3,     //       <-------- Optional
    retryInterval : 2000   //       <-------- Optional
})
// Problem: "fail" will only be called once, and not for each retry
.fail(()=>{
  console.log('failed') 
});

需要考虑的一点是,要确保$.ajax方法以前没有包装过,以避免同一代码重复运行两次。


您可以按原样将这些摘要复制粘贴到控制台以对其进行测试


感谢您的脚本。它可以与$ .ajaxSetup一起使用吗?
SevbanÖztürk18年

@SevbanÖztürk-你是什么意思?只是尝试:)
vsync

感谢您教我如何构造包装器!这击败了我以前实现的旧的递归函数设计。
解码器7283年

7

我在下面的代码中取得了很多成功(例如:http : //jsfiddle.net/uZSFK/

$.ajaxSetup({
    timeout: 3000, 
    retryAfter:7000
});

function func( param ){
    $.ajax( 'http://www.example.com/' )
        .success( function() {
            console.log( 'Ajax request worked' );
        })
        .error(function() {
            console.log( 'Ajax request failed...' );
            setTimeout ( function(){ func( param ) }, $.ajaxSetup().retryAfter );
        });
}

4
我建议的唯一更改是用function(){func(param)}替换'func(“'+ param”'“)'这样,您可以直接传递参数而无需将其转换为字符串然后返回,这很容易失败!
fabspro

@fabspro完成。谢谢!
Nabil Kadimi 2015年

7
这不是一个无限循环吗?鉴于问题有一个retryLimit,并且显然是想满足服务器永不回来的要求……我认为这确实必须存在
PandaWood

3
jQuery.ajaxSetup()说明:为将来的Ajax请求设置默认值。不建议使用它。api.jquery.com/jQuery.ajaxSetup
blub

2

如果有人.done()在其ajax 调用之后进行调用,则这些答案均无效,因为您将没有成功方法来附加到将来的回叫。因此,如果有人这样做:

$.ajax({...someoptions...}).done(mySuccessFunc);

然后mySuccessFunc不会在重试中被调用。这是我的解决方案,它是从@cjpak 此处的答案中大量借用的。就我而言,我想在AWS的API网关响应502错误时重试。

const RETRY_WAIT = [10 * 1000, 5 * 1000, 2 * 1000];

// This is what tells JQuery to retry $.ajax requests
// Ideas for this borrowed from https://stackoverflow.com/a/12446363/491553
$.ajaxPrefilter(function(opts, originalOpts, jqXHR) {
  if(opts.retryCount === undefined) {
    opts.retryCount = 3;
  }

  // Our own deferred object to handle done/fail callbacks
  let dfd = $.Deferred();

  // If the request works, return normally
  jqXHR.done(dfd.resolve);

  // If the request fails, retry a few times, yet still resolve
  jqXHR.fail((xhr, textStatus, errorThrown) => {
    console.log("Caught error: " + JSON.stringify(xhr) + ", textStatus: " + textStatus + ", errorThrown: " + errorThrown);
    if (xhr && xhr.readyState === 0 && xhr.status === 0 && xhr.statusText === "error") {
      // API Gateway gave up.  Let's retry.
      if (opts.retryCount-- > 0) {
        let retryWait = RETRY_WAIT[opts.retryCount];
        console.log("Retrying after waiting " + retryWait + " ms...");
        setTimeout(() => {
          // Retry with a copied originalOpts with retryCount.
          let newOpts = $.extend({}, originalOpts, {
            retryCount: opts.retryCount
          });
          $.ajax(newOpts).done(dfd.resolve);
        }, retryWait);
      } else {
        alert("Cannot reach the server.  Please check your internet connection and then try again.");
      }
    } else {
      defaultFailFunction(xhr, textStatus, errorThrown); // or you could call dfd.reject if your users call $.ajax().fail()
    }
  });

  // NOW override the jqXHR's promise functions with our deferred
  return dfd.promise(jqXHR);
});

此代码段将在2秒,5秒,10秒后退后重试,您可以通过修改RETRY_WAIT常量进行编辑。

AWS支持建议我们添加一个重试,因为它仅在蓝色月亮中对我们一次。


我发现这是到目前为止所有答案中最有用的。但是,最后一行禁止在TypeScript中进行编译。我认为您不应该从此函数返回任何内容。
房地美


0

这是对我异步加载库的方法:

var jqOnError = function(xhr, textStatus, errorThrown ) {
    if (typeof this.tryCount !== "number") {
      this.tryCount = 1;
    }
    if (textStatus === 'timeout') {
      if (this.tryCount < 3) {  /* hardcoded number */
        this.tryCount++;
        //try again
        $.ajax(this);
        return;
      }
      return;
    }
    if (xhr.status === 500) {
        //handle error
    } else {
        //handle error
    }
};

jQuery.loadScript = function (name, url, callback) {
  if(jQuery[name]){
    callback;
  } else {
    jQuery.ajax({
      name: name,
      url: url,
      dataType: 'script',
      success: callback,
      async: true,
      timeout: 5000, /* hardcoded number (5 sec) */
      error : jqOnError
    });
  }
}

然后只需.load_script从您的应用程序调用并嵌套您的成功回调即可:

$.loadScript('maps', '//maps.google.com/maps/api/js?v=3.23&libraries=geometry&libraries=places&language=&hl=&region=', function(){
    initialize_map();
    loadListeners();
});

0

DemoUsers的答案不适用于Zepto,因为错误功能中的此指向Windows。(而且,使用“ this”的这种方式不够安全,因为您不知道它们如何实现ajax或无需实现。)

对于Zepto,也许您可​​以尝试以下操作,直到现在它对我来说都很有效:

var AjaxRetry = function(retryLimit) {
  this.retryLimit = typeof retryLimit === 'number' ? retryLimit : 0;
  this.tryCount = 0;
  this.params = null;
};
AjaxRetry.prototype.request = function(params, errorCallback) {
  this.tryCount = 0;
  var self = this;
  params.error = function(xhr, textStatus, error) {
    if (textStatus === 'timeout') {
      self.tryCount ++;
      if (self.tryCount <= self.retryLimit) {
        $.ajax(self.params)      
        return;
      }
    }
    errorCallback && errorCallback(xhr, textStatus, error);
  };
  this.params = params;
  $.ajax(this.params);
};
//send an ajax request
new AjaxRetry(2).request(params, function(){});

使用构造函数来确保请求是可重入的!


0

您的代码几乎已满:)

const counter = 0;
$(document).ajaxSuccess(function ( event, xhr, settings ) {
    counter = 0;
}).ajaxError(function ( event, jqxhr, settings, thrownError ) {
    if (counter === 0 /*any thing else you want to check ie && jqxhr.status === 401*/) {
        ++counter;
        $.ajax(settings);
    }
});
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.