当前位置：首页 > article >正文

SpringBoot+Resilience4j实现接口限流

article 2025/3/1 9:23:47

在 Spring Boot 项目中使用 Resilience4j 实现接口限流可以通过以下步骤完成。Resilience4j 是一个用于实现熔断、限流、重试等功能的轻量级库。

步骤 1: 添加依赖

在你的 pom.xml 文件中添加 Resilience4j 依赖。

<dependency>
    <groupId>io.github.resilience4j</groupId>
    <artifactId>resilience4j-spring-boot2</artifactId>
    <version>1.7.1</version> <!-- 请根据需要选择合适的版本 -->
</dependency>

步骤 2: 配置限流

在 application.yml 或 application.properties 中配置限流参数。以下是 YAML 格式的示例配置：

resilience4j:
  rate-limiter:
    instances:
      myRateLimiter:
        limitForPeriod: 10       # 每 1 秒允许的请求数
        limitForBurst: 5         # 突发请求允许的最大数量
        limitRefreshPeriod: 1s    # 限制刷新周期

步骤 3: 创建服务类

在服务类中使用 @RateLimiter 注解来定义限流逻辑。

步骤 4: 创建控制器

创建一个控制器来调用带有限流的服务方法。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    private final MyService myService;

    public MyController(MyService myService) {
        this.myService = myService;
    }

    @GetMapping("/limited")
    public String limitedEndpoint() {
        return myService.limitedMethod();
    }
}

步骤 5: 处理限流异常

当请求超过限流限制时，Resilience4j 会抛出 RequestNotPermittedException。我们可以通过全局异常处理器来处理这个异常。

import io.github.resilience4j.ratelimiter.RequestNotPermitted;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(RequestNotPermitted.class)
    public ResponseEntity<String> handleRequestNotPermitted(RequestNotPermitted ex) {
        return ResponseEntity.status(HttpStatus.TOO_MANY_REQUESTS)
                             .body("Request limit exceeded, please try again later.");
    }
}