使用resilience4j实现优雅重试

子曰:小胜靠智,大胜靠德,常胜靠身体。
resilience4j是什么? Resilience4j 是受Netflix的Hysrix项目启发,专门为Java 8 和函数式编程设计的轻量级容错框架。Resilicenes4j 仅使用了一个第三方开源库Vavr,Vavr不依赖其他库。相比较而言,Netflix Hysrix对Archaius存在编译依赖,Archaius有许多外部依赖,比如Guava和Apache Commons Configuration。Resilience4j 按模块发布,可以有选择的使用其中某些功能而无需引入全部的Resilience4j 组件。Resilience4j源码托管在Github上。
Retry包括那些组件?
  • 重试配置(RetryConfig)
    RetryConfig类似spring-retry中的RetryPolicy和注解@Retryable,主要对重试的最大次数,重试的条件等进行配置,RetryConfig支持的参数及含义如下:
    • maxAttempts
      最大重试次数,如果在重试次数达到maxAttempts设置的值后依然无法成功结束, 调用线程或通过异步结果对象会得到失败结果。默认重试次数为3次。
    • intervalFunction
      获取重试间隔的function,为两次重试之间的时间间隔。
    • exceptionPredicate
      计算抛出的异常是否触发重试的谓词函数。
    • resultPredicate
      计算执行结果是否触发重发重试的谓词函数。
Resilience4j 提供工具类RetryConfig.Builder简化RetryConfig的设置。
  • 重试指标(Metrics)
    处理与重试相关的指标,指标项包括:成功次数(未重试)、失败次数(未重试)、成功次数(经过重试)和失败次数(经过重试)。
  • 重试上下文(Context)
    重试上下文,针对执行成功、执行结果、异常(Exception)和运行时异常(RuntimeException)执行对应的处理动作。
  • 事件机制
    • Event
      Resilience4j 针对重试提供四种事件:RETRY、ERROR、SUCCESS和IGNORED_ERROR;
    • EventPublisher
      事件发布器,主要负责将RETRY、ERROR、SUCCESS和IGNORED_ERROR四种事件通知对应的事件消费者。
    • EventConsumer
      事件消费者,对事件发布器发布的事件订阅并执行特定的处理逻辑。消费者需要实现一个事件消费接口:void consumeEvent(T event);
  • RetryRegistry
    创建存储Retry实例的工厂,目前Resilience4j 提供一个基于内存的实现。
  • Retry和AsyncRetry
    同步重试和异步重试,重试流程的入口。内部通过while -> true -> break逻辑实现重试。
代码示例 创建重试配置
RetryConfig config = RetryConfig.custom() .maxAttempts(5) .waitDuration(Duration.ofMillis(DEFAULT_WAIT_DURATION)) .retryExceptions(RetryNeedException.class) .ignoreExceptions(RetryNoNeedException.class) .retryOnException(throwable -> throwable instanceof RuntimeException) .retryOnResult(resp -> resp.toString().contains("result cause retry")) .build();

上面的重试配置支持最多5次重试,重试间隔为DEFAULT_WAIT_DURATION定义的毫秒数,RetryNeedException类型的异常触发重试,RetryNoNeedException异常不触发重试,如果反值包含result cause retry字符串触发重试。异步重试和同步重试的配置一样,并无差别。
同步重试
Retry retry = Retry.of("sync retry", config); private int executeTimes = 0; public void retryOnException() { Retry.decorateRunnable(retry, new Runnable() { @Override public void run() { if (executeTimes++ < 3) { throw RetryNeedException.defaultException(); } } }).run(); }

上面的代码实现了run()方法执行4次的效果,前三次执行抛出的异常触发重试,但是run()最终会执行成功。
异步重试 为了实现异步重试,需要提供线程池用于执行任务,在resilience4j使用的线程池为ScheduledExecutorService,可以根据自己的需要对线程池的参数进行定制。实现异步重试的代码样例如下:
实际的业务逻辑
private CompletionStage exceptionCauseRetry() { if (executeTimes.getAndIncrement() < 2) { throw new RetryNeedException("need retry"); } return CompletableFuture.completedFuture("async retry"); }

将实际的业务逻辑加入到重试框架
public Supplier asyncRetryOnException() { return AsyncRetry.decorateCompletionStage(asyncRetry, executor, () -> exceptionCauseRetry()); }

最后 【使用resilience4j实现优雅重试】resilience4j和spring-retry都可以实现业务逻辑的优雅重试,但是resilience4j更加轻量,而且可以针对执行结果触发重试逻辑,使用更加方便,也不用为jar冲突等问题而烦恼。以上样例的详细代码可以从Github上下载

    推荐阅读