Spring Boot如何利用攔截器加快取完成介面防刷操作

2022-02-16 19:00:27

為什麼需要介面防刷

為了減緩伺服器壓力，將伺服器資源留待給有價值的請求，防止惡意存取，一般的程式都會有介面防刷設定，接下來介紹一種簡單靈活的介面防刷操作

技術解析

主要採用的技術還是攔截+快取，我們可以通過自定義註解，將需要防刷的介面給標記出來管理，利用快取統計指定時間區間裡，具體的某個ip存取某個介面的頻率，如果超過某個閾值，就讓他進一會兒小黑屋，到期自動解放

主要程式碼

前置環境搭建，Spring Boot專案，引入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);
            // 如果沒有該註解，則不在防刷目標裡，直接返回
            if (accessLimit == null) {
                return true;
            }
            // 獲取最大存取次數
            int maxAccessCnt = accessLimit.maxAccessCnt();
            // 獲取ip
            String key = getRealIp(request);
            // ip+請求的介面路徑 => 唯一標識key
            key += request.getRequestURI();

            //當前存取次數
            Object value = redisTemplate.opsForValue().get(key);

            if (value == null) {
                //第一次存取 設定key保留時長為1s
                redisTemplate.opsForValue().set(key, 1, 1L, TimeUnit.SECONDS);
            } else {

                Integer currentCnt = (Integer) value;

                if (currentCnt < maxAccessCnt) {
                    //對應key值自增
                    redisTemplate.opsForValue().increment(key);
                } else {
                    //超出介面時間段內允許存取的次數，直接返回錯誤資訊,同時設定過期時間 20s自動剔除
                    redisTemplate.expire(key, 20L,TimeUnit.SECONDS);
                    response.setContentType("application/json;charset=utf-8");
                    try {
                        OutputStream out = response.getOutputStream();
                        out.write("存取次數已達上線！請稍後再存取".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資訊請求...");
   }
   //...業務邏輯
   if (log.isInfoEnabled()) {
      log.info("完成獲取paper資訊請求，準備返回物件資訊");
   }
   return ApiResultGenerator.success();
}