重试

大家都知道老三是做跨境业务的,在跨境业务中,可能第三方的服务器分布在世界的各个角落,所以请求三方接口的时候,难免会遇到一些网络问题,这时候需要加入重试机制了,这期就给大家分享几个接口重试的写法。

重试机制实现

notion image
8种重试机制实现

1. 循环重试

这是最简单也最直接的一种方式。在请求接口的代码块中加入循环,如果请求失败则继续请求,直到请求成功或达到最大重试次数。
示例代码:
这段简单的示例代码里,直接用了一个for循环来进行重试,最大重试次数设置为3次。同时在发生异常的时候,为了避免频繁请求,使用Thread.sleep()加一个适当的延迟。

2. 使用递归结构

除了循环,还可以使用递归来实现接口的请求重试。递归是我们都比较熟悉的编程技巧,在请求接口的方法中调用自身,如果请求失败则继续调用,直到请求成功或达到最大重试次数。
示例代码:
这段代码里,我们定义了一个名为requestWithRetry的方法,其中retryTimes表示最大重试次数。如果重试次数小于等于0,则直接返回。否则,在捕获到异常后,我们使用Thread.sleep()方法来添加一个适当的延迟,然后调用自身进行重试。

3.使用网络工具的内置重试机制

我们常用的一些HTTP客户端通常内置了一些重试机制,只需要在创建对应的客户端实例的时候进行配置即可,以Apache HttpClient为例:
  • 4.5+版本:使用 HttpClients.custom().setRetryHandler() 方法来设置重试机制
  • 5.x版本:使用HttpClients.custom().setRetryStrategy()方法来设置重试机制
在上面的示例代码中,我们使用DefaultHttpRequestRetryHandlerDefaultHttpRequestRetryStrategy来创建一个重试机制,最大重试次数为3次。如果请求失败,则会自动重试。
Apache HttpClient还支持自定义重试策略,可以可以实现HttpRequestRetryHandler接口(4.5+版本)或者RetryStrategy接口(5.x版本),并根据需要进行重试逻辑的实现。
这是一个自定义重试策略的示例:

4.使用Spring Retry库

当在Spring项目中使用重试机制时,可以使用Spring Retry库来实现。Spring Retry提供了一组注解和工具类,可以方便地为方法添加重试功能。
Spring Retry的使用有两种方式,一种是使用RetryTemplate来显式调用需要重试的方法,一种实用注解来自动触发重试。

显式使用RetryTemplate

  1. 创建RetryTemplate对象并配置重试策略:
在代码里,我们创建了一个RetryTemplate对象,并配置了重试策略和重试间隔策略。这里使用了SimpleRetryPolicy来指定最大重试次数为3次,使用FixedBackOffPolicy来指定重试间隔为1秒。
  1. 使用RetryTemplate调用方法:
代码里,我们使用retryTemplate.execute()方法来执行需要重试的代码块。在RetryCallbackdoWithRetry()方法中,可以编写需要重试的逻辑。如果方法执行失败,RetryTemplate会根据配置的重试策略和重试间隔策略进行重试。
Spring Retry是一个提供重试机制的库,可以方便地在Spring项目中使用。使用@Retryable注解标记需要重试的方法,如果方法抛出异常则会自动重试。
Spring Retry提供了多种重试策略和重试间隔策略,我们可以根据具体的业务需求选择合适的策略:
  • 重试策略:
    • SimpleRetryPolicy:指定最大重试次数。
    • TimeoutRetryPolicy:指定最大重试时间。
    • AlwaysRetryPolicy:无条件进行重试。
  • 重试间隔策略:
    • FixedBackOffPolicy:固定间隔重试。
    • ExponentialBackOffPolicy:指数递增间隔重试。
    • UniformRandomBackOffPolicy:随机间隔重试。
通过配置不同的重试策略和重试间隔策略,可以灵活地控制重试行为。Spring Retry还提供了自定义重试策略和重试间隔策略,可以通过实现RetryPolicy 接口和BackOffPolicy 接口,分别实现自定义的重试策略和重试间隔策略。

使用注解调用

除了显式使用RetryTemplate调用,Spring Retry还提供了注解方式来触发重试。
  1. 配置重试切面:
代码里,我们使用@Configuration注解将类标记为配置类,使用@EnableRetry注解启用重试功能。
  1. 使用@Retryable注解标记需要重试的方法:
我们使用@Retryable注解标记了request()方法,指定了最大重试次数为3次。
  1. 调用被标记的方法:
在SpringBoot项目里使用更加地简单,使用@EnableRetry注解启用Spring Retry功能,并在需要进行重试的方法上添加@Retryable注解。
示例代码:
代码里,@EnableRetry注解启用了Spring Retry功能,@Retryable注解标记了需要进行重试的方法,并指定了重试的异常类型、最大重试次数和重试间隔。
其中,@Backoff注解用于指定重试间隔策略,delay属性表示每次重试之间的间隔时间。在这个例子中,每次重试之间的间隔时间为1秒。
需要注意的是,@Retryable注解只能标记在public方法上。如果需要在非public方法上使用重试功能,可以使用代理模式实现。
另外,如果需要在重试过程中进行一些特定的操作,比如记录日志、发送消息等,可以在重试方法中使用RetryContext参数,它提供了一些有用的方法来获取重试的上下文信息。例如:

5.使用Resilience4j库

Resilience4j是一个轻量级的,易于使用的容错库,提供了重试、熔断、限流等多种机制。
我们来看下Resilience4j的使用,Resilience4j也支持代码显式调用和注解配置调用。

