1. 引言

在應(yīng)用程序中，網(wǎng)絡(luò)請(qǐng)求可能會(huì)因?yàn)楦鞣N原因（如網(wǎng)絡(luò)不穩(wěn)定、服務(wù)器故障等）而失敗。為了提高系統(tǒng)的可靠性，通常需要實(shí)現(xiàn)一個(gè)重試機(jī)制。

HTTP調(diào)用是Java應(yīng)用與外部API進(jìn)行交互時(shí)重要的訪問方式之一。為了確保在遇到臨時(shí)性問題時(shí)能自動(dòng)重試，我們可以設(shè)計(jì)一個(gè)靈活的重試機(jī)制。

在Java中，我們可以通過注解來實(shí)現(xiàn)這一功能，從而簡(jiǎn)化代碼并增強(qiáng)可讀性。本文將介紹如何使用注解@Retryable來實(shí)現(xiàn)HTTP調(diào)用的重試機(jī)制，以應(yīng)對(duì)網(wǎng)絡(luò)交互中的不確定性。

2. 核心代碼解析

2.1 POM依賴

<!-- Spring Retry-->
<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
</dependency>

2.2 SpringBoot啟動(dòng)類注解

此處順便介紹了幾個(gè)常用注解。不是本次介紹的重點(diǎn)。關(guān)注@EnableRetry注解即可。

@SpringBootApplication為應(yīng)用提供基本配置，@EnableApolloConfig和@EnableConfigurationProperties用于配置管理，@EnableRetry增強(qiáng)了網(wǎng)絡(luò)請(qǐng)求的穩(wěn)定性，而@EnableAsync則提供了異步處理能力。

import com.ctrip.framework.apollo.spring.annotation.EnableApolloConfig;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.retry.annotation.EnableRetry;
import org.springframework.scheduling.annotation.EnableAsync;

@SpringBootApplication
@EnableApolloConfig
@EnableConfigurationProperties
@EnableRetry
@EnableAsync
public class BootApplication {

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

}

• @SpringBootApplication是一個(gè)組合注解，通常用于Spring Boot應(yīng)用的主類。包括下面三個(gè)注解。

@Configuration：表明該類是一個(gè)配置類，Spring會(huì)從這個(gè)類中讀取配置信息。

@EnableAutoConfiguration：?jiǎn)⒂肧pring Boot的自動(dòng)配置功能，根據(jù)添加的依賴自動(dòng)配置Spring應(yīng)用。

@ComponentScan：?jiǎn)⒂媒M件掃描，允許Spring查找合適的組件、配置和服務(wù)。

• @EnableApolloConfig

@EnableApolloConfig是Apollo配置中心的注解，用于在Spring Boot應(yīng)用中啟用Apollo的配置管理。Apollo是一個(gè)開源的配置管理中心，能夠幫助開發(fā)者管理應(yīng)用的配置，支持動(dòng)態(tài)更新和多環(huán)境配置。使用此注解會(huì)自動(dòng)加載Apollo中配置的屬性。

• @EnableConfigurationProperties

@EnableConfigurationProperties用于將外部配置轉(zhuǎn)換為Java對(duì)象。通過結(jié)合使用@ConfigurationProperties注解，Spring Boot可以將properties或YAML文件中的配置屬性映射到POJO（Plain Old Java Object）中，使得配置更加類型安全且易于管理。使用此注解通常用于啟用對(duì)特定配置類的支持。

• @EnableRetry

@EnableRetry是Spring Retry模塊中的注解，用于啟用重試機(jī)制。通過此注解，應(yīng)用程序可以借助Spring的重試機(jī)制在調(diào)用過程中自動(dòng)處理失敗的請(qǐng)求。這有助于提高系統(tǒng)的可靠性，尤其是在通過網(wǎng)絡(luò)調(diào)用外部服務(wù)時(shí)，可以有效地處理臨時(shí)性錯(cuò)誤。

