SpringBoot整合resilience4j实现接口限流

最近在开发项目的时候，需要用到限流的功能，搜索资料发现，最近resilience4j这个框架还是挺火的，使用了一下还是挺简单实用的。这篇博客主要是SpringBoot简单整合resilience4j框架实现接口限流功能。

Resilience4j是一个用于增强容错能力的Java库，旨在帮助开发人员构建可靠的分布式系统。它基于断路器模式和其他容错模式，提供了一组轻量级的、可组合的容错模块，如断路器、限流器、重试等。其原理如下：

• 断路器模式：Resilience4j主要基于断路器模式，当被保护的服务或资源发生故障或长时间不可用时，断路器会打开，从而避免对该服务的连续请求，减轻了服务的负载，快速失败，同时能够提供降级或备用方案。
• 限流器模式：Resilience4j提供了限流器模式来控制请求的流量。限流器可以被配置为每秒钟、每分钟或每小时允许的最大请求数。当请求数超出限制时，可以选择拒绝请求、返回错误信息或放入队列等处理方式。
• 重试机制：Resilience4j提供了灵活的重试机制，可以在服务调用失败时自动重试，减少因临时故障造成的服务不可用时间。可以配置重试的次数、重试的间隔等参数，还可以根据不同的异常类型进行针对性的重试。
• 异步支持：Resilience4j支持异步操作，可以在异步任务中使用各种容错模块。可以使用CompletableFuture、RxJava或Java 8的CompletionStage进行异步编程。
• 配置灵活：Resilience4j提供了灵活的配置选项，可以根据具体的需求对每个容错模块进行个性化配置。可以通过代码或者配置文件进行配置，也可以使用注解来标记需要增加容错功能的方法。

总之，Resilience4j利用断路器模式、限流器模式、重试机制等容错模式，结合灵活的配置选项和异步支持，帮助开发人员构建可靠、弹性的分布式系统。

这里Resilience4j只简单实现接口限流功能。

版本说明

• SpringBoot 2.5.15版本
• JDK8

代码开发整合

引入Jar

 <dependency>
      <groupId>io.github.resilience4j</groupId>
      <artifactId>resilience4j-spring-boot2</artifactId>
      <version>1.7.1</version>
  </dependency>

  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
  </dependency>

引入Jar包特别要注意版本，我的SpringBoot版本是2.5.15，所以我的resilience4j使用的是spring-boot2版本，且resilience4j-spring-boot2必须不能高于1.7.1，不然不兼容。

第二还要注意引入spring-boot-starter-aop，不然resilience4j不能起作用，毕竟它是通过AOP来实现功能的。

application配置

resilience4j: # resilience4j的配置开始，用于增加服务弹性的库
  ratelimiter: #限流机制的配置，用于防止过多的请求涌入系统
    instances:
      ratelimitApi: # 第一个限流策略实例的名称
        limit-for-period: 5 # 在一个特定的时间周期内，允许的最大请求数量为5
        limit-refresh-period: 1s # 时间周期长度为1s，即每秒会重置请求计数
        timeout-duration: 100ms # 当请求超过限制时，客户端应立即收到超时的响应，而不等待处理

控制器实现

@RestController
@Slf4j
public class Resilience4jController {

    @GetMapping("ratelimit")
    @RateLimiter(name="ratelimitApi",fallbackMethod = "fallback")
    public ResponseEntity<String> ratelimitApi(){
        log.info("request ratelimitApi");
        return new ResponseEntity<>("success",HttpStatus.OK);
    }

    public ResponseEntity fallback(Throwable e){
        log.error("fallback exception , {}",e.getMessage());
        return new ResponseEntity<>("您请求过于频繁，稍后再试",HttpStatus.OK);
    }
}

ratelimitApi是在application.yml中配置的名称，从这里也可以知道，不同的接口可以使用不同的限流策略，fallbackMethod是指当出现异常的时候调用的方法，即为降级服务方法。

多线程测试

import org.springframework.web.client.RestTemplate;

public class ThreadTest {
    public static void main(String[] args) {
        for(int i=0;i<5;i++){
            new Thread(()->{
                System.out.println(new RestTemplate().getForObject("http://localhost:8080/ratelimit",String.class));
            }).start();
        }
    }
}

限流设定是每秒只能处理5个请求，所以我这边用5个线程的时候，都是正常的

success
success
success
success
success

之后我调整为6个线程

success
success
success
success
success
您请求过于频繁，稍后再试

最后一个线程无法正常请求，实现效果。

Resilience4j还有其他强大的功能，等我慢慢研究一下。