您好,登錄后才能下訂單哦!
這篇“Spring Retry重試框架如何使用”文章的知識(shí)點(diǎn)大部分人都不太理解,所以小編給大家總結(jié)了以下內(nèi)容,內(nèi)容詳細(xì),步驟清晰,具有一定的借鑒價(jià)值,希望大家閱讀完這篇文章能有所收獲,下面我們一起來(lái)看看這篇“Spring Retry重試框架如何使用”文章吧。
首先引入依賴
<dependency> <groupId>org.springframework.retry</groupId> <artifactId>spring-retry</artifactId> <version>1.3.4</version> </dependency> <dependency> <groupId>org.aspectj</groupId> <artifactId>aspectjweaver</artifactId> <version>1.9.9.1</version> </dependency>
使用方式有兩種:命令式和聲明式
/** * 命令式的方式使用Spring Retry */ @GetMapping("/hello") public String hello(@RequestParam("code") Integer code) throws Throwable { RetryTemplate retryTemplate = RetryTemplate.builder() .maxAttempts(3) .fixedBackoff(1000) .retryOn(RemoteAccessException.class) .build(); retryTemplate.registerListener(new MyRetryListener()); String resp = retryTemplate.execute(new RetryCallback<String, Throwable>() { @Override public String doWithRetry(RetryContext context) throws Throwable { return helloService.hello(code); } }); return resp; }
定義一個(gè)RetryTemplate,然后調(diào)用execute方法,可配置項(xiàng)比較多,不一一列舉
真正使用的時(shí)候RetryTemplate可以定義成一個(gè)Bean,例如:
@Configuration public class RetryConfig { @Bean public RetryTemplate retryTemplate() { RetryTemplate retryTemplate = RetryTemplate.builder() .maxAttempts(3) .fixedBackoff(1000) .withListener(new MyRetryListener()) .retryOn(RemoteAccessException.class) .build(); return retryTemplate; } }
業(yè)務(wù)代碼:
/** * 命令式的方式使用Spring Retry */ @Override public String hello(int code) { if (0 == code) { System.out.println("出錯(cuò)了"); throw new RemoteAccessException("出錯(cuò)了"); } System.out.println("處理完成"); return "ok"; }
監(jiān)聽(tīng)器實(shí)現(xiàn):
package com.example.retry.listener; import org.springframework.retry.RetryCallback; import org.springframework.retry.RetryContext; import org.springframework.retry.RetryListener; public class MyRetryListener implements RetryListener { @Override public <T, E extends Throwable> boolean open(RetryContext context, RetryCallback<T, E> callback) { System.out.println("open"); return true; } @Override public <T, E extends Throwable> void close(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) { System.out.println("close"); } @Override public <T, E extends Throwable> void onError(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) { System.out.println("error"); } }
/** * 注解的方式使用Spring Retry */ @Retryable(value = Exception.class, maxAttempts = 2, backoff = @Backoff(value = 1000, delay = 2000, multiplier = 0.5)) @Override public String hi(int code) { System.out.println("方法被調(diào)用"); int a = 1/code; return "ok"; } @Recover public String hiRecover(Exception ex, int code) { System.out.println("重試結(jié)束"); return "asdf"; }
這里需要主要的幾點(diǎn)
@EnableRetry(proxyTargetClass = true/false)
@Retryable 修飾的方法必須是public的,而且不能是同一個(gè)類中調(diào)用
@Recover 修飾的方法簽名必須與@Retryable修飾的方法一樣,除了第一個(gè)參數(shù)外
/** * 注解的方式使用Spring Retry */ @GetMapping("/hi") public String hi(@RequestParam("code") Integer code) { return helloService.hi(code); }
聲明式
@Configuration @EnableRetry public class Application { } @Service class Service { @Retryable(RemoteAccessException.class) public void service() { // ... do something } @Recover public void recover(RemoteAccessException e) { // ... panic } }
命令式
RetryTemplate template = RetryTemplate.builder() .maxAttempts(3) .fixedBackoff(1000) .retryOn(RemoteAccessException.class) .build(); template.execute(ctx -> { // ... do something });
為了自動(dòng)重試,Spring Retry 提供了 RetryOperations 重試操作策略
public interface RetryOperations { <T> T execute(RetryCallback<T> retryCallback) throws Exception; <T> T execute(RetryCallback<T> retryCallback, RecoveryCallback<T> recoveryCallback) throws Exception; <T> T execute(RetryCallback<T> retryCallback, RetryState retryState) throws Exception, ExhaustedRetryException; <T> T execute(RetryCallback<T> retryCallback, RecoveryCallback<T> recoveryCallback, RetryState retryState) throws Exception; }
基本回調(diào)是一個(gè)簡(jiǎn)單的接口,允許插入一些要重試的業(yè)務(wù)邏輯:
public interface RetryCallback<T> { T doWithRetry(RetryContext context) throws Throwable; }
回調(diào)函數(shù)被嘗試,如果失?。ㄍㄟ^(guò)拋出異常),它將被重試,直到成功或?qū)崿F(xiàn)決定中止。
RetryOperations最簡(jiǎn)單的通用實(shí)現(xiàn)是RetryTemplate
RetryTemplate template = new RetryTemplate(); TimeoutRetryPolicy policy = new TimeoutRetryPolicy(); policy.setTimeout(30000L); template.setRetryPolicy(policy); Foo result = template.execute(new RetryCallback<Foo>() { public Foo doWithRetry(RetryContext context) { // Do stuff that might fail, e.g. webservice operation return result; } });
從Spring Retry 1.3開(kāi)始,RetryTemplate支持流式配置:
RetryTemplate.builder() .maxAttempts(10) .exponentialBackoff(100, 2, 10000) .retryOn(IOException.class) .traversingCauses() .build(); RetryTemplate.builder() .fixedBackoff(10) .withinMillis(3000) .build(); RetryTemplate.builder() .infiniteRetry() .retryOn(IOException.class) .uniformRandomBackoff(1000, 3000) .build();
當(dāng)重試耗盡時(shí),RetryOperations可以將控制傳遞給不同的回調(diào):RecoveryCallback。
Foo foo = template.execute(new RetryCallback<Foo>() { public Foo doWithRetry(RetryContext context) { // business logic here }, new RecoveryCallback<Foo>() { Foo recover(RetryContext context) throws Exception { // recover logic here } });
public interface RetryListener { void open(RetryContext context, RetryCallback<T> callback); void onSuccess(RetryContext context, T result); void onError(RetryContext context, RetryCallback<T> callback, Throwable e); void close(RetryContext context, RetryCallback<T> callback, Throwable e); }
在最簡(jiǎn)單的情況下,open和close回調(diào)在整個(gè)重試之前和之后,onSuccess和onError應(yīng)用于個(gè)別的RetryCallback調(diào)用,onSuccess方法在成功調(diào)用回調(diào)之后被調(diào)用。
有時(shí),你希望在每次業(yè)務(wù)處理發(fā)生時(shí)都重試一些業(yè)務(wù)處理。這方面的典型例子是遠(yuǎn)程服務(wù)調(diào)用。Spring Retry提供了一個(gè)AOP攔截器,它將方法調(diào)用封裝在RetryOperations實(shí)例中。RetryOperationsInterceptor執(zhí)行被攔截的方法,并根據(jù)提供的RepeatTemplate中的RetryPolicy在失敗時(shí)重試。
你可以在 @Configuration 類上添加一個(gè) @EnableRetry 注解,并且在你想要進(jìn)行重試的方法(或者類)上添加 @Retryable 注解,還可以指定任意數(shù)量的重試監(jiān)聽(tīng)器。
@Configuration @EnableRetry public class Application { @Bean public Service service() { return new Service(); } @Bean public RetryListener retryListener1() { return new RetryListener() {...} } @Bean public RetryListener retryListener2() { return new RetryListener() {...} } } @Service class Service { @Retryable(RemoteAccessException.class) public service() { // ... do something } }
可以使用 @Retryable 的屬性類控制 RetryPolicy 和 BackoffPolicy
@Service class Service { @Retryable(maxAttempts=12, backoff=@Backoff(delay=100, maxDelay=500)) public service() { // ... do something } }
如果希望在重試用盡時(shí)采用替代代碼返回,則可以提供恢復(fù)方法。方法應(yīng)該聲明在與@Retryable實(shí)例相同的類中,并標(biāo)記為@Recover。返回類型必須匹配@Retryable方法?;謴?fù)方法的參數(shù)可以包括拋出的異常和(可選地)傳遞給原始可重試方法的參數(shù)(或者它們的部分列表,只要在需要的最后一個(gè)之前不省略任何參數(shù))。
@Service class Service { @Retryable(RemoteAccessException.class) public void service(String str1, String str2) { // ... do something } @Recover public void recover(RemoteAccessException e, String str1, String str2) { // ... error handling making use of original args if required } }
若要解決可選擇用于恢復(fù)的多個(gè)方法之間的沖突,可以顯式指定恢復(fù)方法名稱。
@Service class Service { @Retryable(recover = "service1Recover", value = RemoteAccessException.class) public void service1(String str1, String str2) { // ... do something } @Retryable(recover = "service2Recover", value = RemoteAccessException.class) public void service2(String str1, String str2) { // ... do something } @Recover public void service1Recover(RemoteAccessException e, String str1, String str2) { // ... error handling making use of original args if required } @Recover public void service2Recover(RemoteAccessException e, String str1, String str2) { // ... error handling making use of original args if required } }
以上就是關(guān)于“Spring Retry重試框架如何使用”這篇文章的內(nèi)容,相信大家都有了一定的了解,希望小編分享的內(nèi)容對(duì)大家有幫助,若想了解更多相關(guān)的知識(shí)內(nèi)容,請(qǐng)關(guān)注億速云行業(yè)資訊頻道。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。