SpringBoot3應(yīng)用中集成和使用Spring Retry的實(shí)踐記錄

更新時(shí)間：2025年06月16日 14:23:57 作者：CoderJia_

SpringRetry為SpringBoot3提供重試機(jī)制,支持注解和編程式兩種方式,可配置重試策略與監(jiān)聽(tīng)器,適用于臨時(shí)性故障場(chǎng)景,需合理設(shè)置次數(shù)、退避策略并做好監(jiān)控,本文給大家詳細(xì)介紹如何在 SpringBoot 3 應(yīng)用中集成和使用 Spring Retry,感興趣的朋友一起看看吧

1. 簡(jiǎn)介

Spring Retry是Spring生態(tài)系統(tǒng)中的一個(gè)重要組件，它提供了自動(dòng)重試失敗操作的能力。在分布式系統(tǒng)中，由于網(wǎng)絡(luò)抖動(dòng)、服務(wù)暫時(shí)不可用等臨時(shí)性故障，重試機(jī)制顯得尤為重要。本文將詳細(xì)介紹如何在 SpringBoot 3 應(yīng)用中集成和使用 Spring Retry。

2. 環(huán)境準(zhǔn)備

首先在 SpringBoot 3 項(xiàng)目中添加必要的依賴(lài)：

<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
    <version>2.0.5</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aspects</artifactId>
    <version>6.1.13</version>
</dependency>

在啟動(dòng)類(lèi)或配置類(lèi)上添加 @EnableRetry 注解以啟用重試功能：

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

3. 使用方式

3.1 注解方式基礎(chǔ)使用

最簡(jiǎn)單的使用方式是通過(guò) @Retryable 注解：

@Service
public class UserService {
    @Retryable
    public void riskyOperation() {
        // 可能失敗的操作
    }
}

自定義重試策略

可以通過(guò) @Retryable 注解的參數(shù)來(lái)自定義重試行為：

@Service
@Slf4j
public class EmailServiceImpl implements IEmailService {
    @Resource
    private JavaMailSender mailSender;
    @Value("${spring.mail.username}")
    private String from;
    /**
     * 發(fā)送簡(jiǎn)單文本郵件
     *
     * @param to
     * @param subject
     * @param text
     */
    @Override
    @Retryable(retryFor = MailSendException.class, maxAttempts = 3, backoff = @Backoff(delay = 1000))
    public void sendSimpleEmail(String to, String subject, String text) {
        try {
            SimpleMailMessage message = new SimpleMailMessage();
            message.setFrom(from);
            message.setTo(to);
            message.setSubject(subject);
            message.setText(text);
            mailSender.send(message);
            log.info("Simple email sent successfully to: {}", to);
        } catch (Exception e) {
            log.error("Failed to send simple email", e);
            throw new MailSendException("Failed to send email", e);
        }
    }
}

當(dāng)執(zhí)行發(fā)生指定異常，將會(huì)嘗試進(jìn)行重試，一旦達(dá)到最大嘗試次數(shù)，但仍有異常發(fā)生，就會(huì)拋出 ExhaustedRetryException。重試最多可進(jìn)行三次，兩次重試之間的延遲時(shí)間默認(rèn)為一秒。

失敗恢復(fù)機(jī)制

使用 @Recover 注解定義重試失敗后的恢復(fù)方法：

    /**
     * 發(fā)送簡(jiǎn)單文本郵件
     *
     * @param to
     * @param subject
     * @param text
     */
    @Override
    @Retryable(retryFor = MailSendException.class, // 指定異常類(lèi)型
            maxAttempts = 3, // 最大重試次數(shù)
            backoff = @Backoff(delay = 1000) // 指定退避策略，例如延遲時(shí)間
    )
    public void sendSimpleEmail(String to, String subject, String text) {
        try {
            SimpleMailMessage message = new SimpleMailMessage();
            message.setFrom(from);
            message.setTo(to);
            message.setSubject(subject);
            message.setText(text);
            mailSender.send(message);
            log.info("Simple email sent successfully to: {}", to);
        } catch (Exception e) {
            log.error("Failed to send simple email", e.getMessage());
            throw new MailSendException("Failed to send email", e);
        }
    }
    @Recover
    public void recover(MailSendException e, String param) {
        // 處理最終失敗的情況
        log.error("Final recovery : {}", param);
    }

