springboot + aop + Lua分佈式限流的最佳實踐

一、什麼是限流？為什麼要限流？

不知道大家有沒有坐過帝都的地鐵，就是進地鐵站都要排隊的那種，為什麼要這樣擺長龍轉圈圈？答案就是為了限流！因為一趟地鐵的運力是有限的，一下擠進去太多人會造成站臺的擁擠、列車的超載，存在一定的安全隱患。同理，我們的程序也是一樣，它處理請求的能力也是有限的，一旦請求多到超出它的處理極限就會崩潰。為了不出現最壞的崩潰情況，只能耽誤一下大家進站的時間。

限流是保證系統高可用的重要手段！！！

由於互聯網公司的流量巨大，系統上線會做一個流量峰值的評估，尤其是像各種秒殺促銷活動，為了保證系統不被巨大的流量壓垮，會在系統流量到達一定閾值時，拒絕掉一部分流量。

限流會導致用戶在短時間內（這個時間段是毫秒級的）系統不可用，一般我們衡量系統處理能力的指標是每秒的QPS或者TPS，假設系統每秒的流量閾值是1000，理論上一秒內有第1001個請求進來時，那麼這個請求就會被限流。

二、限流方案

1、計數器

Java內部也可以通過原子類計數器AtomicInteger、Semaphore信號量來做簡單的限流。

<code> 1// 限流的個數
 2    private int maxCount = 10;
 3    // 指定的時間內
 4    private long interval = 60;
 5    // 原子類計數器
 6    private AtomicInteger atomicInteger = new AtomicInteger(0);
 7    // 起始時間
 8    private long startTime = System.currentTimeMillis(); 

 9
10    public boolean limit(int maxCount, int interval) {
11        atomicInteger.addAndGet(1);
12        if (atomicInteger.get() == 1) {
13            startTime = System.currentTimeMillis();
14            atomicInteger.addAndGet(1);
15            return true;
16        }
17        // 超過了間隔時間，直接重新開始計數
18        if (System.currentTimeMillis() - startTime > interval * 1000) {
19            startTime = System.currentTimeMillis();
20            atomicInteger.set(1);
21            return true;
22        }
23        // 還在間隔時間內,check有沒有超過限流的個數
24        if (atomicInteger.get() > maxCount) {
25            return false;
26        }
27        return true;
28    }/<code>

2、漏桶算法

漏桶算法思路很簡單，我們把水比作是請求，漏桶比作是系統處理能力極限，水先進入到漏桶裡，漏桶裡的水按一定速率流出，當流出的速率小於流入的速率時，由於漏桶容量有限，後續進入的水直接溢出（拒絕請求），以此實現限流。

3、令牌桶算法

令牌桶算法的原理也比較簡單，我們可以理解成醫院的掛號看病，只有拿到號以後才可以進行診病。

系統會維護一個令牌（token）桶，以一個恆定的速度往桶裡放入令牌（token），這時如果有請求進來想要被處理，則需要先從桶裡獲取一個令牌（token），當桶裡沒有令牌（token）可取時，則該請求將被拒絕服務。令牌桶算法通過控制桶的容量、發放令牌的速率，來達到對請求的限制。

4、Redis + Lua

很多同學不知道Lua是啥？個人理解，Lua腳本和 MySQL數據庫的存儲過程比較相似，他們執行一組命令，所有命令的執行要麼全部成功或者失敗，以此達到原子性。也可以把Lua腳本理解為，一段具有業務邏輯的代碼塊。

而Lua本身就是一種編程語言，雖然redis 官方沒有直接提供限流相應的API，但卻支持了 Lua 腳本的功能，可以使用它實現複雜的令牌桶或漏桶算法，也是分佈式系統中實現限流的主要方式之一。

相比Redis事務，Lua腳本的優點：

• 減少網絡開銷： 使用Lua腳本，無需向Redis 發送多次請求，執行一次即可，減少網絡傳輸
• 原子操作：Redis 將整個Lua腳本作為一個命令執行，原子，無需擔心併發
• 複用：Lua腳本一旦執行，會永久保存 Redis 中,，其他客戶端可複用

Lua腳本大致邏輯如下：

