### 如何使用 Redis
实现自定义注解进行接口
限流
#### 准备工作
为了
实现基于Redis的接口
限流，需先完成必要的环境准备。这包括引入所需的依赖库并配置好Redis连接池。
```xml
<!-- Maven Dependency -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>org.redisson</groupId>
<artifactId>redisson-spring-boot-starter</artifactId>
</dependency>
```
#### 创建
限流注解
定义一个名为`@
RateLimit`的
自定义注解用于标记需要
限流的方法或类[^1]。
```java
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface
RateLimit {
int limit() default 100; // 默认每分钟最多允许访问次数
String keyPrefix() default "rate_limit:"; // redis键前缀
}
```
#### 定制 `RedisTemplate`
为了让后续操作更加便捷高效，建议对默认提供的`RedisTemplate`做适当扩展，以便更好地支持
限流逻辑中的原子性计数需求[^3]。
```java
@Configuration
public class CustomRedisConfig {
@Bean
public RedisTemplate<String, Object> customRedisTemplate(LettuceConnectionFactory connectionFactory) {
RedisTemplate<String, Object> template = new RedisTemplate<>();
template.setConnectionFactory(connectionFactory);
Jackson2JsonRedisSerializer<Object> jacksonSer = new Jackson2JsonRedisSerializer<>(Object.class);
ObjectMapper om = new ObjectMapper();
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jacksonSer.setObjectMapper(om);
template.setValueSerializer(jacksonSer);
template.afterPropertiesSet();
return template;
}
}
```
#### 开发 Lua 脚本
编写一段Lua脚本来执行
限流判断逻辑，并将其注册到Spring上下文中供后续调用[^4]。
```lua
-- lua script for rate limiting
local function tryAcquire(key, maxCount, timeWindowInSeconds)
local currentTimestamp = tonumber(redis.call('time')[1])
-- Remove expired entries from sorted set
redis.call("ZREMRANGEBYSCORE", key, 0, currentTimestamp - timeWindowInSeconds)
-- Get the number of elements within the specified window
local count = tonumber(redis.call("ZCARD", key))
if count >= maxCount then
return false
end
-- Add a new entry with timestamp as score
redis.call("ZADD", key, currentTimestamp, currentTimestamp)
redis.call("EXPIRE", key, timeWindowInSeconds)
return true
end
return tryAcquire(KEYS[1], ARGV[1], ARGV[2])
```
#### 解析
注解与
应用 AOP 切面
通过
AOP切面对标注有`@
RateLimit`的目标方法实施环绕通知，在实际调用之前检查当前请求是否满足速率限制条件[^2]。
```java
@Aspect
@Component
@Slf4j
public class
RateLimiterAspect {
private final RedissonClient redissonClient;
public
RateLimiterAspect(RedissonClient redissonClient){
this.redissonClient=redissonClient;
}
@Around("@annotation(
rateLimit)")
public Object around(ProceedingJoinPoint joinPoint,@Annotation
RateLimit rateLimit)throws Throwable{
MethodSignature signature=(MethodSignature)joinPoint.getSignature();
Class<?> targetClass=signature.getMethod().getDeclaringClass();
String methodName=signature.getName();
RScript script=this.redissonClient.getScript();
List<Object> args=Collections.singletonList(joinPoint.getArgs());
String uniqueKey=
rateLimit.keyPrefix()
+targetClass.getSimpleName()
+"."
+methodName
+"_"
+args.hashCode();
Boolean result=(Boolean)script.eval(
RScript.Mode.READ_WRITE,
getLuaScript(),
RScript.ReturnType.BOOLEAN,
Collections.singletonList(uniqueKey),
Arrays.asList(String.valueOf(
rateLimit.limit()),String.valueOf(60))
);
if(!result){
throw new TooManyRequestsException("Too many requests");
}
return joinPoint.proceed();
}
private static String getLuaScript(){
StringBuilder sb=new StringBuilder();
// ... (insert your Lua code here)
return sb.toString();
}
}
```
####
自定义异常处理
当超过设定阈值时抛出
自定义异常告知客户端已达到最大访问频率。
```java
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(value = TooManyRequestsException.class)
public ResponseEntity handleTooManyRequestExceptions(Exception e){
log.error(e.getMessage(),e);
return ResponseEntity.status(HttpStatus.TOO_MANY_REQUESTS).body(new ErrorResult("Error","You have exceeded maximum allowed request frequency"));
}
}
class ErrorResult {
private String status;
private String message;
public ErrorResult(String status, String message) {
this.status=status;
this.message=message;
}
// getters and setters...
}
```
#### 测试结果验证
最后一步是对整个流程进行全面的功能性和压力测试，确保方案能够稳定运行并且具备良好的性能表现。
---
最低0.47元/天 解锁文章
扫一扫
424
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
