Spring 重试机制 @Retryable

@Retryable是Spring提供的可重试注解，为了使用spring提供的重试机制，需要做如下操作： 1、添加maven依赖


    org.springframework.retry
    spring-retry
    1.2.5.RELEASE

2、在启动类或者方法所在的类上添加注解@EnableRetry

@EnableRetry
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

3、在需要重试的方法上添加注解@Retryable，示例如下：

   
    @Retryable(value = Exception.class, maxAttempts = 5, backoff = @Backoff(delay = 2000L, multiplier = 2))
    @Async
    public void doNotify() {
		// TODO doSomeThings...
    }

@Retryable注解中的参数说明：

maxAttempts :最大重试次数，默认为3，如果要设置的重试次数为3，可以不写；
value：抛出指定异常才会重试
include：和value一样，默认为空，当exclude也为空时，默认所以异常
exclude：指定不处理的异常
backoff：重试等待策略，默认使用@Backoff的value默认为1000L

@Backoff注解中的参数说明：

delay：每次重试延迟毫秒数，默认为0L
value：delay的别名，默认为1000L，当delay>0时，value将会被忽略
maxDelay：最大延迟毫秒数，默认为0L，
multiplier：（指定延迟倍数）默认为0；大于0时生效；如果delay等于2，multiplier等于2，则第一次重试为2秒，第二次为4秒，第三次为6秒…
random：随机值加权，默认为false；当multiplier>0时，上次延迟毫秒 < 延迟时间 < 最大延迟 * multiplier

结合@Recover使用

可以在指定方法上标记@Recover来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中)

@Recover
当重试到达指定次数时，被注解的方法将被回调，可以在该方法中进行日志处理。需要注意的是发生的异常和入参类型一致时才会回调。

@Slf4j
@Component
@EnableRetry
public class RecoryTest {
    
    @Retryable(value = {RetryException.class}, // 指定发生的异常进行重试
            maxAttempts=5,                     // 重试次数, 默认即为3
            backoff = @Backoff(delay = 2000L, multiplier = 2)) // 每次重试延迟毫秒数 及 延迟倍数
    @Async
    public void retry() {
        log.info("retry start");
        throw new RetryException("retry fail");
    }
 
    @Recover
    public void recover (RetryException e) {
        log.error("recovery,{}",e.getMessage());
    }
}

最后

调用测试类的retry()方法后执行结果如下：

注意：请避免在同类中调用retry()方法，否则无法得到预期结果
原因：注解其实是通过动态代理的方式来实现异步调用的。同理@Transactional、@Async注解也是，同类之间调用不生效

文档参考: 关于后端:扒一扒Retryable注解很优雅有点意思

Spring 重试机制 @Retryable

Java相关栏目本月热门文章