Spring?Boot如何利用攔截器加緩存完成接口防刷操作

更新時(shí)間：2022年02月16日 16:35:59 作者：碼農(nóng)Amg

流的需求出現(xiàn)在許多常見的場景中,下面這篇文章主要給大家介紹了關(guān)于Spring?Boot如何利用攔截器加緩存完成接口防刷操作的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下

為什么需要接口防刷

為了減緩服務(wù)器壓力，將服務(wù)器資源留待給有價(jià)值的請求，防止惡意訪問，一般的程序都會(huì)有接口防刷設(shè)置，接下來介紹一種簡單靈活的接口防刷操作

技術(shù)解析

主要采用的技術(shù)還是攔截+緩存，我們可以通過自定義注解，將需要防刷的接口給標(biāo)記出來管理，利用緩存統(tǒng)計(jì)指定時(shí)間區(qū)間里，具體的某個(gè)ip訪問某個(gè)接口的頻率，如果超過某個(gè)閾值，就讓他進(jìn)一會(huì)兒小黑屋，到期自動(dòng)解放

主要代碼

前置環(huán)境搭建，Spring Boot項(xiàng)目，引入Web和Redis依賴

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.3.3.RELEASE</version>
</parent>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
	</dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
</dependencies>

自定義注解

定義攔截器，重寫preHandler方法

@Override
	public boolean preHandle(HttpServletRequest request ,HttpServletResponse response ,Object handler) throws Exception {
		
        log.info("------------接口防刷攔截器---------------");

        if (handler instanceof HandlerMethod) {

            HandlerMethod handlerMethod = (HandlerMethod) handler;

            AccessLimit accessLimit = handlerMethod.getMethodAnnotation(AccessLimit.class);
            // 如果沒有該注解，則不在防刷目標(biāo)里，直接返回
            if (accessLimit == null) {
                return true;
            }
            // 獲取最大訪問次數(shù)
            int maxAccessCnt = accessLimit.maxAccessCnt();
            // 獲取ip
            String key = getRealIp(request);
            // ip+請求的接口路徑 => 唯一標(biāo)識(shí)key
            key += request.getRequestURI();

            //當(dāng)前訪問次數(shù)
            Object value = redisTemplate.opsForValue().get(key);

            if (value == null) {
                //第一次訪問 設(shè)置key保留時(shí)長為1s
                redisTemplate.opsForValue().set(key, 1, 1L, TimeUnit.SECONDS);
            } else {

                Integer currentCnt = (Integer) value;

                if (currentCnt < maxAccessCnt) {
                    //對(duì)應(yīng)key值自增
                    redisTemplate.opsForValue().increment(key);
                } else {
                    //超出接口時(shí)間段內(nèi)允許訪問的次數(shù)，直接返回錯(cuò)誤信息,同時(shí)設(shè)置過期時(shí)間 20s自動(dòng)剔除
                    redisTemplate.expire(key, 20L,TimeUnit.SECONDS);
                    response.setContentType("application/json;charset=utf-8");
                    try {
                        OutputStream out = response.getOutputStream();
                        out.write("訪問次數(shù)已達(dá)上線！請稍后再訪問".getBytes(StandardCharsets.UTF_8));
                        out.flush();
                        out.close();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                    return false;
                }
            }


        }
        return true;
    }

添加到需要防刷的接口上

/**
 * 返回不攜帶data的（成功例子）
 * @return
 */
@AccessLimit
@GetMapping("/getPaperS")
public ApiResult getPaperInfoSuccess() {
   if (log.isInfoEnabled()) {
      log.info("收到獲取paper信息請求...");
   }
   //...業(yè)務(wù)邏輯
   if (log.isInfoEnabled()) {
      log.info("完成獲取paper信息請求，準(zhǔn)備返回對(duì)象信息");
   }
   return ApiResultGenerator.success();
}