构建健壮的Java应用：使用@Retryable注解实现HTTP请求重试

niaonao

已于 2024-10-18 10:54:05 修改

阅读量1k

点赞数 27

CC 4.0 BY-SA版权

分类专栏： [Java] Java [Java] API [软件工程] 框架文章标签： java http 开发语言

于 2024-10-18 10:32:16 首次发布

本文链接：https://blog.csdn.net/niaonao/article/details/143036310

[Java] Java 同时被 3 个专栏收录

40 篇文章

订阅专栏

[软件工程] 框架

18 篇文章

订阅专栏

[Java] API

15 篇文章

订阅专栏

1. 引言

在应用程序中，网络请求可能会因为各种原因（如网络不稳定、服务器故障等）而失败。为了提高系统的可靠性，通常需要实现一个重试机制。

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增强了网络请求的稳定性，而@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);
    }

}

1. @SpringBootApplication是一个组合注解，通常用于Spring Boot应用的主类。包括下面三个注解。

@Configuration：表明该类是一个配置类，Spring会从这个类中读取配置信息。

@EnableAutoConfiguration：启用Spring Boot的自动配置功能，根据添加的依赖自动配置Spring应用。

@ComponentScan：启用组件扫描，允许Spring查找合适的组件、配置和服务。

1. @EnableApolloConfig

@EnableApolloConfig是Apollo配置中心的注解，用于在Spring Boot应用中启用Apollo的配置管理。Apollo是一个开源的配置管理中心，能够帮助开发者管理应用的配置，支持动态更新和多环境配置。使用此注解会自动加载Apollo中配置的属性。

1. @EnableConfigurationProperties

@EnableConfigurationProperties用于将外部配置转换为Java对象。通过结合使用@ConfigurationProperties注解，Spring Boot可以将properties或YAML文件中的配置属性映射到POJO（Plain Old Java Object）中，使得配置更加类型安全且易于管理。使用此注解通常用于启用对特定配置类的支持。

1. @EnableRetry

@EnableRetry是Spring Retry模块中的注解，用于启用重试机制。通过此注解，应用程序可以借助Spring的重试机制在调用过程中自动处理失败的请求。这有助于提高系统的可靠性，尤其是在通过网络调用外部服务时，可以有效地处理临时性错误。

1. @EnableAsync

@EnableAsync用于启用Spring的异步方法执行。通过在某个方法上加上@Async注解，可以将该方法标记为异步执行。这意味着调用线程不会被阻塞，调用者可以继续执行其他任务。这在处理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秒。

2.4 调用示例

获取百度API令牌

@Service
@Slf4j
public class BaiduService {
    private String apiUrl = "https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id={client_id}&client_secret={client_secret}}";

    @Resource
    private HttpRetryService httpRetryService;
    
    /**
     * 获取百度令牌
     */
    public String getAccessToken() throws IOException {
        okhttp3.OkHttpClient client= new okhttp3.OkHttpClient.Builder()
                .readTimeout(readTimeout, TimeUnit.SECONDS)
                .connectTimeout(connectTimeout, TimeUnit.SECONDS)
                .build();
        RequestBody requestBody = RequestBody.create(JSON, StringUtils.EMPTY);
        Request requestOpenai = new Request.Builder()
                .url(apiUrl)
                .post(requestBody)
                .build();

        // 此处发起http调用，内部支持失败重试，提高可用性
        Response response= httpRetryService.execute(client, requestOpenai);
        String responseBody = response.body().string();
        log.info("BaiduService accessTokenRes:{}", responseBody);
        if (response.code() != 200){
            throw new BusinessException(ErrorCode.HTTP_ERROR);
        }
        AccessTokenRes accessTokenRes = JSONUtil.toBean(responseBody, AccessTokenRes.class);
        if (StringUtils.isNotEmpty(accessTokenRes.getError())) {
            throw new BusinessException(ErrorCode.HTTP_ERROR);
        }
        return accessTokenRes.getAccess_token();
    }

    @Data
    class AccessTokenRes {
        String error;
        String error_description;
        String access_token;
        String expires_in;
    }
}

总结

Http调用：在execute方法中，使用OkHttpClient来发送HTTP请求。如果请求成功并且返回码为200，则返回响应。如果返回码不是200，抛出一个自定义的BusinessException。
异常处理：若在调用过程中发生任何异常，将记录错误日志并抛出异常，以便重试机制能够识别并执行重试。

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方法即可。当调用该方法时，如果发生异常，它会根据配置自动进行重试。

5. 总结

本文展示了如何使用Spring注解在Java中实现HTTP调用的重试机制。通过@Retryable注解，我们能够轻松地为任意方法中的HTTP调用增加重试功能，不仅实现了代码的简洁性，也提高了系统的可靠性。使用这种设计模式后，开发者可以更专注于业务逻辑，而将错误处理和重试机制的复杂性从业务代码中剥离。