SpringBoot实现重试调用第三方API

在实际的应用中,我们经常需要调用第三方API来获取数据或执行某些操作。然而,由于网络不稳定、第三方服务异常等原因,API调用可能会失败。为了提高系统的稳定性和可靠性,我们通常会考虑实现重试机制。

重试机制的必要性

  • 提高系统的稳定性:在面对临时性故障时,通过重试机制可以减轻对系统的影响,确保服务的可用性。
  • 降低因故障而导致的用户体验差:用户可能无法感知到一次短暂的故障,而重试机制可以在不干扰用户操作的情况下自动修复问题。

废话不多说,直接开整。

Spring Retry是Spring框架提供的一个模块,它通过提供注解或编程方式的方式,帮助我们实现方法级别的重试机制。在Spring Boot中,可以很方便地集成并使用Spring Retry。


    org.springframework.retry
    spring-retry

同步重试 、降级

@Retryable

import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;

@Service
public class ThirdPartyService {

    @Retryable(
        value = { RestClientException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2)
    )
    public String callThirdPartyApi() {
        // 调用第三方API的逻辑
        // ...
    }
}

在上述示例中,@Retryable注解标记了callThirdPartyApi方法,指定了当发生RestClientException异常时进行重试。maxAttempts指定最大重试次数,backoff指定了重试间隔的初始延迟和延迟倍数。 

@Recover

import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;

@Service
public class ThirdPartyService {

    @Retryable(
        value = { RestClientException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2)
    )
    public String callThirdPartyApi() {
        // 调用第三方API的逻辑
        // ...
    }

    @Recover
    public String fallback() {
        // 降级处理逻辑
        // ...
    }
}

在上述示例中,@Recover注解标记了fallback方法,当callThirdPartyApi方法的重试次数达到上限时,将执行fallback方法中的降级逻辑。

异步重试 、降级

import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;

@Service
public class AsyncThirdPartyService {

    @Async
    @Retryable(
        value = { RestClientException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2)
    )
    public CompletableFuture callAsyncThirdPartyApi() {
        // 异步调用第三方API的逻辑
        // ...
    }
}

在上述示例中,通过@Async注解表示callAsyncThirdPartyApi方法是异步的,同时使用@Retryable配置了异步方法的重试策略。

import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;

@Service
public class AsyncThirdPartyService {

    @Async
    @Retryable(
        value = { RestClientException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2)
    )
    public CompletableFuture callAsyncThirdPartyApi() {
        // 异步调用第三方API的逻辑
        // ...
    }

    @Recover
    public CompletableFuture fallback() {
        // 异步降级处理逻辑
        // ...
    }
}

在上述示例中,使用@Recover标记的fallback方法同样支持异步,以处理异步方法的降级逻辑。 

注意@Async得在启动类中加上@EnableAsync才能生效

异常分类与重试

在实际应用中,我们可能会遇到不同类型的异常,有些异常是可以通过重试来解决的,而有些异常则需要特殊处理。Spring Retry支持通过include和exclude属性来指定要进行重试的异常类型和要排除的异常类型。

1.重试指定类型的异常

import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;

@Service
public class ThirdPartyService {

    @Retryable(
        value = { RestClientException.class, TimeoutException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2)
    )
    public String callThirdPartyApi() {
        // 调用第三方API的逻辑
        // ...
    }
}

在上述示例中,callThirdPartyApi方法会在发生RestClientExceptionTimeoutException异常时进行重试。

2.排除指定类型的异常

import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;

@Service
public class ThirdPartyService {

    @Retryable(
        value = { RestClientException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 1000, multiplier = 2),
        exclude = { TimeoutException.class }
    )
    public String callThirdPartyApi() {
        // 调用第三方API的逻辑
        // ...
    }
}

在上述示例中,callThirdPartyApi方法会在发生RestClientException异常时进行重试,但排除了TimeoutException异常。

使用断路器实现熔断机制

除了重试机制外,熔断机制也是一种常见的容错处理手段。Hystrix是一款流行的断路器实现库,可以与Spring Boot集成,用于实现熔断机制。


    org.springframework.cloud
    spring-cloud-starter-netflix-hystrix

在启动类中加上@EnableHystrix才会生效

import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;

@Service
public class ThirdPartyService {

    @HystrixCommand(fallbackMethod = "fallback")
    public String callThirdPartyApi() {
        // 调用第三方API的逻辑
        // ...
    }

    public String fallback() {
        // 熔断时的降级逻辑
        // ...
    }
}

在上述示例中,通过@HystrixCommand注解标记了callThirdPartyApi方法,指定了熔断时执行的降级方法fallback。

在引入重试机制后,我们需要对系统的性能进行全面的测试和分析,以确保重试机制的引入不会影响系统的整体性能。可以通过压力测试工具模拟高并发的情况,观察系统在异常情况下的表现。

你可能感兴趣的:(【Java日常工作篇】,spring,boot,后端,java,maven)