API 接口在指定时间内限流

前言

在请求的时候服务端通过redis记录每个ip在指定时间内请求的次数，如果在特定时间内超过限制次数，抛出异常，给前端返回响应信息。
本文为参考其他博客，由于没有及时保存原文章地址，所以无法放至原文连接，如原作者看到此篇文章，可以告知本人，一定及时添加原文地址，再次感谢原文博主。

自定义注解

import java.lang.annotation.*;

/**
 * 在 second 秒内，最大只能请求 maxCount 次，默认一秒30次
 */
@Documented
@Inherited
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestLimit {
    int second() default 1;

    int maxCount() default 30;
}

自定义拦截器

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.handler.HandlerInterceptorAdapter;

import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.lang.reflect.Method;
import java.util.concurrent.TimeUnit;

/**
 * 请求限制拦截
 */
@Component
public class RequestLimitIntercept extends HandlerInterceptorAdapter {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (handler.getClass().isAssignableFrom(HandlerMethod.class)) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Method method = handlerMethod.getMethod();
            RequestLimit methodAnnotation = method.getAnnotation(RequestLimit.class);
            RequestLimit classAnnotation = method.getDeclaringClass().getAnnotation(RequestLimit.class);
            RequestLimit requestLimit = methodAnnotation != null ? methodAnnotation : classAnnotation;
            if (requestLimit != null) {
                if (isLimit(request, requestLimit)) {
				    System.out.println("网络繁忙，请稍后重试！");//这个地方换成自己的给前端返回的方法，我用的是抛出自定义的异常
                    return false;
                }
            }
        }
        return super.preHandle(request, response, handler);
    }

    //判断请求是否受限
    public boolean isLimit(HttpServletRequest request, RequestLimit requestLimit) {
        // 受限的redis 缓存key ,这里用的是同一ip限制，可以换成用户id，或用户session。
        String limitKey = request.getServletPath() + "/" +IpUtil.getIpAddr(request);
        // 从缓存中获取，当前这个请求访问了几次
        Integer redisCount = (Integer) redisTemplate.opsForValue().get(limitKey);
        if (redisCount == null) {
            //初始 次数
            redisTemplate.opsForValue().set(limitKey, 1, requestLimit.second(), TimeUnit.SECONDS);
        } else {
            if (redisCount.intValue() >= requestLimit.maxCount()) {
                return true;
            }
            // 次数自增
            redisTemplate.opsForValue().increment(limitKey);
        }
        return false;
    }

}

注册拦截器

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 添加拦截
 */
@Component
public class WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    private RequestLimitIntercept requestLimitIntercept;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(requestLimitIntercept);
    }
}

controller测试

| 可以直接在类上或方法上添加注解 |

@RestController
@RequestMapping("/test")
@RequestLimit(second = 10, maxCount = 5)
public class TestController {

    @RequestMapping(value = "/testLimit", method = RequestMethod.GET)
//    @RequestLimit(second = 10, maxCount = 5)
    public ResponseBo testLimit() {
        return ResponseBo.success("成功");
    }

}