<code> 1-- 獲取調用腳本時傳入的第一個key值（用作限流的 key） 

 2local key = KEYS[1]
 3-- 獲取調用腳本時傳入的第一個參數值（限流大小）
 4local limit = tonumber(ARGV[1])
 5
 6-- 獲取當前流量大小
 7local curentLimit = tonumber(redis.call('get', key) or "0")
 8
 9-- 是否超出限流
10if curentLimit + 1 > limit then
11    -- 返回(拒絕)
12    return 0
13else
14    -- 沒有超出 value + 1
15    redis.call("INCRBY", key, 1)
16    -- 設置過期時間
17    redis.call("EXPIRE", key, 2)
18    -- 返回(放行)
19    return 1
20end/<code>

• 通過KEYS[1] 獲取傳入的key參數
• 通過ARGV[1]獲取傳入的limit參數
• redis.call方法，從緩存中get和key相關的值，如果為null那麼就返回0
• 接著判斷緩存中記錄的數值是否會大於限制大小，如果超出表示該被限流，返回0
• 如果未超過，那麼該key的緩存值+1，並設置過期時間為1秒鐘以後，並返回緩存值+1

這種方式是本文推薦的方案，具體實現會在後邊做細說。

5、網關層限流

限流常在網關這一層做，比如Nginx、Openresty、kong、zuul、Spring Cloud Gateway等，而像spring cloud - gateway網關限流底層實現原理，就是基於Redis + Lua，通過內置Lua限流腳本的方式。

在這裡插入圖片描述

三、Redis + Lua 限流實現

下面我們通過自定義註解、aop、Redis + Lua 實現限流，步驟會比較詳細，為了小白能讓快速上手這裡囉嗦一點，有經驗的老鳥們多擔待一下。

1、環境準備

springboot 項目創建地址：https://start.spring.io，很方便實用的一個工具。

2、引入依賴包

pom文件中添加如下依賴包，比較關鍵的就是 spring-boot-starter-data-redis 和 spring-boot-starter-aop。

<code> 1    <dependencies>
 2        <dependency>
 3            <groupid>org.springframework.boot/<groupid>
 4            <artifactid>spring-boot-starter-web/<artifactid>
 5        /<dependency>
 6        <dependency> 

 7            <groupid>org.springframework.boot/<groupid>
 8            <artifactid>spring-boot-starter-data-redis/<artifactid>
 9        /<dependency>
10        <dependency>
11            <groupid>org.springframework.boot/<groupid>
12            <artifactid>spring-boot-starter-aop/<artifactid>
13        /<dependency>
14        <dependency>
15            <groupid>com.google.guava/<groupid>
16            <artifactid>guava/<artifactid>
17            <version>21.0/<version>
18        /<dependency>
19        <dependency>
20            <groupid>org.springframework.boot/<groupid>
21            <artifactid>spring-boot-starter-test/<artifactid>
22        /<dependency>
23        <dependency>
24            <groupid>org.apache.commons/<groupid>
25            <artifactid>commons-lang3/<artifactid>
26        /<dependency>
27
28        <dependency>
29            <groupid>org.springframework.boot/<groupid>
30            <artifactid>spring-boot-starter-test/<artifactid>
31            <scope>test/<scope>
32            <exclusions>
33                <exclusion>
34                    <groupid>org.junit.vintage/<groupid>
35                    <artifactid>junit-vintage-engine/<artifactid>
36                /<exclusion>
37            /<exclusions>
38        /<dependency>
39    /<dependencies>/<code>

3、配置application.properties

在 application.properties 文件中配置提前搭建好的 redis 服務地址和端口。

<code>1spring.redis.host=127.0.0.1
2
3spring.redis.port=6379/<code>

4、配置RedisTemplate實例

<code> 1@Configuration
 2public class RedisLimiterHelper {
 3
 4    @Bean 

 5    public RedisTemplate<string> limitRedisTemplate(LettuceConnectionFactory redisConnectionFactory) {
 6        RedisTemplate<string> template = new RedisTemplate<>();
 7        template.setKeySerializer(new StringRedisSerializer());
 8        template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
 9        template.setConnectionFactory(redisConnectionFactory);
10        return template;
11    }
12}/<string>/<string>/<code>

限流類型枚舉類

<code> 1/**
 2 * @author fu
 3 * @description 限流類型
 4 * @date 2020/4/8 13:47
 5 */
 6public enum LimitType {
 7
 8    /**
 9     * 自定義key
10     */
11    CUSTOMER,
12
13    /**
14     * 請求者IP
15     */
16    IP;
17}/<code>

