使用Redis实现接口限流

1.为什么需要API限流

对于当前互联网环境下，用户是一个庞大的群体，对于一些热点接口，无时无刻都会收到前端发送的请求。在不同的网络环境下以及网络波动的环境中，对于普通用户来说，当一个接口出现相应的卡顿时，用户可能会短时间内大量点击发送请求的按钮，造成大量的不必要请求的发送。与此同时，也存在一些目的不纯的用户，写一些脚本来对某个接口进行短时间的大量访问。这些情况很有可能造成服务器的压力过大而导致宕机。所以我们需要在一些热点接口上做一些流量现流的操作，保证接口的安全与稳定。

2.限流的思路

1.包含的工具

自定义注解，拦截器，redis

2.实现方式

可以使用自定义注解的方式（定义在一段时间的最大访问次数），配合redis（用户每发送一次请求，则会在redis中做加一操作），并使用拦截器对用户的访问次数进行判断，判断访问的次数是否到达最大访问次数。

3.代码实现

1.自定义注解的实现

首先定义一个自定义的注解，用于标识在 多长时间 可以 最多访问多少次 。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AccessLimitAnnotation {

    //默认10秒最多访问10次
    int seconds() default 10;

    int maxCount() default 10;
}

2.定义拦截器

实现HandlerInterceptor，并且重写preHandle方法，通过HandlerMethod获取到对应的注解，然后进行判断。

@Component
public class AccessLimitInterceptor implements HandlerInterceptor {

    @Autowired
    RedisTemplate redisTemplate;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if(handler instanceof HandlerMethod){
            HandlerMethod hd = (HandlerMethod) handler;
            AccessLimitAnnotation methodAnnotation = hd.getMethodAnnotation(AccessLimitAnnotation.class);
            if(methodAnnotation==null){
                return true;
            }
            //过期时间
            int second = methodAnnotation.seconds();
            //最大访问量
            int maxCount = methodAnnotation.maxCount();
			//获取用户的IP地址
            String ip = request.getRemoteAddr();
			//获取用户访问的URL
            String url = request.getRequestURI();
			//将IP和URL进行拼接（ip:url），作为即将存入redis的Key
            String key = ip + ":" + url;
			//获取redis中以存入的访问IP和URL的Key对应的访问次数
            Long count = (Long) redisTemplate.opsForValue().get(key);
			//判断访问用户是否是第一次访问
            if(count == null || count == -1){
            	//如果用户是第一次访问，则存入，并且设置访问次数为1以及过期时间
                redisTemplate.opsForValue().set(key, 1, second, TimeUnit.SECONDS);
            }else{
            	//如果有值则判断是否大于最大访问次数，若大于等于则直接返回
                if(count < maxCount){
                    redisTemplate.opsForValue().increment(count);
                }else{
                    return false;
                }
            }
        }
        return true;
    }
}

3.添加拦截器

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    AccessLimitInterceptor accessLimitInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(accessLimitInterceptor).addPathPatterns("/**");
    }
}