前言

在實(shí)際工作中，重試機(jī)制是一個(gè)很常見(jiàn)的場(chǎng)景，比如：發(fā)送消息失敗，下載網(wǎng)絡(luò)文件失敗等…，因?yàn)檫@些錯(cuò)誤可能是網(wǎng)絡(luò)波動(dòng)造成的，等待一些延遲就能成功處理。我們通常會(huì)使用try/catch、while循環(huán)等進(jìn)行相關(guān)處理，但是這樣看起來(lái)比較臃腫復(fù)雜，且不好看。于是就有了spring提供的重試模塊—— @Retryable

@Retryable 簡(jiǎn)介

一個(gè)spring提供的重試機(jī)制注解模塊，簡(jiǎn)單的注解，提供有效的幫助。雖然有一些限制，但是在大多數(shù)情況下還是可以很好的解決我們的問(wèn)題——優(yōu)雅，永不過(guò)時(shí)。

使用步驟

1.引入依賴

gradle 引入方式如下

implementation 'org.springframework.retry:spring-retry:1.3.3'

maven 引入方式

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

2.啟用@Retryable

在項(xiàng)目啟動(dòng)類上加上注解@EnableRetry

@SpringBootApplication
@EnableRetry
public class NfljApplication {

? ? public static void main(String[] args) {
? ? ? ? SpringApplication.run(NfljApplication.class, args);
? ? }
}

3.添加@Retryable注解

新建service方法，添加如下方法

public interface CodeService {
    String code() throws Exception;
}

新建實(shí)現(xiàn)類，在我們要使用的方法上添加@Retryable注解

在同一個(gè)實(shí)現(xiàn)類下加上回調(diào)方法@Recover（如果不需要回調(diào)方法，可以直接不寫回調(diào)方法），實(shí)現(xiàn)的效果是，重試次數(shù)完了后，如果還是沒(méi)成功沒(méi)符合業(yè)務(wù)判斷，就拋出異常

@Service
public class CodeServiceImpl implements CodeService {

? ? @Override
? ? @Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 1000,multiplier = 1.5))
? ? public String code() throws Exception {
? ? ? ? System.out.println("開(kāi)始調(diào)用----------");
? ? ? ? if (0 == 0) {
? ? ? ? ? ? throw new Exception("調(diào)用出錯(cuò)啦！?。?);
? ? ? ? }
? ? ? ? System.out.println("成功調(diào)用");
? ? ? ? return "200";
? ? }
? ??
? ? /**
? ? ?* 回調(diào)方法
? ? ?*
? ? ?* @return
? ? ?*/
? ? @Recover
? ? public String recover(Exception e) {
? ? ? ? System.out.println("---------------回調(diào)方法執(zhí)行----------------");
? ? ? ? //記錄日志到數(shù)據(jù)庫(kù)
? ? ? ? return "500";
? ? }
}

4.測(cè)試

編寫測(cè)試類進(jìn)行測(cè)試

    @Autowired
    private CodeService codeService;
    @Test
    void test4() throws Exception {
        String code = codeService.code();
        System.out.println(code);
    }

測(cè)試的打印結(jié)果如下，可以證明，完美的進(jìn)行了重試

開(kāi)始調(diào)用----------
開(kāi)始調(diào)用----------
開(kāi)始調(diào)用----------
---------------回調(diào)方法執(zhí)行----------------
500

注意事項(xiàng)

1. @Retryable注解參數(shù)

• value：拋出我們指定異常才會(huì)重試
• include：和value一樣，默認(rèn)為空，當(dāng)exclude也為空時(shí)，默認(rèn)所有異常
• exclude：指定不處理的異常
• maxAttempts：最大重試次數(shù)，默認(rèn)3次，包括第一次請(qǐng)求也算在其中
• backoff：重試等待策略，默認(rèn)使用@Backoff，@Backoff的value默認(rèn)為1000L
• multiplier（指定延遲倍數(shù)）默認(rèn)為0，表示固定暫停1秒后進(jìn)行重試，如果把multiplier設(shè)置為1.5，則第一次重試為2秒，第二次為3秒，第三次為4.5秒。

2. @Recover 注解

• 方法的返回值必須與@Retryable方法一致
• 方法的第一個(gè)參數(shù)，必須是Throwable類型的，建議是與@Retryable配置的異常一致，其他的參數(shù)，需要哪個(gè)參數(shù)，寫進(jìn)去即可
• 回調(diào)方法與重試方法寫在同一個(gè)實(shí)現(xiàn)類里面

最后

由于是基于AOP實(shí)現(xiàn)，所以不支持類里自調(diào)用方法，且需引入aop依賴

implementation 'org.springframework.boot:spring-boot-starter-aop:2.6.3'

如果重試失敗需要給@Recover注解的方法做后續(xù)處理，那這個(gè)重試的方法不能有返回值，只能是void
方法內(nèi)不能使用try catch，只能往外拋異常
@Recover注解來(lái)開(kāi)啟重試失敗后調(diào)用的方法(注意,需跟重處理方法在同一個(gè)類中)，此注解注釋的方法參數(shù)一定要是@Retryable拋出的異常，否則無(wú)法識(shí)別，可以在該方法中進(jìn)行日志處理

結(jié)語(yǔ)

雖然該注解的使用有一些限制，但是依然能夠在很大程度上解決我們的需求，也不用在代碼中寫很臃腫的重試方法，此時(shí)此刻，只需要一個(gè)注解，就能優(yōu)雅的解決我們的問(wèn)題

到此這篇關(guān)于springboot整合@Retryable實(shí)現(xiàn)重試功能的示例代碼的文章就介紹到這了,更多相關(guān)springboot @Retryable重試內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論