通过代码显式调用

  1. 创建创建一个RetryRegistry对象:
    1. 首先,需要创建一个RetryRegistry对象,用于管理Retry实例。可以使用RetryRegistry.ofDefaults()方法创建一个默认的RetryRegistry对象。
  1. 配置Retry实例:
    1. 接下来,可以通过RetryRegistry对象创建和配置Retry实例。可以使用RetryConfig类来自定义Retry的配置,包括最大重试次数、重试间隔等。
通过以上代码,我们创建了一个名为"name"的Retry实例,并配置了最大重试次数为3次,重试间隔为1秒,当返回结果的状态码为500时进行重试,当抛出WebServiceException异常时进行重试,忽略BusinessException和OtherBusinessException异常,达到最大重试次数后抛出MaxRetriesExceededException异常。
  1. 使用Retry调用:
    1. 最后,可以使用Retry来装饰和执行需要进行重试的代码块。比如,可以使用Retry.decorateCheckedSupplier()方法来装饰一个需要重试的Supplier。

通过注解调用

通过注解的方式,使用Resilience4j来使用重试功能,更加简洁。
在Spring Boot项目中,可以使用@Retryable注解来标记需要进行重试的方法。
代码里,@Retryable注解标记了doSomething()方法,指定了重试的异常类型为MyException.class,最大重试次数为3次,重试间隔为1秒。

6.自定义重试工具类

如果说我们不想在项目里额外地引入一些重试的框架,自己定义一个重试工具类也是可以的,这是我在某个第三方提供的client-sdk里发现的一套重试工具类,比较轻量级,给大家分享一下。
  • 首先,定义一个实现了Callback抽象类的具体回调类,实现其中的doProcess()方法来执行需要重试的逻辑。回调类的doProcess()方法返回一个RetryResult对象,表示重试的结果。
    • 然后,定义一个RetryResult类,用于封装重试的结果。RetryResult类包含一个isRetry属性表示是否需要进行重试,以及一个obj属性表示重试的结果对象。
      • 最后,定义一个RetryExecutor类,其中的execute()方法接收一个重试次数和一个回调对象,根据重试次数循环执行回调对象的doProcess()方法,直到达到最大重试次数或回调对象返回不需要重试的结果。
        • 使用这个自定义的重试工具类时,只需要实现一个继承自Callback的回调类,并在其中实现具体的重试逻辑。然后,通过调用RetryExecutor.execute()方法来执行重试操作。这里直接用了一个匿名的实现:

          7.并发框架异步重试

          在有些需要快速响应的场景下,我们可以使用并发框架,来实现异步的重试。
          比如使用线程池ThreadPoolExecutor,把请求接口转化成一个异步任务,将任务放入线程池中异步执行,并发地重试请求接口。可以在任务执行完成后,判断任务执行结果,如果失败则继续重试。
          在这个示例中,我们直接使用ThreadPoolExecutor来创建线程池,设置核心线程数和最大线程数为10,使用LinkedBlockingQueue作为任务队列。然后,我们定义了一个Callable类型的任务,用于执行请求接口的代码。在重试的过程中,我们使用executor.submit(task)提交任务并获得一个Future对象,通过future.get()获取任务的执行结果。如果任务执行成功,则跳出循环;如果任务执行失败,则继续重试,直到达到最大重试次数。

          8. 消息队列重试

          在某些情况下,我们希望尽可能保证重试的可靠性,不会因为服务中断,而导致重试任务的丢失,我们可以引入消息队列。我们直接把消息投递到消息队列里,通过对消息的消费,来实现重试机制。
          使用RocketMQ的示例代码如下:
          上面的代码里,我们使用@RocketMQMessageListener注解标记MyConsumer类,并指定了消费者的相关配置,包括消费者组和订阅的主题。
          onMessage()方法中,我们处理请求的逻辑。如果请求失败,我们创建一个RocketMQ的生产者,并将请求重新发送到消息队列中,等待下一次处理。
          通过使用消息队列(如RocketMQ)来实现重试机制,可以提高系统的可靠性和稳定性。即使在服务中断的情况下,重试任务也不会丢失,而是等待服务恢复后再次进行处理。

          最佳实践和注意事项

          在请求重试的时候,我们也要注意一些关键点,以免因为重试,引发更多的问题:
          • 合理设置重试次数和重试间隔时间,避免频繁地发送请求,同时也不要设置过大的重试次数,以免影响系统的性能和响应时间。
          • 考虑接口幂等性:如果请求是写操作,而且下游的服务不保证请求的幂等性,那么在重试时需要谨慎处理,可以通过查询等幂等的方式进行重试
          • 在重试过程中,需要考虑并发的问题。如果多个线程同时进行重试,可能会导致请求重复发送或请求顺序混乱等问题。可以使用锁或者分布式锁来解决并发问题。
          • 在处理异常时,需要根据具体的异常类型来进行处理。有些异常是可以通过重试来解决的,例如网络超时、连接异常等;而有些异常则需要进行特殊的处理,例如数据库异常、文件读写异常等。
          • 在使用重试机制时,需要注意不要陷入死循环。如果请求一直失败,重试次数一直增加,可能会导致系统崩溃或者资源耗尽等问题。

          参考:
          [1]. 《Java业务开发常见错误100例》
          [2]. https://juejin.cn/post/7028947828248412168#heading-9
          [3].https://resilience4j.readme.io/docs/retry
          Loading...
          目录
          文章列表
          王小扬博客
          产品
          Think
          Git
          软件开发
          计算机网络
          CI
          DB
          设计
          缓存
          Docker
          Node
          操作系统
          Java
          大前端
          Nestjs
          其他
          PHP