消息重试框架 Spring-Retry 和 Guava-Retry

一 重试框架之Spring-Retry

1. Spring-Retry的普通使用方式

1.准备工作

 <dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
<version>1.2.2.RELEASE</version>
</dependency>

package com.zgd.demo.thread.retry;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.RandomUtils;
import org.springframework.remoting.RemoteAccessException;

/**
* @Author: zgd
* @Description:
*/
@Slf4j
public class RetryDemoTask {

/**
* 重试方法
* @return
*/
public static boolean retryTask(String param)  {
log.info(“收到请求参数:{}”,param);

int i = RandomUtils.nextInt(0,11);
log.info(“随机生成的数:{}”,i);
if (i == 0) {
log.info(“为0,抛出参数异常.”);
throw new IllegalArgumentException(“参数异常”);
}else if (i  == 1){
log.info(“为1,返回true.”);
return true;
}else if (i == 2){
log.info(“为2,返回false.”);
return false;
}else{
//为其他
log.info(“大于2,抛出自定义异常.”);
throw new RemoteAccessException(“大于2,抛出远程访问异常”);
}
}

}

2.使用SpringRetryTemplate

package com.zgd.demo.thread.retry.spring;

import com.zgd.demo.thread.retry.RetryDemoTask;
import lombok.extern.slf4j.Slf4j;
import org.junit.Test;
import org.springframework.remoting.RemoteAccessException;
import org.springframework.retry.backoff.FixedBackOffPolicy;
import org.springframework.retry.policy.SimpleRetryPolicy;
import org.springframework.retry.support.RetryTemplate;

import java.util.HashMap;
import java.util.Map;

/**
* @Author: zgd
* @Description: spring-retry 重试框架
*/
@Slf4j
public class SpringRetryTemplateTest {

/**
* 重试间隔时间ms,默认1000ms
* */
private long fixedPeriodTime = 1000L;
/**
* 最大重试次数,默认为3
*/
private int maxRetryTimes = 3;
/**
* 表示哪些异常需要重试,key表示异常的字节码,value为true表示需要重试
*/
private Map<Class<? extends Throwable>, Boolean> exceptionMap = new HashMap<>();

@Test
public void test() {
exceptionMap.put(RemoteAccessException.class,true);

// 构建重试模板实例
RetryTemplate retryTemplate = new RetryTemplate();

// 设置重试回退操作策略，主要设置重试间隔时间
FixedBackOffPolicy backOffPolicy = new FixedBackOffPolicy();
backOffPolicy.setBackOffPeriod(fixedPeriodTime);

// 设置重试策略，主要设置重试次数
SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy(maxRetryTimes, exceptionMap);

retryTemplate.setRetryPolicy(retryPolicy);
retryTemplate.setBackOffPolicy(backOffPolicy);

Boolean execute = retryTemplate.execute(
//RetryCallback
retryContext -> {
boolean b = RetryDemoTask.retryTask(“abc”);
log.info(“调用的结果:{}”, b);
return b;
},
retryContext -> {
//RecoveryCallback
log.info(“已达到最大重试次数或抛出了不重试的异常~~~”);
return false;
}
);

log.info(“执行结果:{}”,execute);

}

}

重试策略

• NeverRetryPolicy： 只允许调用RetryCallback一次，不允许重试
• AlwaysRetryPolicy： 允许无限重试，直到成功，此方式逻辑不当会导致死循环
• SimpleRetryPolicy： 固定次数重试策略，默认重试最大次数为3次，RetryTemplate默认使用的策略
• TimeoutRetryPolicy： 超时时间重试策略，默认超时时间为1秒，在指定的超时时间内允许重试
• ExceptionClassifierRetryPolicy： 设置不同异常的重试策略，类似组合重试策略，区别在于这里只区分不同异常的重试
• CircuitBreakerRetryPolicy： 有熔断功能的重试策略，需设置3个参数openTimeout、resetTimeout和delegate
• CompositeRetryPolicy： 组合重试策略，有两种组合方式，乐观组合重试策略是指只要有一个策略允许即可以重试，悲观组合重试策略是指只要有一个策略不允许即可以重试，但不管哪种组合方式，组合中的每一个策略都会执行

重试回退策略

• NoBackOffPolicy： 无退避算法策略，每次重试时立即重试
• FixedBackOffPolicy： 固定时间的退避策略，需设置参数sleeper和backOffPeriod，sleeper指定等待策略，默认是Thread.sleep，即线程休眠，backOffPeriod指定休眠时间，默认1秒
• UniformRandomBackOffPolicy： 随机时间退避策略，需设置sleeper、minBackOffPeriod和maxBackOffPeriod，该策略在minBackOffPeriod,maxBackOffPeriod之间取一个随机休眠时间，minBackOffPeriod默认500毫秒，maxBackOffPeriod默认1500毫秒
• ExponentialBackOffPolicy： 指数退避策略，需设置参数sleeper、initialInterval、maxInterval和multiplier，initialInterval指定初始休眠时间，默认100毫秒，maxInterval指定最大休眠时间，默认30秒，multiplier指定乘数，即下一次休眠时间为当前休眠时间*multiplier
• ExponentialRandomBackOffPolicy： 随机指数退避策略，引入随机乘数可以实现随机乘数回退

2. Spring-Retry的注解使用方式

1.准备工作

 <dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
<version>1.2.2.RELEASE</version>
</dependency>

<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.1</version>
</dependency>

2.代码

@EnableRetry
public class Application {
…
}

package com.zgd.demo.thread.test;

/**
* @Author: zgd
* @Description:
*/

import com.zgd.demo.thread.Application;
import lombok.extern.slf4j.Slf4j;
import org.junit.After;
import org.junit.Before;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

