基于注解实现 SpringBoot 接口防刷的方法


Posted in Python onMarch 02, 2021

该示例项目通过自定义注解,实现接口访问次数控制,从而实现接口防刷功能,项目结构如下:

基于注解实现 SpringBoot 接口防刷的方法

一、编写注解类 AccessLimit

package cn.mygweb.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 访问控制注解(实现接口防刷功能)
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AccessLimit {
  /**
   * 限制周期(单位为秒)
   *
   * @return
   */
  int seconds();

  /**
   * 规定周期内限制次数
   *
   * @return
   */
  int maxCount();

  /**
   * 是否需要登录
   *
   * @return
   */
  boolean needLogin() default false;
}

二、在Interceptor拦截器中实现拦截逻辑

package cn.mygweb.interceptor;

import cn.mygweb.annotation.AccessLimit;
import cn.mygweb.entity.Result;
import cn.mygweb.entity.StatusCode;
import com.alibaba.fastjson.JSON;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Map;

/**
 * 访问控制拦截器
 */
@Component
public class AccessLimitInterceptor extends HandlerInterceptorAdapter {

  //模拟数据存储,实际业务中可以自定义实现方式
  private static Map<String, AccessInfo> accessInfoMap = new HashMap<>();

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
               Object handler) throws Exception {
    //判断请求是否属于方法的请求
    if (handler instanceof HandlerMethod) {
      HandlerMethod hm = (HandlerMethod) handler;

      //获取方法中的注解,看是否有该注解
      AccessLimit accessLimit = hm.getMethodAnnotation(AccessLimit.class);
      if (accessLimit == null) {
        return true;
      }
      int seconds = accessLimit.seconds();
      int maxCount = accessLimit.maxCount();
      boolean needLogin = accessLimit.needLogin();
      String key = request.getRequestURI();
      //如果需要登录
      if (needLogin) {
        //获取登录的session进行判断
        //……
        key += " " + "userA";//这里假设用户是userA,实际项目中可以改为userId
      }

      //模拟从redis中获取数据
      AccessInfo accessInfo = accessInfoMap.get(key);
      if (accessInfo == null) {
        //第一次访问
        accessInfo = new AccessInfo();
        accessInfo.setFirstVisitTimestamp(System.currentTimeMillis());
        accessInfo.setAccessCount(1);
        accessInfoMap.put(key, accessInfo);
      } else if (accessInfo.getAccessCount() < maxCount) {
        //访问次数加1
        accessInfo.setAccessCount(accessInfo.getAccessCount() + 1);
        accessInfoMap.put(key, accessInfo);
      } else {
        //超出访问次数,判断时间是否超出设定时间
        if ((System.currentTimeMillis() - accessInfo.getFirstVisitTimestamp()) <= seconds * 1000) {
          //如果还在设定时间内,则为不合法请求,返回错误信息
          render(response, "达到访问限制次数,请稍后重试!");
          return false;
        } else {
          //如果超出设定时间,则为合理的请求,将之前的请求清空,重新计数
          accessInfo.setFirstVisitTimestamp(System.currentTimeMillis());
          accessInfo.setAccessCount(1);
          accessInfoMap.put(key, accessInfo);
        }
      }
    }
    return true;
  }

  /**
   * 向页面发送消息
   *
   * @param response
   * @param msg
   * @throws Exception
   */
  private void render(HttpServletResponse response, String msg) throws Exception {
    response.setContentType("application/json;charset=UTF-8");
    OutputStream out = response.getOutputStream();
    String str = JSON.toJSONString(new Result(true, StatusCode.ACCESSERROR, msg));
    out.write(str.getBytes("UTF-8"));
    out.flush();
    out.close();
  }

  /**
   * 封装的访问信息对象
   */
  class AccessInfo {

    /**
     * 一个计数周期内第一次访问的时间戳
     */
    private long firstVisitTimestamp;
    /**
     * 访问次数统计
     */
    private int accessCount;

    public long getFirstVisitTimestamp() {
      return firstVisitTimestamp;
    }

    public void setFirstVisitTimestamp(long firstVisitTimestamp) {
      this.firstVisitTimestamp = firstVisitTimestamp;
    }

    public int getAccessCount() {
      return accessCount;
    }

    public void setAccessCount(int accessCount) {
      this.accessCount = accessCount;
    }

    @Override
    public String toString() {
      return "AccessInfo{" +
          "firstVisitTimestamp=" + firstVisitTimestamp +
          ", accessCount=" + accessCount +
          '}';
    }
  }
}

三、把Interceptor注册到springboot中

package cn.mygweb.config;

import cn.mygweb.interceptor.AccessLimitInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 拦截器注册配置
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    //注册拦截器
    registry.addInterceptor(new AccessLimitInterceptor());
  }
}

四、在Controller中加入注解实现接口防刷

package cn.mygweb.controller;

import cn.mygweb.annotation.AccessLimit;
import cn.mygweb.entity.Result;
import cn.mygweb.entity.StatusCode;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/access")
public class AccessController {

  @AccessLimit(seconds = 5, maxCount = 2)//访问控制,5秒内只能访问2次
  @GetMapping
  public Result access() {
    return new Result(true, StatusCode.OK, "访问成功!");
  }

}

五、测试访问

基于注解实现 SpringBoot 接口防刷的方法

附:StatusCode.java、Result.java、application.yml

StatusCode类

package cn.mygweb.entity;

/**
 * 返回状态码
 */
public class StatusCode {
  public static final int OK = 20000;//成功
  public static final int ERROR = 20001;//失败
  public static final int LOGINERROR = 20002;//用户名或密码错误
  public static final int ACCESSERROR = 20003;//权限不足
  public static final int REMOTEERROR = 20004;//远程调用失败
  public static final int REPERROR = 20005;//重复操作
  public static final int NOTFOUNDERROR = 20006;//没有对应的抢购数据
}