重試和失敗恢復(fù)效果

注意事項(xiàng)

注意@Recover 失效的情況：

@Recover 方法的參數(shù)類(lèi)型與實(shí)際異常不匹配；
@Recover 方法的返回類(lèi)型與 @Retryable 方法不一致；
@Recover 方法的其他參數(shù)與 @Retryable 方法參數(shù)不匹配。

3.2 編程式使用

除了注解方式，Spring Retry 還提供了 RetryTemplate 用于編程式重試：

@Configuration
public class RetryConfig {
    @Bean
    public RetryTemplate retryTemplate() {
        RetryTemplate template = new RetryTemplate();
        // 配置重試策略
        SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy();
        retryPolicy.setMaxAttempts(3);
        // 配置退避策略
        FixedBackOffPolicy backOffPolicy = new FixedBackOffPolicy();
        backOffPolicy.setBackOffPeriod(1000L);
        template.setRetryPolicy(retryPolicy);
        template.setBackOffPolicy(backOffPolicy);
        return template;
    }
}

使用RetryTemplate：

@Service
public class UserService {
    @Autowired
    private RetryTemplate retryTemplate;
    public void executeWithRetry() {
        retryTemplate.execute(context -> {
            // 需要重試的業(yè)務(wù)邏輯
            return null;
        });
    }
}

3.3 監(jiān)聽(tīng)重試過(guò)程

通過(guò)實(shí)現(xiàn)RetryListener接口，可以監(jiān)聽(tīng)重試的整個(gè)生命周期：

public class CustomRetryListener extends RetryListenerSupport {
    @Override
    public <T, E extends Throwable> void onError(RetryContext context, 
            RetryCallback<T, E> callback, Throwable throwable) {
        // 記錄錯(cuò)誤日志
        log.error("Retry error occurred", throwable);
    }
    @Override
    public <T, E extends Throwable> void close(RetryContext context,
            RetryCallback<T, E> callback, Throwable throwable) {
        // 重試結(jié)束時(shí)的處理
        log.info("Retry completed");
    }
}

將監(jiān)聽(tīng)器注冊(cè)到RetryTemplate：

@Configuration
public class RetryConfig {
    @Bean
    public RetryTemplate retryTemplate() {
        RetryTemplate template = new RetryTemplate();
        // ... 其他配置 ...
        template.registerListener(new CustomRetryListener());
        return template;
    }
}

監(jiān)聽(tīng)重試效果

監(jiān)聽(tīng)重試過(guò)程

4. 最佳實(shí)踐

明確重試場(chǎng)景：只對(duì)臨時(shí)性故障使用重試機(jī)制，對(duì)于業(yè)務(wù)錯(cuò)誤或永久性故障應(yīng)直接失敗。
設(shè)置合理的重試次數(shù)：通常3-5次即可，過(guò)多的重試可能會(huì)加重系統(tǒng)負(fù)擔(dān)。
使用退避策略：建議使用指數(shù)退避策略(ExponentialBackOffPolicy)，避免立即重試對(duì)系統(tǒng)造成沖擊。
添加監(jiān)控和日志：通過(guò)RetryListener記錄重試情況，便于問(wèn)題排查。
設(shè)置超時(shí)時(shí)間：避免重試過(guò)程持續(xù)時(shí)間過(guò)長(zhǎng)。

5. 總結(jié)

Spring Retry為Spring應(yīng)用提供了強(qiáng)大而靈活的重試機(jī)制，既可以通過(guò)注解優(yōu)雅地實(shí)現(xiàn)重試，也可以使用RetryTemplate進(jìn)行更細(xì)粒度的控制。在實(shí)際應(yīng)用中，合理使用重試機(jī)制可以提高系統(tǒng)的健壯性和可用性。

需要注意的是，重試機(jī)制并非萬(wàn)能藥，在使用時(shí)要根據(jù)具體場(chǎng)景選擇合適的重試策略，并做好監(jiān)控和告警，以便及時(shí)發(fā)現(xiàn)和處理問(wèn)題。

到此這篇關(guān)于SpringBoot3應(yīng)用中集成和使用Spring Retry的實(shí)踐記錄的文章就介紹到這了,更多相關(guān)SpringBoot3 Spring Retry內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: