Feign?重試其實(shí)是一個(gè)很常見的場(chǎng)景，我們本文通過了自定義了一個(gè)@FeignRetry?注解來實(shí)現(xiàn)可重試的機(jī)制，針對(duì)不同的Feign接口還可以使用不同的重試策略，是不是很方便，快在你的項(xiàng)目中用起來吧。
前言
在我們公司里，不同的服務(wù)之間通過Feign進(jìn)行遠(yuǎn)程調(diào)用，但是，我們?cè)趪L試使調(diào)用可重試時(shí)遇到了一個(gè)小問題，F(xiàn)eign框架本身可以配置的自己的重試機(jī)制，但是它是一刀切的方式，所有的調(diào)用都是同樣的機(jī)制，沒有辦法像我們希望的那樣在每個(gè)方法的基礎(chǔ)上配置。不過我在項(xiàng)目中探索除了一種新的寫法，通過spring-retry框架集合Feign去實(shí)現(xiàn)重試機(jī)制，可以為每個(gè)調(diào)用實(shí)現(xiàn)不同的重試機(jī)制，那究竟是如何做到的呢，繼續(xù)往下看呀。
自定義注解@FeignRetry
為了解決上面提到的問題，讓Feign調(diào)用的每個(gè)接口單獨(dú)配置不同的重試機(jī)制。我們使用了面向切面編程并編寫了一個(gè)自定義注解：@FeignRetry。此注釋的工作方式類似于@Retryable的包裝器，并與其共享相同的規(guī)范以避免混淆。
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface FeignRetry {
Backoff backoff() default @Backoff();
int maxAttempt() default 3;
Class<? extends Throwable>[] include() default {};
}
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Backoff {
long delay() default 1000L;;
long maxDelay() default 0L;
double multiplier() default 0.0D;;
}FeignRetryAspect切面處理@FeignRetry注解。
Slf4j
@Aspect
@Component
public class FeignRetryAspect {
@Around("@annotation(FeignRetry)")
public Object retry(ProceedingJoinPoint joinPoint) throws Throwable {
Method method = getCurrentMethod(joinPoint);
FeignRetry feignRetry = method.getAnnotation(FeignRetry.class);
RetryTemplate retryTemplate = new RetryTemplate();
retryTemplate.setBackOffPolicy(prepareBackOffPolicy(feignRetry));
retryTemplate.setRetryPolicy(prepareSimpleRetryPolicy(feignRetry));
// 重試
return retryTemplate.execute(arg0 -> {
int retryCount = arg0.getRetryCount();
log.info("Sending request method: {}, max attempt: {}, delay: {}, retryCount: {}",
method.getName(),
feignRetry.maxAttempt(),
feignRetry.backoff().delay(),
retryCount
);
return joinPoint.proceed(joinPoint.getArgs());
});
}
private BackOffPolicy prepareBackOffPolicy(FeignRetry feignRetry) {
if (feignRetry.backoff().multiplier() != 0) {
ExponentialBackOffPolicy backOffPolicy = new ExponentialBackOffPolicy();
backOffPolicy.setInitialInterval(feignRetry.backoff().delay());
backOffPolicy.setMaxInterval(feignRetry.backoff().maxDelay());
backOffPolicy.setMultiplier(feignRetry.backoff().multiplier());
return backOffPolicy;
} else {
FixedBackOffPolicy fixedBackOffPolicy = new FixedBackOffPolicy();
fixedBackOffPolicy.setBackOffPeriod(feignRetry.backoff().delay());
return fixedBackOffPolicy;
}
}
private SimpleRetryPolicy prepareSimpleRetryPolicy(FeignRetry feignRetry) {
Map<Class<? extends Throwable>, Boolean> policyMap = new HashMap<>();
policyMap.put(RetryableException.class, true); // Connection refused or time out
policyMap.put(ClientException.class, true); // Load balance does not available (cause of RunTimeException)
if (feignRetry.include().length != 0) {
for (Class<? extends Throwable> t : feignRetry.include()) {
policyMap.put(t, true);
}
}
return new SimpleRetryPolicy(feignRetry.maxAttempt(), policyMap, true);
}
private Method getCurrentMethod(JoinPoint joinPoint) {
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
return signature.getMethod();
}
}
捕獲FeignRetry注解的方法，將配置傳遞給Spring RetryTemplate，根據(jù)配置調(diào)用服務(wù)。
@FeignRetry 的使用
用法很簡(jiǎn)單，只需將注釋放在我們希望重試機(jī)制處于活動(dòng)狀態(tài)的 Feign Client方法上即可。自定義切面的用法類似于Spring自帶的@Retryable注解。
@GetMapping
@FeignRetry(maxAttempt = 3, backoff = @Backoff(delay = 500L))
ResponseEntity<String> retrieve1();
@GetMapping
@FeignRetry(maxAttempt = 6, backoff = @Backoff(delay = 500L, maxDelay = 20000L, multiplier = 4))
ResponseEntity<String> retrieve2();
另外還需要在應(yīng)用程序類中使用 @EnableRetry 注釋來啟動(dòng)重試，比如可以加載SpringBoot的啟動(dòng)類中。
總結(jié)
Feign重試其實(shí)是一個(gè)很常見的場(chǎng)景，我們本文通過了自定義了一個(gè)@FeignRetry注解來實(shí)現(xiàn)可重試的機(jī)制，針對(duì)不同的Feign接口還可以使用不同的重試策略，是不是很方便，快在你的項(xiàng)目中用起來吧。
