Guava Retrying模塊使用場景

在web應(yīng)用中，由于網(wǎng)絡(luò)原因或其他不可預(yù)測的原因，應(yīng)用間會出現(xiàn)調(diào)用失敗的情形，通過配置重試策略可以有效解決外在原因?qū)е碌南到y(tǒng)故障。

使用場景

1. 微服務(wù)間各個(gè)服務(wù)模塊間的調(diào)用
2. 第三方模塊遠(yuǎn)程交易調(diào)用
3. 非業(yè)務(wù)異常導(dǎo)致可能失敗的情況

示例

構(gòu)建Retryer

private Retryer retryer = RetryerBuilder.newBuilder()
        .retryIfException() // 異常時(shí)重試
        .retryIfResult(input - > input!=null && input instanceof Boolean && !Boolean.valueOf((Boolean) input)) // 返回值為false時(shí)重試
        // 對應(yīng)Future獲取超時(shí)時(shí)間
        .withAttemptTimeLimiter(AttemptTimeLimiters.fixedTimeLimit(4, TimeUnit.SECONDS,Executors.newFixedThreadPool(2))) //重試次數(shù)限制
        .withRetryListener(new RetryListener() { // 重試執(zhí)行邏輯
            @Override
            public < V > void onRetry(Attempt< V > attempt) {
                log.info("onRetry - > 重試次數(shù)：{}，距第一次重試時(shí)長：{}", attempt.getAttemptNumber(),attempt.getDelaySinceFirstAttempt());
                if(attempt.hasException()){ // 是否異常導(dǎo)致重試
                    Throwable exception = attempt.getExceptionCause(); // 執(zhí)行的異常
                    log.info("異常：{}", exception);
                }
                if(attempt.hasResult()){ // 是否有返回
                    V result = attempt.getResult();
                    log.info("返回：{}",result);
                }
            }
        })
        // 控制每次重試間隔時(shí)間，如果AttemptTimeLimiter設(shè)置多線程
        .withWaitStrategy(WaitStrategies.fixedWait(3,TimeUnit.SECONDS)) // 等待策略
        .withBlockStrategy(BlockStrategies.threadSleepStrategy()) // 阻塞策略
        //
        .withStopStrategy(StopStrategies.stopAfterAttempt(5)) // 停止策略
        .build();

使用Retryer讓業(yè)務(wù)代碼擁有重試能力

前兩次執(zhí)行時(shí)模擬返回false，則會執(zhí)行重試；當(dāng)?shù)?次時(shí)，正常執(zhí)行業(yè)務(wù)代碼并返回true，結(jié)束重試

@Test
public void retryWhenResult() throws ExecutionException, RetryException {
   retryer.call(() - > {
       if(counter.incrementAndGet() == 3){// 模擬前2此返回false，觸發(fā)重試
           log.info(" 執(zhí)行業(yè)務(wù)代碼：{}次",counter.get());
           return true;
       }
       return false; 
   });
}

模擬前3次出現(xiàn)異常，則會執(zhí)行重試；當(dāng)?shù)?次時(shí)，正常執(zhí)行業(yè)務(wù)代碼，結(jié)束重試

@Test
public void retryWhenException() throws ExecutionException, RetryException {
    retryer.call(() - > {
        if( counter.getAndIncrement() == 3 ){// 模擬前5此出現(xiàn)異常，觸發(fā)重試
            return counter;
        }
        log.info(" 執(zhí)行業(yè)務(wù)代碼: {}次", counter.get());
         throw new RuntimeException("ERROR"); 
    });
}

模擬前5此出現(xiàn)異常，由于Retryer配置重試次數(shù)為5，則最終業(yè)務(wù)代碼不會執(zhí)行

@Test
public void retryWhenResultOnFailure() throws ExecutionException, RetryException {
    retryer.call(() - > {
        if(counter.incrementAndGet() == 8){// 模擬前7此返回false，由于配置重試5次，因此最終失敗
            log.info(" 執(zhí)行業(yè)務(wù)代碼：{}次",counter.get());
            return true;
        }
        return false;
    });
}

執(zhí)行流程

執(zhí)行流程

通過RetryerBuilder構(gòu)建Retryer，調(diào)用Retryer#call，封裝業(yè)務(wù)代碼為其回調(diào)函數(shù)

1. 開始循環(huán)執(zhí)行
2. 由AttemptTimeLimiter#call執(zhí)行回調(diào)函數(shù)
3. 將結(jié)果封裝為Attempt，包括兩種類型ResultAttempt，ExceptionAttempt。如果成功，記錄執(zhí)行結(jié)果、持續(xù)時(shí)長；如果失敗，記錄異常、持續(xù)時(shí)長
4. 執(zhí)行監(jiān)聽RetyrListener#onRetry，可以配置多個(gè)監(jiān)聽
5. 執(zhí)行拒絕斷言Predicate，根據(jù)返回值、執(zhí)行異常、返回異常類型判斷是否終止重試
6. 如果滿足條件，則繼續(xù)重試；否則結(jié)束重試，并返回Attempt包含回調(diào)結(jié)果
7. 根據(jù)終止策略StopStrategy判斷是否終止重試
8. 根據(jù)等待策略WaitStrategy獲取等待時(shí)長
9. 根據(jù)阻塞策略BlockStrategy與上一步等待時(shí)長阻塞重試，如果出現(xiàn)異常則拋出RetryException
10. 重復(fù)執(zhí)行以上邏輯

配置

構(gòu)建Retryer主要通過RetryerBuilder.newBuilder()實(shí)現(xiàn)，其相關(guān)配置如下：

注意

1. AttemptTimeLimiter中的FixedAttemptTimeLimit依賴于guava中的SimpleTimeLimiter，但是在guava高版本中該類已經(jīng)成了私有類

總結(jié)

Guava Retrying模塊能夠通過簡單的將代碼實(shí)現(xiàn)業(yè)務(wù)邏輯重試的功能，并且其配置中包含了重試的次數(shù)、時(shí)長控制、重試阻塞、終止策略等等， 在項(xiàng)目中是非常常用的一項(xiàng)技術(shù)。