如何使用Spring Boot整合RateLimiter限流

在现代的分布式系统中，限流（Rate Limiting）是一种常见的保护机制，用于控制系统的请求流量，防止系统因过载而崩溃。Google的Guava库提供了一个简单而强大的限流工具——RateLimiter。本文将介绍如何在Spring Boot项目中整合RateLimiter，以实现对API请求的限流。

1. 引入依赖

首先，我们需要在Spring Boot项目中引入Guava库的依赖。在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>31.0.1-jre</version>
</dependency>

2. 创建RateLimiter Bean

接下来，我们需要在Spring Boot中创建一个RateLimiter Bean。可以在配置类中定义这个Bean，并设置每秒允许的请求数（QPS）。

import com.google.common.util.concurrent.RateLimiter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class RateLimiterConfig {

    @Bean
    public RateLimiter rateLimiter() {
        // 每秒允许2个请求
        return RateLimiter.create(2.0);
    }
}

3. 使用RateLimiter进行限流

在需要限流的地方，我们可以通过注入RateLimiter Bean，并使用tryAcquire()方法来控制请求的速率。如果请求被允许，tryAcquire()方法会立即返回true，否则返回false。

import com.google.common.util.concurrent.RateLimiter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ApiController {

    @Autowired
    private RateLimiter rateLimiter;

    @GetMapping("/api")
    public String api() {
        if (rateLimiter.tryAcquire()) {
            // 处理请求
            return "Request processed";
        } else {
            // 请求被限流
            return "Too many requests";
        }
    }
}

4. 处理限流后的响应

当请求被限流时，我们可以返回一个自定义的错误响应，比如HTTP状态码429 Too Many Requests。可以通过Spring的ResponseEntity来实现这一点。

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ApiController {

    @Autowired
    private RateLimiter rateLimiter;

    @GetMapping("/api")
    public ResponseEntity<String> api() {
        if (rateLimiter.tryAcquire()) {
            // 处理请求
            return ResponseEntity.ok("Request processed");
        } else {
            // 请求被限流
            return ResponseEntity.status(HttpStatus.TOO_MANY_REQUESTS).body("Too many requests");
        }
    }
}

5. 测试限流效果

启动Spring Boot应用后，可以通过多次访问/api接口来测试限流效果。当请求速率超过设定的QPS时，将会收到429 Too Many Requests的响应。

6. 高级用法

RateLimiter还支持更复杂的限流策略，比如预热模式（Warmup Rate Limiter），可以在系统启动时逐步增加请求速率，避免瞬间流量冲击。

@Bean
public RateLimiter rateLimiter() {
    // 预热模式，每秒允许2个请求，预热时间为10秒
    return RateLimiter.create(2.0, 10, TimeUnit.SECONDS);
}

7. 总结

通过整合RateLimiter，我们可以轻松地在Spring Boot应用中实现请求限流，保护系统免受过载的影响。RateLimiter不仅简单易用，还支持多种限流策略，适用于不同的业务场景。希望本文能帮助你更好地理解和应用限流技术。