SpringBoot 接口访问频率限制

功能说明

可以通过注解快速实现类似10分钟内仅可以搜索3次，以及N分钟尝试登陆多次即被禁止一小时等类似功能。

第一步：添加Maven依赖

<dependency>
    <groupId>io.github.liuye744</groupId>
    <artifactId>simpleAuth-spring-boot-starter</artifactId>
    <version>0.4.0.RELEASE</version>
</dependency>

第二步：为Controller添加注解

可以为整个Controller添加，也可以为Controller中单个方法添加。访问失败则会抛出AccessIsRestrictedException

注解参数说明

public @interface IsLimit {
    //限制访问次数
    int value() default 100;

    //记录限制的时间
    int seconds() default 300;

    //超过访问限制之后被禁止的时间
    int ban() default 0;

    //用户标志的生成策略
    Class<? extends SignStrategic> signStrategic() default DefaultSignStrategic.class;

    //访问控制的接口标志的名称(默认为接口的全限定名)
    String item() default "";

    //此次访问是否有效（是否被记录）
    Class<? extends EffectiveStrategic> effectiveStrategic() default DefaultEffectiveStrategic.class;

    //是否在Controller返回后运行effectiveStrategic
    boolean judgeAfterReturn() default true;
}

用例1：10分钟内只允许访问5次，超过之后将会被禁止10分钟

@RestController
public class MyController {
    @GetMapping("say")
    @IsLimit(value = 5, seconds = 600, ban = 600)
    public String say(){
        return "Hello World";
    }
}

用例2：同一个接口传递不同的参数访问次数分别计算

传递的参数不同访问限制不同(例如想要每隔一段时间每个资源只能点赞N次)

@RestController
public class MyController {
    @GetMapping("say")
    @IsLimit(signStrategic = MySignStrategic.class)
    public String say(String str){
        return "Hello World";
    }
}
public class MySignStrategic extends SignStrategic {
    @Override
    public String sign(HttpServletRequest request, ProceedingJoinPoint joinPoint) {
        final Object[] args = joinPoint.getArgs();
        final Signature signature = joinPoint.getSignature();
        //将参数拼接到用户sign中，保证每个用户传递不同的参数标志不相同
        StringBuilder sb = new StringBuilder();
        sb.append(signature);
        for (Object arg : args) {
            sb.append(arg.toString());
        }
        System.out.println(sb);
        return sb.toString();
    }
}

用例3：当返回"success"时才记录数据

@RestController
public class MyController {
    @GetMapping("say")
    @IsLimit(effectiveStrategic = MyEffectiveStrategic.class)
    public String say(String str){
        if (str.length()>3 && str.length()<12){
            return "success";
        }else {
            return "fail";
        }
    }
}

public class MyEffectiveStrategic extends EffectiveStrategic {
    @Override
    public Boolean effective(HttpServletRequest request, ProceedingJoinPoint joinPoint, Object result) {
        String myResult = (String)result;
        return "success".equals(myResult);
    }
}

用例4：自定义访问控制

//全局访问控制
@Component
public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        final String addr = request.getRemoteAddr();
        //以用户的地址作为标志，每5分钟(300s)只允许访问2次，超过之后被禁止10分钟
        //addRecord方法调用后可以访问则返回true,禁止访问返回false
        return LimitInfoUtil.addRecord("GLOBAL_ACCESS_CONTROL", addr, 2, 300, 600);
    }
}
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/*");
    }
}