/**
* @Author: zgd
* @Date: 18/09/29 20:33
* @Description:
*/
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
@Slf4j
public class MyBaseTest {

@Before
public void init() {
log.info(“—————-测试开始—————“);
}

@After
public void after() {
log.info(“—————-测试结束—————“);
}

}

package com.zgd.demo.thread.retry.spring;

import com.zgd.demo.thread.retry.RetryDemoTask;
import com.zgd.demo.thread.test.MyBaseTest;
import lombok.extern.slf4j.Slf4j;
import org.springframework.remoting.RemoteAccessException;
import org.springframework.retry.ExhaustedRetryException;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Component;

/**
* @Author: zgd
* @Description:
*/
@Service
@Slf4j
public class SpringRetryDemo   {

/**
* 重试所调用方法
* @param param
* @return
*/
@Retryable(value = {RemoteAccessException.class},maxAttempts = 3,backoff = @Backoff(delay = 2000L,multiplier = 2))
public boolean call(String param){
return RetryDemoTask.retryTask(param);
}

/**
* 达到最大重试次数,或抛出了一个没有指定进行重试的异常
* recover 机制
* @param e 异常
*/
@Recover
public boolean recover(Exception e,String param) {
log.error(“达到最大重试次数,或抛出了一个没有指定进行重试的异常:”,e);
return false;
}

}

package com.zgd.demo.thread.retry.spring;

import com.zgd.demo.thread.test.MyBaseTest;
import lombok.extern.slf4j.Slf4j;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
* @Author: zgd
* @Description:
*/
@Component
@Slf4j
public class SpringRetryDemoTest extends MyBaseTest {

@Autowired
private SpringRetryDemo springRetryDemo;

@Test
public void retry(){
boolean abc = springRetryDemo.call(“abc”);
log.info(“–结果是:{}–“,abc);
}

}

二 重试框架之Guava-Retry

  <!– https://mvnrepository.com/artifact/com.github.rholder/guava-retrying –>
<dependency>
<groupId>com.github.rholder</groupId>
<artifactId>guava-retrying</artifactId>
<version>2.0.0</version>
</dependency>

package com.zgd.demo.thread.retry;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.RandomUtils;
import org.springframework.remoting.RemoteAccessException;

/**
* @Author: zgd
* @Description:
*/
@Slf4j
public class RetryDemoTask {

/**
* 重试方法
* @return
*/
public static boolean retryTask(String param)  {
log.info(“收到请求参数:{}”,param);

int i = RandomUtils.nextInt(0,11);
log.info(“随机生成的数:{}”,i);
if (i < 2) {
log.info(“为0,抛出参数异常.”);
throw new IllegalArgumentException(“参数异常”);
}else if (i  < 5){
log.info(“为1,返回true.”);
return true;
}else if (i < 7){
log.info(“为2,返回false.”);
return false;
}else{
//为其他
log.info(“大于2,抛出自定义异常.”);
throw new RemoteAccessException(“大于2,抛出自定义异常”);
}
}

}

package com.zgd.demo.thread.retry.guava;

import com.github.rholder.retry.*;
import com.zgd.demo.thread.retry.RetryDemoTask;
import org.junit.Test;
import org.springframework.remoting.RemoteAccessException;

import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.function.Predicate;

/**
* @Author: zgd
* @Description:
*/
public class GuavaRetryTest {

@Test
public void fun01(){
// RetryerBuilder 构建重试实例 retryer,可以设置重试源且可以支持多个重试源，可以配置重试次数或重试超时时间，以及可以配置等待时间间隔
Retryer<Boolean> retryer = RetryerBuilder.<Boolean> newBuilder()
.retryIfExceptionOfType(RemoteAccessException.class)//设置异常重试源
.retryIfResult(res-> res==false)  //设置根据结果重试
.withWaitStrategy(WaitStrategies.fixedWait(3, TimeUnit.SECONDS)) //设置等待间隔时间
.withStopStrategy(StopStrategies.stopAfterAttempt(3)) //设置最大重试次数
.build();

try {
retryer.call(() -> RetryDemoTask.retryTask(“abc”));
} catch (Exception e) {
e.printStackTrace();
}
}

}

• retryIfException： retryIfException，抛出 runtime 异常、checked 异常时都会重试，但是抛出 error 不会重试。
• retryIfRuntimeException： retryIfRuntimeException 只会在抛 runtime 异常的时候才重试，checked 异常和error 都不重试。
• retryIfExceptionOfType： retryIfExceptionOfType 允许我们只在发生特定异常的时候才重试，比如NullPointerException 和 IllegalStateException 都属于 runtime 异常，也包括自定义的error。

retryIfExceptionOfType(NullPointerException.class)// 只在抛出空指针异常重试

• retryIfResult: retryIfResult 可以指定你的 Callable 方法在返回值的时候进行重试，如

// 返回false重试
.retryIfResult(Predicates.equalTo(false))

//以_error结尾才重试
.retryIfResult(Predicates.containsPattern(“_error$”))

//返回为空时重试
.retryIfResult(res-> res==null)

• RetryListener： 当发生重试之后，假如我们需要做一些额外的处理动作，比如log一下异常，那么可以使用RetryListener。每次重试之后，guava-retrying 会自动回调我们注册的监听。可以注册多个RetryListener，会按照注册顺序依次调用。

.withRetryListener(new RetryListener {
@Override
public <T> void onRetry(Attempt<T> attempt) {
logger.error(“第【{}】次调用失败” , attempt.getAttemptNumber());
}
}
)

总结

admin普通

打赏 收藏 海报 链接