在我们的开发中,api 接口调用异常是经常会遇到的,任何接口都会有不同概率的异常情况,对于可以重入的接口,为了避免偶发性异常造成的服务的不可用,重试机制就非常有必要了.Guava-Retryiny 是一个非常灵活的重试组件,包含多种重试策略,扩展很方便。
com.github.rholder
guava-retrying
2.0.0
在这个包中,最重要的类就是 Retryer,只要我们通过一定的策略创建出 Retryer 对象,通过调用 Retryer 对象的 call 方法,即可按照既定策略执行参数中传入的 Callable 接口的 call 方法。这里重试的方法需要包装到Callable接口当中, 方法很多的话使用起来稍有不便,优化方式可以使用AOP的方式来使用Retry。
Retryer 提供了构造方法,用来创建一个指定规则的 Retryer:这个方法可以通过传入尝试时间策略、停止重试策略、重试间隔等待策略、重试阻塞策略、拒绝策略等策略来指定一个请求的重试如何进行
Retryer(@Nonnull AttemptTimeLimiter attemptTimeLimiter,
@Nonnull StopStrategy stopStrategy,
@Nonnull WaitStrategy waitStrategy,
@Nonnull BlockStrategy blockStrategy,
@Nonnull Predicate> rejectionPredicate,
@Nonnull Collection listeners)
public interface AttemptTimeLimiter {
V call(Callable var1) throws Exception;
}
这个接口主要是用来控制每次重试的超时时间
通常来说,我们会通过 AttemptTimeLimiters 类来创建这个接口的实现
AttemptTimeLimiters 就是一个生产 AttemptTimeLimiter 实现的工厂类,主要的方法有三个:
public static AttemptTimeLimiter noTimeLimit()
public static AttemptTimeLimiter fixedTimeLimit(long duration,
@Nonnull TimeUnit timeUnit)
public static AttemptTimeLimiter fixedTimeLimit(long duration,
@Nonnull TimeUnit timeUnit, @Nonnull ExecutorService executorService)
两个方法通过 duration 和 timeUnit 组合实现了对调用的接口实现总的超时控制
public interface StopStrategy {
boolean shouldStop(Attempt var1);
}
这个接口中只有一个方法,顾名思义,他就是用来判断是否应该停止重试
他传入了 Attempt 为参数,通过这个参数,我们可以获取到方法的返回值、抛出的异常、重试的次数等等
public interface Attempt {
V get() throws ExecutionException;
boolean hasResult();
boolean hasException();
V getResult() throws IllegalStateException;
Throwable getExceptionCause() throws IllegalStateException;
long getAttemptNumber();
long getDelaySinceFirstAttempt();
}
StopStrategys
我们也可以通过 StopStrategys 来生产 StopStrategy 对象它提供了三个 static 方法:
public static StopStrategy neverStop()
public static StopStrategy stopAfterAttempt(int attemptNumber)
public static StopStrategy stopAfterDelay(long duration, @Nonnull TimeUnit timeUnit)
public interface WaitStrategy {
long computeSleepTime(Attempt var1);
}
WaitStrategy 接口只包含一个方法,顾名思义,就是间隔的时长
同样的,我们也可以使用 WaitStrategies 类来生产 WaitStrategy,WaitStrategies 提供了非常强大而丰富的 static 方法
public static WaitStrategy noWait()
public static WaitStrategy fixedWait(long sleepTime, @Nonnull TimeUnit timeUnit)
public static WaitStrategy randomWait(long maximumTime, @Nonnull TimeUnit timeUnit);
public static WaitStrategy randomWait(long minimumTime, @Nonnull TimeUnit
minimumTimeUnit, long maximumTime, @Nonnull TimeUnit maximumTimeUnit);
public static WaitStrategy incrementingWait(long initialSleepTime,
@Nonnull TimeUnit initialSleepTimeUnit, long increment, @Nonnull
TimeUnit incrementTimeUnit)
这个方法设置了初始间隔和递增步长
public static WaitStrategy exponentialWait();
public static WaitStrategy exponentialWait(long maximumTime, @Nonnull
TimeUnit maximumTimeUnit);
public static WaitStrategy exponentialWait(long multiplier, long
maximumTime, @Nonnull TimeUnit maximumTimeUnit);
public static WaitStrategy fibonacciWait();
public static WaitStrategy fibonacciWait(long maximumTime, @Nonnull
TimeUnit maximumTimeUnit);
public static WaitStrategy fibonacciWait(long multiplier, long maximumTime
, @Nonnull TimeUnit maximumTimeUnit);
public static WaitStrategy exceptionWait(@Nonnull
Class exceptionClass, @Nonnull Function function)
他是 WaitStrategies 中最复杂的一个策略了,一旦上一次尝试抛出了 exceptionClass 及其子类的异常,则调用回调方法 function,以其返回值作为下一次尝试前的时间间隔
public static WaitStrategy join(WaitStrategy... waitStrategies)
public interface BlockStrategy {
void block(long var1) throws InterruptedException;
}
这个策略指定了线程在本次尝试后 sleep 多少毫秒
BlockStrategies 可以方便的创建 BlockStrategy
他只提供了一个 static 方法,一旦指定,则线程会在间隔时间内 sleep,否则不会
public static BlockStrategy threadSleepStrategy()
@FunctionalInterface
@GwtCompatible
public interface Predicate extends java.util.function.Predicate {
@CanIgnoreReturnValue
boolean apply(@Nullable T var1);
boolean equals(@Nullable Object var1);
default boolean test(@Nullable T input) {
return this.apply(input);
}
}
Predicate 接口最重要的方法是 apply 方法,返回是否需要拒绝尝试,与 AttemptTimeLimiters 类似,Predicate 通常用 Predicates 来创建
Predicates 提供了非常丰富的 static 方法集合,可以实现各种各样的断言,甚至是断言的与或非组合
public static Predicate alwaysFalse();
public static Predicate isNull();
public static Predicate notNull();
public static Predicate not(Predicate predicate);
public static Predicate and(Iterable extends Predicate super T
>> components);
public static Predicate and(Predicate... components);
public static Predicate and(Predicate super T> first, Predicate
super T> second);
public static Predicate or(Iterable extends Predicate super T
>> components);
public static Predicate or(Predicate... components);
public static Predicate or(Predicate super T> first, Predicate
super T> second);
public static Predicate equalTo(@NullableDecl T target);
public static Predicate
上面提到,Retryer 具有 call 方法,只要设置好重试策略,将相应方法封装为 Callable 接口的实现,传入 Retryer 的 call 方法,即可按照预定的重试策略调用对应的方法
但是,如果我们的方法不是直接执行,而是需要放入线程池中呢?Retryer 提供了 wrap 接口实现将方法的重试策略封装到一个 Callable 实现中,从而让我们可以直接通过线程池调用:
public Retryer.RetryerCallable wrap(Callable callable)
由于 Retryer 类构造方法参数较多,较为复杂,而使用 RetryerBuilder 要更加简洁明了,也是更加常用的方式.如下:
Retryer retryer = RetryerBuilder.newBuilder()
// 如果Callable结果为null,继续重试
.retryIfResult(Predicates.isNull())
// IOException,继续重试
.retryIfExceptionOfType(IOException.class)
// RuntimeException,继续重试
.retryIfRuntimeException()
// 指定重试策略,重试三次后停止
.withStopStrategy(StopStrategies.stopAfterAttempt(3))
.build();