5、自定義註解

我們自定義個@Limit註解，註解類型為ElementType.METHOD即作用於方法上。

period表示請求限制時間段，count表示在period這個時間段內允許放行請求的次數。limitType代表限流的類型，可以根據請求的IP、自定義key，如果不傳limitType屬性則默認用方法名作為默認key。

<code> 1/**
 2 * @author fu
 3 * @description 自定義限流注解
 4 * @date 2020/4/8 13:15 

 5 */
 6@Target({ElementType.METHOD, ElementType.TYPE})
 7@Retention(RetentionPolicy.RUNTIME)
 8@Inherited
 9@Documented
10public @interface Limit {
11
12    /**
13     * 名字
14     */
15    String name() default "";
16
17    /**
18     * key
19     */
20    String key() default "";
21
22    /**
23     * Key的前綴
24     */
25    String prefix() default "";
26
27    /**
28     * 給定的時間範圍 單位(秒)
29     */
30    int period();
31
32    /**
33     * 一定時間內最多訪問次數
34     */
35    int count();
36
37    /**
38     * 限流的類型(用戶自定義key 或者 請求ip)
39     */
40    LimitType limitType() default LimitType.CUSTOMER;
41}/<code>

6、切面代碼實現

<code>  1/**
  2 * @author fu
  3 * @description 限流切面實現
  4 * @date 2020/4/8 13:04
  5 */ 

  6@Aspect
  7@Configuration
  8public class LimitInterceptor {
  9
 10    private static final Logger logger = LoggerFactory.getLogger(LimitInterceptor.class);
 11
 12    private static final String UNKNOWN = "unknown";
 13
 14    private final RedisTemplate<string> limitRedisTemplate;
 15
 16    @Autowired
 17    public LimitInterceptor(RedisTemplate<string> limitRedisTemplate) {
 18        this.limitRedisTemplate = limitRedisTemplate;
 19    }
 20
 21    /**
 22     * @param pjp
 23     * @author fu
 24     * @description 切面
 25     * @date 2020/4/8 13:04
 26     */
 27    @Around("execution(public * *(..)) && @annotation(com.xiaofu.limit.api.Limit)")
 28    public Object interceptor(ProceedingJoinPoint pjp) {
 29        MethodSignature signature = (MethodSignature) pjp.getSignature();
 30        Method method = signature.getMethod();
 31        Limit limitAnnotation = method.getAnnotation(Limit.class);
 32        LimitType limitType = limitAnnotation.limitType();
 33        String name = limitAnnotation.name();
 34        String key;
 35        int limitPeriod = limitAnnotation.period();
 36        int limitCount = limitAnnotation.count();
 37
 38        /**
 39         * 根據限流類型獲取不同的key ,如果不傳我們會以方法名作為key
 40         */
 41        switch (limitType) {
 42            case IP:
 43                key = getIpAddress();
 44                break;
 45            case CUSTOMER:
 46                key = limitAnnotation.key();
 47                break;
 48            default:
 49                key = StringUtils.upperCase(method.getName());
 50        }
 51
 52        ImmutableList<string> keys = ImmutableList.of(StringUtils.join(limitAnnotation.prefix(), key));
 53        try { 

 54            String luaScript = buildLuaScript();
 55            RedisScript<number> redisScript = new DefaultRedisScript<>(luaScript, Number.class);
 56            Number count = limitRedisTemplate.execute(redisScript, keys, limitCount, limitPeriod);
 57            logger.info("Access try count is {} for name={} and key = {}", count, name, key);
 58            if (count != null && count.intValue() <= limitCount) {
 59                return pjp.proceed();
 60            } else {
 61                throw new RuntimeException("You have been dragged into the blacklist");
 62            }
 63        } catch (Throwable e) {
 64            if (e instanceof RuntimeException) {
 65                throw new RuntimeException(e.getLocalizedMessage());
 66            }
 67            throw new RuntimeException("server exception");
 68        }
 69    }
 70
 71    /**
 72     * @author fu
 73     * @description 編寫 redis Lua 限流腳本
 74     * @date 2020/4/8 13:24
 75     */
 76    public String buildLuaScript() {
 77        StringBuilder lua = new StringBuilder();
 78        lua.append("local c");
 79        lua.append("\\nc = redis.call('get',KEYS[1])");
 80        // 調用不超過最大值，則直接返回
 81        lua.append("\\nif c and tonumber(c) > tonumber(ARGV[1]) then");
 82        lua.append("\\nreturn c;");
 83        lua.append("\\nend");
 84        // 執行計算器自加
 85        lua.append("\\nc = redis.call('incr',KEYS[1])");
 86        lua.append("\\nif tonumber(c) == 1 then");
 87        // 從第一次調用開始限流，設置對應鍵值的過期
 88        lua.append("\\nredis.call('expire',KEYS[1],ARGV[2])");
 89        lua.append("\\nend");
 90        lua.append("\\nreturn c;");
 91        return lua.toString();
 92    }
 93
 94
 95    /**
 96     * @author fu
 97     * @description 獲取id地址
 98     * @date 2020/4/8 13:24 

 99     */
100    public String getIpAddress() {
101        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
102        String ip = request.getHeader("x-forwarded-for");
103        if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
104            ip = request.getHeader("Proxy-Client-IP");
105        }
106        if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
107            ip = request.getHeader("WL-Proxy-Client-IP");
108        }
109        if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
110            ip = request.getRemoteAddr();
111        }
112        return ip;
113    }
114}/<number>/<string>/<string>/<string>/<code>