• @EnableAsync

@EnableAsync用于啟用Spring的異步方法執(zhí)行。通過在某個(gè)方法上加上@Async注解，可以將該方法標(biāo)記為異步執(zhí)行。這意味著調(diào)用線程不會(huì)被阻塞，調(diào)用者可以繼續(xù)執(zhí)行其他任務(wù)。這在處理IO密集型操作或者耗時(shí)的處理任務(wù)時(shí)非常有用。啟用此注解后，需要確保有相應(yīng)的線程池配置，以避免線程資源耗盡。

2.3 核心代碼

import pers.niaonao.ErrorCode;
import pers.niaonao.BusinessException;
import lombok.extern.slf4j.Slf4j;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;

@Slf4j
@Service
public class HttpRetryService {

    @Retryable(maxAttempts = 3, backoff = @Backoff(delay = 1000, multiplier = 2))
    public Response execute(OkHttpClient client, Request request) throws BusinessException{
        try {
            Response response = client.newCall(request).execute();
            log.info("service res:{}", response.toString());
            if (response.code() != 200){
                log.error("service code not is 200");
                throw new BusinessException(ErrorCode.HTTP_ERROR);
            }
            return response;
        }catch (Exception e){
            log.error("服務(wù)調(diào)用異常", e);
            throw new BusinessException(ErrorCode.HTTP_ERROR);
        }
    }
}

@Retryable(maxAttempts = 3, backoff = @Backoff(delay = 1000, multiplier = 2))

該注解指明了當(dāng)方法調(diào)用失敗時(shí)，最多重試3次，每次重試之間的等待時(shí)間逐漸增加。初始延遲為1000毫秒，每次重試后乘以2，這意味著第二次重試后延遲2秒，第三次重試后延遲4秒。

總結(jié)

• Http調(diào)用：在execute方法中，使用OkHttpClient來發(fā)送HTTP請(qǐng)求。如果請(qǐng)求成功并且返回碼為200，則返回響應(yīng)。如果返回碼不是200，拋出一個(gè)自定義的BusinessException。

• 異常處理：若在調(diào)用過程中發(fā)生任何異常，將記錄錯(cuò)誤日志并拋出異常，以便重試機(jī)制能夠識(shí)別并執(zhí)行重試。

3. Spring 注解說明

3.1 @Retryable注解

import org.springframework.stereotype.Component;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Retryable {
    int maxAttempts() default 3; // 最大重試次數(shù)
    Backoff backoff() default @Backoff; // 重試間隔及倍數(shù)
}

3.2 @Backoff注解

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface Backoff {
    long delay() default 1000; // 延遲時(shí)間
    double multiplier() default 1; // 每次重試的倍數(shù)
}

4. 如何使用

在代碼中直接使用@Retryable注解標(biāo)記需要重試的方法，如之前的execute方法即可。當(dāng)調(diào)用該方法時(shí)，如果發(fā)生異常，它會(huì)根據(jù)配置自動(dòng)進(jìn)行重試。

5. 總結(jié)

本文展示了如何使用Spring注解在Java中實(shí)現(xiàn)HTTP調(diào)用的重試機(jī)制。通過@Retryable注解，我們能夠輕松地為任意方法中的HTTP調(diào)用增加重試功能，不僅實(shí)現(xiàn)了代碼的簡(jiǎn)潔性，也提高了系統(tǒng)的可靠性。使用這種設(shè)計(jì)模式后，開發(fā)者可以更專注于業(yè)務(wù)邏輯，而將錯(cuò)誤處理和重試機(jī)制的復(fù)雜性從業(yè)務(wù)代碼中剝離。

以上就是Java使用@Retryable注解實(shí)現(xiàn)HTTP請(qǐng)求重試的詳細(xì)內(nèi)容，更多關(guān)于Java @Retryable HTTP請(qǐng)求重試的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論