詳解Redis如何優(yōu)雅地實現(xiàn)接口防刷

更新時間：2024年03月12日 10:13:36 作者：shigen01

這篇文章主要為大家詳細介紹了Redis優(yōu)雅地實現(xiàn)接口防刷的相關(guān)知識,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學習一下

背景

最近在學習redis，想到了之前的寫的一個案例demo，實現(xiàn)了接口的流量防刷。主要是為了防止爬蟲爬取接口，當然可以適用于那些需要進行流控的系統(tǒng)，shigen畫了一張草圖展示主要的原理和過程：

首先用戶請求系統(tǒng)的接口，后端會有一個流控的攔截器，這里邊主要是去獲得請求的信息，用ip+URI作為redis的key，查詢在redis中記錄的次數(shù)，如果次數(shù)大于規(guī)定的單位時間的訪問次數(shù)，就認為這是非法的請求了，就需要攔截了。那具體的代碼該怎么設計呢》？下邊是一份詳細的代碼案例。亮點在于：shigen使用了一個注解，支持接口的個性化設置。

代碼實現(xiàn)

自定義ReteLimit注解

package main.java.com.shigen.redis.annotation;

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

/**
 * @author shigenfu
 * @date 2023/9/6 10:05 上午
 */
 
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface RateLimit {
    
    /**
     * 限定時間
     * 
     * @return 限定時間
     */
     int seconds() default 1;
     /**
     * 最大請求數(shù)
     * 
     * @return 最大請求數(shù)!
     */
     int max() default 1;
}

其實就是兩個核心參數(shù)seconds max 規(guī)定了單位時間內(nèi)的最大訪問次數(shù)。

攔截器rateLimitIntercept

/**
* @author shigenfu
* @date 2023/9/6  10:09  上午
*/

@Component
public class RateLimitIntercept extends HandlerInterceptorAdapter {
    
    @Resource
    private RedisTemplate<String, String> redisTemplate;
    public static final String RATE_LIMIT_KEY = "rl:",
    
    @Override
    public boolean preHandle(HttpServletRequest request,HttpServletResponse response,Object handler) throws IOException{
        // 請求是否是方法的請求
        if (handler instanceof HandlerMethod){
            HandlerMethod handlerMethod =(HandlerMethod) handler:
            // 獲得注解
            RateLimit methodAnnotation = handlerMethod.getMethodAnnotation(RateLimit.class);
            if (methodAnnotation == null) {
                return true;
            }
            int seconds = methodAnnotation.seconds();
            int max = methodAnnotation.max();
            
            String key = RATE_LIMIT_KEY + request.getRemoteAddr()+ ":"+ request.getRequestURI();
            String times = redisTemplate.opsForValue().get(key);
            if (times = null) {
                redisTemplate.opsForValue().set(key, String.value0f(1), seconds, TimeUnit.SECONDS);
            }else{
                int timesInt = Integer.parseInt(times);
                if(timesInt < max){
                    redisTemplate.opsForValue().set(key, String.value0f(timesInt + 1), seconds, TimeUnit.SECONDs);
                }else{
                    response.sendError(429,"to many requests");
                    return false;
                }
            }
        }
        return true,
    }
}

注冊到攔截器上

/**
* @author shigenfu
* @date 2023/9/6 11:30 上午
*/

@Configuration
public class WebConfig implements WebMvcConfigurer {
    
    @Resource
    private RateLimitIntercept rateLimitIntercept;
    
    @Override
    public void addInterceptors(InterceptorRegistry registry){
        registry.addInterceptor(rateLimitIntercept),
    }
}

這一步很重要，不然我們自定義的攔截器會不生效。

測試類測試

/**
 * @author shigenfu
 * @date 2023/9/6 11:25 上午
 */
 
@RestController
@RequestMapping(value ="rate")
public class RateLimitTestController {
    
    @GetMapping(value = "test")
    @RateLimit(seconds=10，max=2)
    public String test(){
        return UUID.randomUUID().toString();
    }
}

這里主要是寫了一個接口實現(xiàn)測試，訪問的時候返回隨機生成的UUID字符串。為了測試的效果明顯，我在@RateLimit上配置的是10s之內(nèi)只能允許2次請求。那現(xiàn)在開始測試吧！