Result类:

package cn.mygweb.entity;

import java.io.Serializable;

/**
 * 响应结果
 */
public class Result<T> implements Serializable {
  private boolean flag;//是否成功
  private Integer code;//返回码
  private String message;//返回消息
  private T data;//返回数据

  public Result(boolean flag, Integer code, String message, Object data) {
    this.flag = flag;
    this.code = code;
    this.message = message;
    this.data = (T) data;
  }

  public Result(boolean flag, Integer code, String message) {
    this.flag = flag;
    this.code = code;
    this.message = message;
  }

  public Result() {
    this.flag = true;
    this.code = StatusCode.OK;
    this.message = "操作成功!";
  }

  public boolean isFlag() {
    return flag;
  }

  public void setFlag(boolean flag) {
    this.flag = flag;
  }

  public Integer getCode() {
    return code;
  }

  public void setCode(Integer code) {
    this.code = code;
  }

  public String getMessage() {
    return message;
  }

  public void setMessage(String message) {
    this.message = message;
  }

  public T getData() {
    return data;
  }

  public void setData(T data) {
    this.data = data;
  }
}

applications.yml:

server:
 port: 8080

到此这篇关于基于注解实现 SpringBoot 接口防刷的方法的文章就介绍到这了,更多相关SpringBoot 接口防刷内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
Python中使用PIL库实现图片高斯模糊实例
Feb 08 Python
在Python中进行自动化单元测试的教程
Apr 15 Python
Python UnicodeEncodeError: 'gbk' codec can't encode character 解决方法
Apr 24 Python
Python实现简易过滤删除数字的方法小结
Jan 09 Python
使用Python将Mysql的查询数据导出到文件的方法
Feb 25 Python
基于python的itchat库实现微信聊天机器人(推荐)
Oct 29 Python
python由已知数组快速生成新数组的方法
Apr 08 Python
Keras 在fit_generator训练方式中加入图像random_crop操作
Jul 03 Python
python用Tkinter做自己的中文代码编辑器
Sep 07 Python
python利用opencv保存、播放视频
Nov 02 Python
python3从网络摄像机解析mjpeg http流的示例
Nov 13 Python
Python 读写 Matlab Mat 格式数据的操作
May 19 Python
python Autopep8实现按PEP8风格自动排版Python代码
Mar 02 #Python
pycharm配置安装autopep8自动规范代码的实现
Mar 02 #Python
Python实现我的世界小游戏源代码
Mar 02 #Python
VSCode中autopep8无法运行问题解决方案(提示Error: Command failed,usage)
Mar 02 #Python
python 基于pygame实现俄罗斯方块
Mar 02 #Python
使用Python快速打开一个百万行级别的超大Excel文件的方法
Mar 02 #Python
Autopep8的使用(python自动编排工具)
Mar 02 #Python
You might like
ThinkPHP3.1.3版本新特性概述
2014/06/19 PHP
PHP使用mysql_fetch_object从查询结果中获取对象集的方法
2015/03/18 PHP
PHP面向对象程序设计OOP继承用法入门示例
2016/12/27 PHP
Laravel 微信小程序后端搭建步骤详解
2019/11/26 PHP
PHP实现常用排序算法的方法
2020/02/05 PHP
用javascript做拖动布局的思路
2008/05/31 Javascript
关于jquery动态增减控件的一些想法和小插件
2010/08/01 Javascript
页面只能打开一次Cooike如何实现
2012/12/04 Javascript
js实现页面跳转重定向的几种方式
2014/05/29 Javascript
使用JavaScript开发IE浏览器本地插件实例
2015/02/18 Javascript
轻松搞定jQuery.noConflict()
2016/02/15 Javascript
vue实现ajax滚动下拉加载,同时具有loading效果(推荐)
2017/01/11 Javascript
JS表单验证方法实例小结【电话、身份证号、Email、中文、特殊字符、身份证号等】
2017/02/14 Javascript
关于ES6的六个小特性(二)
2017/02/20 Javascript
AngularJS实现tab选项卡的方法详解
2017/07/05 Javascript
JavaScript 值类型和引用类型的初次研究(推荐)
2017/07/19 Javascript
Webpack性能优化 DLL 用法详解
2017/08/10 Javascript
详解用Node.js实现Restful风格webservice
2017/09/29 Javascript
vue-cli配置全局sass、less变量的方法
2019/06/06 Javascript
使用python检测主机存活端口及检查存活主机
2015/10/12 Python
举例讲解Linux系统下Python调用系统Shell的方法
2015/11/07 Python
python使用knn实现特征向量分类
2018/12/26 Python
python儿童学游戏编程知识点总结
2019/06/03 Python
python 使用matplotlib 实现从文件中读取x,y坐标的可视化方法
2019/07/04 Python
python 中关于pycharm选择运行环境的问题
2020/10/31 Python
Python实现淘宝秒杀功能的示例代码
2021/01/19 Python
python中spy++的使用超详细教程
2021/01/29 Python
阿姆斯特丹杜莎夫人蜡像馆官方网站:Madame Tussauds Amsterdam
2019/03/12 全球购物
SmartBuyGlasses比利时:购买品牌太阳镜和眼镜
2019/08/09 全球购物
C++:局部变量能否和全局变量重名
2014/03/03 面试题
武汉某公司的C#笔试题面试题
2015/12/25 面试题
总裁秘书岗位职责
2013/12/04 职场文书
简短大学毕业感言
2014/01/18 职场文书
公司门卫的岗位职责
2014/02/19 职场文书
cf收人广告词
2014/03/14 职场文书
学生乘坐校车安全责任书
2015/05/11 职场文书