jQueryを使用して失敗時にAJAXリクエストを再試行する最良の方法は何ですか?


107

疑似コード:

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

さらに良いのは、ある種の指数バックオフです


1
これが最善の方法であるかどうかはわかりません。ただコメントですが、機能からajaxを呼び出す場合は、パラメーターを指定triesできますtries+1。失敗した場合は、で関数を呼び出します。tries==3またはその他の番号で実行を停止します。
ナンヌ


ここニースソリューション:stackoverflow.com/questions/6298612/...
ジェレミーA.西

回答:


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

2
これは私のために働いていません。条件付きでthis.tryCountは常に1である
user304602

2
@MichaelBerkompas-プラグインはまだ機能しますか?2年間コミットされていません。
Hendrik

2
.successこのajaxリクエストを返す関数の呼び出しに別のようなコールバックハンドラーが接続されている場合、これは機能しますか?
ProblemsOfSumit

17
ペアtryCountとはretryLimit過剰です。唯一の1変数を使用することを検討してください:this.retryLimit--; if (this.retryLimit) { ... $.ajax(this) ... }
vladkras

15

1つの方法は、ラッパー関数を使用することです。

(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') 
});

考慮すべきポイントは、同じコードが2回実行されるのを避けるために、メソッドが以前にラップされていないこと確認すること$.ajaxです。


これらのスニペットを(現状のまま)コピーしてコンソールに貼り付け、テストすることができます


スクリプトをありがとう。$ .ajaxSetupで動作しますか?
SevbanÖztürk18年

@SevbanÖztürk-どういう意味ですか?:)を試してみてください
vsync

ラッパーの構造を教えてくれてありがとう!これは、私が実装するために使用した古い再帰関数設計に勝るものです。
デコーダー7283 2018

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
私が提案する唯一の変更は、 'func( "' + param" '")'をfunction(){func(param)}で置き換えることです。これにより、パラメーターを文字列に変換せずに直接渡すことができます。 、簡単に失敗する可能性があります!
fabspro

@fabspro完了。ありがとう!
Nabil Kadimi、2015

7
これは無限ループではありませんか?質問にretryLimitがあり、サーバーが戻らないことを明らかに望んでいることを考えると、これは本当にそこにある必要があると思います
PandaWood

3
jQuery.ajaxSetup()説明:将来のAjaxリクエストのデフォルト値を設定します。その使用は推奨されません。api.jquery.com/jQuery.ajaxSetup
ブラブ

2

.done()将来のコールバックに接続するための成功メソッドがないため、誰かがajaxコールの後にコールした場合、これらの回答はどれも機能しません。だから誰かがこれをすると:

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

その後mySuccessFunc、再試行時に呼び出されません。これが私の解決策です。これは@cjpakのここの回答から大いに借りられています。私の場合、AWSのAPI Gatewayが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のサポートでは、ブルームーンで1回しか発生しないため、再試行を追加することを提案しました。


これがこれまでのすべての回答の中で最も有用であることがわかりました。ただし、最後の行はTypeScriptでのコンパイルを防ぎます。この関数から何かを返すべきではないと思います。
フレディ

0

ここにこれのための小さなプラグインがあります:

https://github.com/execjosh/jquery-ajax-retry

自動インクリメントタイムアウトはそれに追加するとよいでしょう。

$ .ajaxシグネチャを使用して独自の関数を作成するだけでグローバルに使用するには、APIを再試行して、すべての$ .ajax呼び出しを新しい関数で置き換えます。

また、$。ajaxを直接置き換えることもできますが、その場合、再試行しないとxhr呼び出しを行うことができません。


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では機能しません。(そして、「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);
    }
});
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.