7、控制層實現

我們將@Limit註解作用在需要進行限流的接口方法上，下邊我們給方法設置@Limit註解，在10秒內只允許放行3個請求，這裡為直觀一點用AtomicInteger計數。

<code> 1/**
 2 * @Author: fu
 3 * @Description:
 4 */
 5@RestController
 6public class LimiterController {
 7
 8    private static final AtomicInteger ATOMIC_INTEGER_1 = new AtomicInteger();
 9    private static final AtomicInteger ATOMIC_INTEGER_2 = new AtomicInteger();
10    private static final AtomicInteger ATOMIC_INTEGER_3 = new AtomicInteger();
11
12    /**
13     * @author fu
14     * @description
15     * @date 2020/4/8 13:42
16     */
17    @Limit(key = "limitTest", period = 10, count = 3)
18    @GetMapping("/limitTest1")
19    public int testLimiter1() {
20
21        return ATOMIC_INTEGER_1.incrementAndGet();
22    }
23 

24    /**
25     * @author fu
26     * @description
27     * @date 2020/4/8 13:42
28     */
29    @Limit(key = "customer_limit_test", period = 10, count = 3, limitType = LimitType.CUSTOMER)
30    @GetMapping("/limitTest2")
31    public int testLimiter2() {
32
33        return ATOMIC_INTEGER_2.incrementAndGet();
34    }
35
36    /**
37     * @author fu
38     * @description 
39     * @date 2020/4/8 13:42
40     */
41    @Limit(key = "ip_limit_test", period = 10, count = 3, limitType = LimitType.IP)
42    @GetMapping("/limitTest3")
43    public int testLimiter3() {
44
45        return ATOMIC_INTEGER_3.incrementAndGet();
46    }
47
48}/<code>

8、測試

測試預期：連續請求3次均可以成功，第4次請求被拒絕。接下來看一下是不是我們預期的效果，請求地址：http://127.0.0.1:8080/limitTest1，用postman進行測試，有沒有postman url直接貼瀏覽器也是一樣。

可以看到第四次請求時，應用直接拒絕了請求，說明我們的 Springboot + aop + lua 限流方案搭建成功。

總結

以上 springboot + aop + Lua 限流實現是比較簡單的，旨在讓大家認識下什麼是限流？如何做一個簡單的限流功能，面試要知道這是個什麼東西。上面雖然說了幾種實現限流的方案，但選哪種還要結合具體的業務場景，不能為了用而用。

感悟

從正式成為一名程序員的那天起，註定要進行沒有止境的學習，想要進階高級或者專家，就要堅持每天都高效的學習，不要給自己的懶惰找藉口，“什麼我也想學習可是又沒有資源”，這次我給你整理好了，我看你還有啥理由！私信回覆【666】送你

閱讀更多 程序員內點事 的文章

關鍵字: 第三人稱射擊遊戲 數據庫 Redis