SpringBoot在一定時間內限制介面請求次數的實現範例

2022-03-16 13:00:28

需要用到的知識：註解、AOP、ExpiringMap（帶有有效期的對映）

我們可以自定義註解，把註解新增到我們的介面上。定義一個切面，執行方法前去ExpiringMap查詢該IP在規定時間內請求了多少次，如超過次數則直接返回請求失敗。

需要用到的依賴

<!-- AOP依賴 -->
<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
            <version>2.1.5.RELEASE</version>
</dependency>
<!-- Map依賴 -->
<dependency>
            <groupId>net.jodah</groupId>
            <artifactId>expiringmap</artifactId>
            <version>0.5.8</version>
</dependency>

自定義註解@LimitRequest

@Documented
@Target(ElementType.METHOD) // 說明該註解只能放在方法上面
@Retention(RetentionPolicy.RUNTIME)
public @interface LimitRequest {
    long time() default 6000; // 限制時間 單位：毫秒
    int count() default 1; // 允許請求的次數
}

自定義AOP

@Aspect
@Component
public class LimitRequestAspect {
 
    private static ConcurrentHashMap<String, ExpiringMap<String, Integer>> book = new ConcurrentHashMap<>();
 
    // 定義切點
    // 讓所有有@LimitRequest註解的方法都執行切面方法
    @Pointcut("@annotation(limitRequest)")
    public void excudeService(LimitRequest limitRequest) {
    }
 
    @Around("excudeService(limitRequest)")
    public Object doAround(ProceedingJoinPoint pjp, LimitRequest limitRequest) throws Throwable {
 
        // 獲得request物件
        RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes sra = (ServletRequestAttributes) ra;
        HttpServletRequest request = sra.getRequest();
        
        // 獲取Map物件， 如果沒有則返回預設值
        // 第一個引數是key， 第二個引數是預設值
        ExpiringMap<String, Integer> uc = book.getOrDefault(request.getRequestURI(), ExpiringMap.builder().variableExpiration().build());
        Integer uCount = uc.getOrDefault(request.getRemoteAddr(), 0);
 
 
 
        if (uCount >= limitRequest.count()) { // 超過次數，不執行目標方法
            return "介面請求超過次數";
        } else if (uCount == 0){ // 第一次請求時，設定有效時間
//            /** Expires entries based on when they were last accessed */
//            ACCESSED,
//            /** Expires entries based on when they were created */
//            CREATED;
            uc.put(request.getRemoteAddr(), uCount + 1, ExpirationPolicy.CREATED, limitRequest.time(), TimeUnit.MILLISECONDS);
        } else { // 未超過次數， 記錄加一
            uc.put(request.getRemoteAddr(), uCount + 1);
        }
        book.put(request.getRequestURI(), uc);
 
        // result的值就是被攔截方法的返回值
        Object result = pjp.proceed();
 
        return result;
    }
 
 
}

第一個靜態Map是多執行緒安全的Map（ConcurrentHashMap），它的key是介面對於的url，它的value是一個多執行緒安全且鍵值對是有有效期的Map（ExpiringMap）。

ExpiringMap的key是請求的ip地址，value是已經請求的次數。

ExpiringMap更多的使用方法可以參考：https://github.com/jhalterman/expiringmap

最後在方法上面加上@LimitRequest就行了

到此這篇關於SpringBoot在一定時間內限制介面請求次數的實現範例的文章就介紹到這了,更多相關SpringBoot 限制介面請求次數內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

SpringBoot在一定時間內限制介面請求次數的實現範例

熱門文章