企业应用中，特别是商城网站，针对于某些API接口请求过于频繁作出某时间段限制访问次数，此文介绍的是通过注解+拦截器来实现限流。
- 自定义注解
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CurrentLimit {
/**
* 请求次数
*
* @return
*/
int number();
/**
* 时间限制
*
* @return
*/
long time();
}
- 限流拦截器
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.concurrent.TimeUnit;
import com.lei.tang.common.annotation.CurrentLimit;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
@Slf4j
@Component
public class CurrentLimitInterceptor implements HandlerInterceptor {
private final static String SEPARATOR = "-";
@Autowired
private RedisTemplate<String, Long> redisTemplate;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
if (handler instanceof HandlerMethod) {
HandlerMethod handlerMethod = (HandlerMethod) handler;
//通过HandlerMethod获取方法CurrentLimit注解
CurrentLimit currentLimit = handlerMethod.getMethodAnnotation(CurrentLimit.class);
//如果此方法存在限流注解
if (currentLimit != null) {
int number = currentLimit.number();
long time = currentLimit.time();
//如果次数和时间限制都大于0证明此处需要限流
if (time > 0 && number > 0) {
//这里的可以定义的是项目路径+API路径+ip，当然我这里就没去获取实际的ip了。key可以根据你们项目实际场景去设定
String key = request.getContextPath() + SEPARATOR + request.getServletPath() + SEPARATOR + "ip";
//获取reids缓存中的访问次数
Long numberRedis = redisTemplate.opsForValue().get(key);
//如果是第一次访问，则设置此ip访问此API次数为1，并设置失效时间为注解中的时间
if (null == numberRedis) {
redisTemplate.opsForValue().set(key, 1L, time, TimeUnit.SECONDS);
return true;
}
//如果访问次数大于注解设定则抛出异常
if (numberRedis >= number) {
throw new RuntimeException("请求频繁，请稍后重试！");
}
//如果满足限流条件则更新缓存次数
redisTemplate.opsForValue().set(key, numberRedis + 1);
}
}
}
return true;
}
}
- 将自定义的限流拦截器添加到WebMvcConfigurer中
import com.lei.tang.common.config.currentlimit.CurrentLimitInterceptor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Slf4j
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
@Autowired
private CurrentLimitInterceptor currentLimitInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
//此处也可以通过addPathPatterns方法添加此拦截器对部分请求路径有效，也可以通过excludePathPatterns过滤请求路径
registry.addInterceptor(currentLimitInterceptor);
}
}
- 测试
import com.lei.tang.common.annotation.CurrentLimit;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@Slf4j
@RestController
@RequestMapping("/currentLimit")
public class CurrentLimitController {
// 此处设置的是5秒内运行访问1次
@CurrentLimit(number = 1, time = 5)
@GetMapping("/test")
public String test() {
return "正常访问";
}
}
如有不到之处，欢迎各位留言指正，不慎感激。
更多文章：
点击跳转CSDN博客
点击跳转简书博客
公众号：代码小搬运
扫码关注代码小搬运公众号
