前言
为了实现频控,并且可插拔形式,那么AOP无疑是一个非常好的选择。
咱们这个Aspect实现依赖了redis
一、定义注解
今天咱们做一个简单的频控组件,可以实现某个接口针对某个用户某个时间段只能调用1次
注解如下:
@Inherited
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FrequencyControl {
String value(); //具体接口的唯一标志
long time() default 3; //时间数量
TimeUnit timeUnit() default TimeUnit.SECONDS; //时间单位
}
可以看到咱们的注解可以设置的参数为:
value:某个接口
time:时间范围值
timeUnit:时间单位
二、Aspect
定义一个Aspect来实现咱们想要的逻辑
@Aspect
@Component
public class FrequencyControlAspect {
@Autowired
private StringRedisTemplate stringRedisTemplate;
public static final String REDIS_VALUE = "LOCK";
@Around("@annotation(frequencyControl)")
private Object doFrequencyControl(ProceedingJoinPoint joinPoint, FrequencyControl frequencyControl) throws Throwable {
if (StringUtils.isBlank(frequencyControl.value())) {
return joinPoint.proceed();
}
String userNo = UserContextHolder.getStringUserId();
StringJoiner stringJoiner = new StringJoiner(":");
stringJoiner.add(userNo).add(frequencyControl.value());
String redisKey = stringJoiner.toString();
Boolean lockStatus = stringRedisTemplate.opsForValue().setIfAbsent(redisKey, REDIS_VALUE, frequencyControl.time(), frequencyControl.timeUnit());
if (!Boolean.TRUE.equals(lockStatus)) {
throw new BusinessException("操作过于频繁");
}
return joinPoint.proceed();
}
}
可以看到逻辑很简单,通过类上面加注解@Aspect,向Spring标明这是一个Aspect类,用@Around来设置切面,也就是joinPoint的集合。
方法名自定义,方法的入参,此处经过debug尝试,最多两个参数,一个Joinpoint,一个是@Around里面写的注解信息;或者只接受JoinPoint作为方法入参。
不过我们的Aspect实现逻辑需要用到用户设置的FrequencyControl注解信息。
三、使用示例
@FrequencyControl("category-create")
public ApiResponse createCategory(@Validated @RequestBody ApiRequest<CategoryDTO> request) {
// do something
return ApiResponse.newSuccessResponse();
}
我们简单的在controller的方法上进行了使用,来限制频控。
当然,可以利用redis实现更复杂的频控逻辑,譬如滑动窗口式的,利用定时任务往某个key里进行increase,然后调用的时候decrease,有点像简单的秒杀实现逻辑了。此处不再累赘
总结
利用AOP+redis实现一个简单的频控拦截器。