使用注解怎么實現(xiàn)一個SpringBoot 接口防刷功能

這篇文章將為大家詳細講解有關(guān)使用注解怎么實現(xiàn)一個SpringBoot 接口防刷功能，文章內(nèi)容質(zhì)量較高，因此小編分享給大家做個參考，希望大家閱讀完這篇文章后對相關(guān)知識有一定的了解。

項目結(jié)構(gòu)如下：

一、編寫注解類 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;

/**
 * 訪問控制注解（實現(xiàn)接口防刷功能）
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AccessLimit {
  /**
   * 限制周期（單位為秒）
   *
   * @return
   */
  int seconds();

  /**
   * 規(guī)定周期內(nèi)限制次數(shù)
   *
   * @return
   */
  int maxCount();

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

二、在Interceptor攔截器中實現(xiàn)攔截邏輯

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 {

  //模擬數(shù)據(jù)存儲，實際業(yè)務(wù)中可以自定義實現(xiàn)方式
  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";//這里假設(shè)用戶是userA，實際項目中可以改為userId
      }

      //模擬從redis中獲取數(shù)據(jù)
      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) {
        //訪問次數(shù)加1
        accessInfo.setAccessCount(accessInfo.getAccessCount() + 1);
        accessInfoMap.put(key, accessInfo);
      } else {
        //超出訪問次數(shù)，判斷時間是否超出設(shè)定時間
        if ((System.currentTimeMillis() - accessInfo.getFirstVisitTimestamp()) <= seconds * 1000) {
          //如果還在設(shè)定時間內(nèi)，則為不合法請求，返回錯誤信息
          render(response, "達到訪問限制次數(shù)，請稍后重試！");
          return false;
        } else {
          //如果超出設(shè)定時間，則為合理的請求，將之前的請求清空，重新計數(shù)
          accessInfo.setFirstVisitTimestamp(System.currentTimeMillis());
          accessInfo.setAccessCount(1);
          accessInfoMap.put(key, accessInfo);
        }
      }
    }
    return true;
  }

  /**
   * 向頁面發(fā)送消息
   *
   * @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 {

    /**
     * 一個計數(shù)周期內(nèi)第一次訪問的時間戳
     */
    private long firstVisitTimestamp;
    /**
     * 訪問次數(shù)統(tǒng)計
     */
    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中加入注解實現(xiàn)接口防刷

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秒內(nèi)只能訪問2次
  @GetMapping
  public Result access() {
    return new Result(true, StatusCode.OK, "訪問成功！");
  }

}

五、測試訪問

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

StatusCode類

package cn.mygweb.entity;

/**
 * 返回狀態(tài)碼
 */
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;//權(quán)限不足
  public static final int REMOTEERROR = 20004;//遠程調(diào)用失敗
  public static final int REPERROR = 20005;//重復(fù)操作
  public static final int NOTFOUNDERROR = 20006;//沒有對應(yīng)的搶購數(shù)據(jù)
}

Result類：

package cn.mygweb.entity;

import java.io.Serializable;

/**
 * 響應(yīng)結(jié)果
 */
public class Result<T> implements Serializable {
  private boolean flag;//是否成功
  private Integer code;//返回碼
  private String message;//返回消息
  private T data;//返回數(shù)據(jù)

  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

關(guān)于使用注解怎么實現(xiàn)一個SpringBoot 接口防刷功能就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，可以學(xué)到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。