Java使用@Retryable注解實現HTTP請求重試

更新時間：2024年10月20日 08:42:16 作者：niaonao

HTTP調用是Java應用與外部API進行交互時重要的訪問方式之一,為了確保在遇到臨時性問題時能自動重試,我們可以設計一個靈活的重試機制,在Java中,我們可以通過注解來實現這一功能,文將介紹如何使用注解@Retryable來實現HTTP調用的重試機制,需要的朋友可以參考下

1. 引言

在應用程序中，網絡請求可能會因為各種原因（如網絡不穩(wěn)定、服務器故障等）而失敗。為了提高系統(tǒng)的可靠性，通常需要實現一個重試機制。

HTTP調用是Java應用與外部API進行交互時重要的訪問方式之一。為了確保在遇到臨時性問題時能自動重試，我們可以設計一個靈活的重試機制。

在Java中，我們可以通過注解來實現這一功能，從而簡化代碼并增強可讀性。本文將介紹如何使用注解@Retryable來實現HTTP調用的重試機制，以應對網絡交互中的不確定性。

2. 核心代碼解析

2.1 POM依賴

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

2.2 SpringBoot啟動類注解

此處順便介紹了幾個常用注解。不是本次介紹的重點。關注@EnableRetry注解即可。

@SpringBootApplication為應用提供基本配置，@EnableApolloConfig和@EnableConfigurationProperties用于配置管理，@EnableRetry增強了網絡請求的穩(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是一個組合注解，通常用于Spring Boot應用的主類。包括下面三個注解。

@Configuration：表明該類是一個配置類，Spring會從這個類中讀取配置信息。

@EnableAutoConfiguration：啟用Spring Boot的自動配置功能，根據添加的依賴自動配置Spring應用。

@ComponentScan：啟用組件掃描，允許Spring查找合適的組件、配置和服務。

@EnableApolloConfig

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

@EnableConfigurationProperties

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

@EnableRetry

@EnableRetry是Spring Retry模塊中的注解，用于啟用重試機制。通過此注解，應用程序可以借助Spring的重試機制在調用過程中自動處理失敗的請求。這有助于提高系統(tǒng)的可靠性，尤其是在通過網絡調用外部服務時，可以有效地處理臨時性錯誤。

@EnableAsync

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

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("服務調用異常", e);
            throw new BusinessException(ErrorCode.HTTP_ERROR);
        }
    }
}

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

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

總結

Http調用：在execute方法中，使用OkHttpClient來發(fā)送HTTP請求。如果請求成功并且返回碼為200，則返回響應。如果返回碼不是200，拋出一個自定義的BusinessException。
異常處理：若在調用過程中發(fā)生任何異常，將記錄錯誤日志并拋出異常，以便重試機制能夠識別并執(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; // 最大重試次數
    Backoff backoff() default @Backoff; // 重試間隔及倍數
}

3.2 @Backoff注解

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

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

4. 如何使用

在代碼中直接使用@Retryable注解標記需要重試的方法，如之前的execute方法即可。當調用該方法時，如果發(fā)生異常，它會根據配置自動進行重試。

5. 總結

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

以上就是Java使用@Retryable注解實現HTTP請求重試的詳細內容，更多關于Java @Retryable HTTP請求重試的資料請關注腳本之家其它相關文章！

您可能感興趣的文章: