SpringBoot在一定时间内限制接口请求次数-接口防刷拦截

前一篇文字写了springboot的注册登录接口，并且这两个接口是开放的，特别是注册接口为了防止恶意注册，需要设置拦截。

需要用到的知识：注解、AOP、ExpiringMap（带有有效期的映射），需要自定义注解，把注解添加到我们的接口上。定义一个切面，执行方法前去ExpiringMap查询该IP在规定时间内请求了多少次，如超过次数则直接返回请求失败。

一、添加依赖

        <!-- expiringmap -->
        <dependency>
            <groupId>net.jodah</groupId>
            <artifactId>expiringmap</artifactId>
            <version>0.5.10</version>
        </dependency>

二、自定义注解@LimitRequest

package com.epwcloud.common.core.annotation;

import java.lang.annotation.*;

/**
 * 定义一个切面，执行方法前去ExpiringMap查询该IP在规定时间内请求了多少次，如超过次数则直接返回请求失败。
 * Created by 谭月浩 on 2021-11-21 17:03
 */
@Documented
@Target(ElementType.METHOD) // 说明该注解只能放在方法上面
@Retention(RetentionPolicy.RUNTIME)
public @interface LimitRequest {
    long time() default 6000; // 限制时间 单位：毫秒
    int count() default 3; // 允许请求的次数
}

三、自定义AOP切面

package com.epwcloud.common.core.aspect;

import com.epwcloud.common.core.annotation.LimitRequest;
import net.jodah.expiringmap.ExpirationPolicy;
import net.jodah.expiringmap.ExpiringMap;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;

/**
 * @author 谭月浩
 * @title: LimitRequestAspect
 * @projectName cdn
 * @description: 自定义AOP切面
 * @email yuehao.tan@epwcloud.cn
 * @date 2021/11/21 15:29
 */
@Aspect
@Component
public class LimitRequestAspect {

    private static ConcurrentHashMap<String, ExpiringMap<String, Integer>> book = new ConcurrentHashMap<>();

    // 定义切点
    // 让所有有@LimitRequest注解的方法都执行切面方法
    @Pointcut("@annotation(limitRequest)")
    public void excudeService(LimitRequest limitRequest) {
    }

    @Around("excudeService(limitRequest)")
    public Object doAround(ProceedingJoinPoint pjp, LimitRequest limitRequest) throws Throwable {

        // 获得request对象
        RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes sra = (ServletRequestAttributes) ra;
        HttpServletRequest request = sra.getRequest();

        // 获取Map对象， 如果没有则返回默认值
        // 第一个参数是key， 第二个参数是默认值
        ExpiringMap<String, Integer> uc = book.getOrDefault(request.getRequestURI(), ExpiringMap.builder().variableExpiration().build());
        Integer uCount = uc.getOrDefault(request.getRemoteAddr(), 0);


        if (uCount >= limitRequest.count()) { // 超过次数，不执行目标方法
            return "接口请求超过次数";
            //return JsonResult.error("请求次数过多，已经限制");
        } else if (uCount == 0) { // 第一次请求时，设置有效时间
//            /** Expires entries based on when they were last accessed */
//            ACCESSED,
//            /** Expires entries based on when they were created */
//            CREATED;
            uc.put(request.getRemoteAddr(), uCount + 1, ExpirationPolicy.CREATED, limitRequest.time(), TimeUnit.MILLISECONDS);
        } else { // 未超过次数， 记录加一
            uc.put(request.getRemoteAddr(), uCount + 1);
        }
        book.put(request.getRequestURI(), uc);

        // result的值就是被拦截方法的返回值
        Object result = pjp.proceed();

        return result;
    }

}

第一个静态Map是多线程安全的Map（ConcurrentHashMap），它的key是接口对于的url，它的value是一个多线程安全且键值对是有有效期的Map（ExpiringMap）。

ExpiringMap的key是请求的ip地址，value是已经请求的次数。

ExpiringMap更多的使用方法可以参考：ExpiringMap用法详解_Shandows_的博客-CSDN博客_expiringmap

四、添加注解

最后在方法上面加上@LimitRequest就行了

    @PreAuthorize("hasAuthority('sys:user:save')")
    @OperLog(value = "用户管理", desc = "添加", param = false, result = true)
    @ApiOperation("添加用户")
    @PostMapping()
    @LimitRequest(count = 3)
    public JsonResult add(@RequestBody User user) {
        user.setState(0);
        user.setPassword(userService.encodePsw(user.getPassword()));
        if (userService.saveUser(user)) {
            return JsonResult.ok("添加成功");
        }
        return JsonResult.error("添加失败");
    }