使用springboot整合RateLimiter限流過程

Posted on by

RateLimiter官方文檔

RateLimiter令牌桶原理圖

  • 隨著時間流逝,系統會按恒定1/QPS時間間隔(如果QPS=100,則間隔是10ms)往桶裡加入Token(想象和漏洞漏水相反,有個水龍頭在不斷的加水),如果桶已經滿瞭就不再加瞭.新請求來臨時,會各自拿走一個Token,如果沒有Token可拿瞭就阻塞或者拒絕服務.
  • 令牌桶的另外一個好處是可以方便的改變速度. 一旦需要提高速率,則按需提高放入桶中的令牌的速率. 一般會定時(比如100毫秒)往桶中增加一定數量的令牌, 有些變種算法則實時的計算應該增加的令牌的數量.

令牌桶是一種常用的流量控制技術。令牌桶本身沒有丟棄和優先級策略。

原理

1．令牌以一定的速率放入桶中。

2．每個令牌允許源發送一定數量的比特。

3．發送一個包，流量調節器就要從桶中刪除與包大小相等的令牌數。

4．如果沒有足夠的令牌發送包，這個包就會等待直到有足夠的令牌（在整形器的情況下）或者包被丟棄，也有可能被標記更低的DSCP（在策略者的情況下）。

5．桶有特定的容量，如果桶已經滿瞭，新加入的令牌就會被丟棄。因此，在任何時候，源發送到網絡上的最大突發數據量與桶的大小成比例。令牌桶允許突發，但是不能超過限制。

方法摘要

修飾符和類型 方法和描述
   
double acquire() 從RateLimiter獲取一個許可，該方法會被阻塞直到獲取到請求
double acquire(int permits) 從RateLimiter獲取指定許可數，該方法會被阻塞直到獲取到請求
static RateLimiter create(double permitsPerSecond) 根據指定的穩定吞吐率創建RateLimiter，這裡的吞吐率是指每秒多少許可數（通常是指QPS，每秒多少查詢）
static RateLimiter create(double permitsPerSecond, long warmupPeriod, TimeUnit unit) 根據指定的穩定吞吐率和預熱期來創建RateLimiter，這裡的吞吐率是指每秒多少許可數（通常是指QPS，每秒多少個請求量），在這段預熱時間內，RateLimiter每秒分配的許可數會平穩地增長直到預熱期結束時達到其最大速率。（隻要存在足夠請求數來使其飽和）
double getRate() 返回RateLimiter 配置中的穩定速率，該速率單位是每秒多少許可數
void setRate(double permitsPerSecond) 更新RateLimite的穩定速率，參數permitsPerSecond 由構造RateLimiter的工廠方法提供。
String toString() 返回對象的字符表現形式
boolean tryAcquire() 從RateLimiter 獲取許可，如果該許可可以在無延遲下的情況下立即獲取得到的話
boolean tryAcquire(int permits) 從RateLimiter 獲取許可數，如果該許可數可以在無延遲下的情況下立即獲取得到的話
boolean tryAcquire(int permits, long timeout, TimeUnit unit) 從RateLimiter 獲取指定許可數如果該許可數可以在不超過timeout的時間內獲取得到的話，或者如果無法在timeout 過期之前獲取得到許可數的話，那麼立即返回false （無需等待）
boolean tryAcquire(long timeout, TimeUnit unit) 從RateLimiter 獲取許可如果該許可可以在不超過timeout的時間內獲取得到的話，或者如果無法在timeout 過期之前獲取得到許可的話，那麼立即返回false（無需等待）

開始貼代碼

pom.xml

<!--guava RateLimiter限流-->
<!-- https://mvnrepository.com/artifact/com.google.guava/guava -->
<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>28.2-jre</version>
</dependency>

自定義接口Limit

package com.zjy.knife4j.inte;
import java.lang.annotation.*;
/**
 * 限流註解
 */
@Inherited
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Limit {
    // 默認每秒放入桶中的token
    double limitNum() default 20;
    String name() default "";
}

aop切面

package com.zjy.knife4j.aspect;
import com.google.common.util.concurrent.RateLimiter;
import com.zjy.knife4j.inte.Limit;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
import java.util.concurrent.ConcurrentHashMap;
@Aspect
@Component
public class RateLimitAspect {
    /**日志對象*/
    private static final Logger logger = LoggerFactory.getLogger(RateLimitAspect.class);
    private ConcurrentHashMap<String, RateLimiter> RATE_LIMITER  = new ConcurrentHashMap<>();
    private RateLimiter rateLimiter;
    @Pointcut("@annotation(com.zjy.knife4j.inte.Limit)")
    public void serviceLimit() {
    }
    @Around("serviceLimit()")
    public Object around(ProceedingJoinPoint point) throws Throwable {
        Object obj = null;
        //獲取攔截的方法名
        Signature sig = point.getSignature();
        //獲取攔截的方法名
        MethodSignature msig = (MethodSignature) sig;
        //返回被織入增加處理目標對象
        Object target = point.getTarget();
        //為瞭獲取註解信息
        Method currentMethod = target.getClass().getMethod(msig.getName(), msig.getParameterTypes());
        //獲取註解信息
        Limit annotation = currentMethod.getAnnotation(Limit.class);
        double limitNum = annotation.limitNum(); //獲取註解每秒加入桶中的token
        String functionName = msig.getName(); // 註解所在方法名區分不同的限流策略
        if(RATE_LIMITER.containsKey(functionName)){
            rateLimiter=RATE_LIMITER.get(functionName);
        }else {
            RATE_LIMITER.put(functionName, RateLimiter.create(limitNum));
            rateLimiter=RATE_LIMITER.get(functionName);
        }
        if(rateLimiter.tryAcquire()) {
            logger.info("執行成功！！！...做一些業務處理");
            return point.proceed();
        } else {
            logger.info("請求繁忙...做一些業務處理");
            return null;
        }
    }
}

RateLimiterController

package com.zjy.knife4j.controller;
import com.zjy.knife4j.inte.Limit;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RequestMapping("/ratelimiter")
@RestController
public class RateLimiterController {
    /**
     * 開啟限流
     * @return
     */
    @GetMapping("/open")
    @Limit(limitNum = 1, name = "test1")
    public String openRateLimiter1() {
        System.out.println("【限流執行瞭....編寫業務....】");
        return "限流執行瞭";
    }
    /**
     * 開啟限流
     * @return
     */
    @GetMapping("/open2")
    @Limit(limitNum = 1, name = "test2")
    public String openRateLimiter2() {
        System.out.println("【限流執行瞭222】");
        return "限流執行瞭222";
    }
    /**
     * 未開啟限流
     * @return
     */
    @GetMapping("/close")
    public String closeRateLimiter() {
        System.out.println("【不限流執行瞭】");
        return "不限流執行瞭";
    }
}

代碼貼完瞭,開始測試

啟動服務，訪問添加限流註解的接口

再訪問沒加註解的接口

控制臺打印結果：

測試OK！

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：